Yurba.js

Appearance

Yurba.js / @yurbajs/rest / VideoResource

Class: VideoResource ​

Video Core ​

delete() ​

delete(videoId): Promise<response>

Deletes a video

Parameters ​

videoId ​

number

Video identifier

Returns ​

Promise<response>

response Delete response

Since ​

1.0.0

Throws ​

If video ID is invalid

Example ​

javascript
await rest.video.delete(28);

get() ​

get(videoId): Promise<Video>

Gets a video by identifier

Parameters ​

videoId ​

number

Video identifier

Returns ​

Promise<Video>

Video object

Since ​

1.0.0

Throws ​

If video ID is invalid

Example ​

javascript
const video = await rest.video.get(28);

getAll() ​

getAll(page?): Promise<Video[]>

Gets all videos

Parameters ​

page? ​

number

Page number (optional)

Returns ​

Promise<Video[]>

Array of Video objects

Since ​

1.0.0

Throws ​

If page number is invalid

Example ​

javascript
const videos = await rest.video.getAll();
const nextPage = await rest.video.getAll(1);

upload() ​

upload(input, filename?): Promise<Video>

Uploads a video

Parameters ​

input ​

Path to video file or Buffer

string | Buffer<ArrayBufferLike>

filename? ​

string

Custom filename (optional)

Returns ​

Promise<Video>

Video Uploaded video

Since ​

1.0.0

Throws ​

If input is invalid

Example ​

javascript
const video = await rest.video.upload('/path/to/video.mp4');
// or with Buffer
const video = await rest.video.upload(buffer, 'video.mkv');