Skip to content

Class: VideoResource ​

Video Core ​

.delete(videoId): Promise<response> Since1.0.0 ​

DELETE /video/{video_id} No API Docs
Deletes a video

Parameters ​

NameTypeDescription
videoIdnumberVideo identifier

Returns ​

Promise<response>

response Delete response

Throws ​

If video ID is invalid

Example ​

javascript
await rest.video.delete(28);

.get(videoId): Promise<Video> Since1.0.0 ​

GET /video/{video_id} No API Docs
Gets a video by identifier

Parameters ​

NameTypeDescription
videoIdnumberVideo identifier

Returns ​

Promise<Video>

Video object

Throws ​

If video ID is invalid

Example ​

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

.getAll(page?): Promise<Video[]> Since1.0.0 ​

GET /video No API Docs
Gets all videos

Parameters ​

NameTypeDescription
page?numberPage number (optional)

Returns ​

Promise<Video[]>

Array of Video objects

Throws ​

If page number is invalid

Example ​

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

.upload(input, filename?): Promise<Video> Since1.0.0 ​

POST /video No API Docs
Uploads a video

Parameters ​

NameTypeDescription
inputstring | Buffer<ArrayBufferLike>Path to video file or Buffer
filename?stringCustom filename (optional)

Returns ​

Promise<Video>

Video Uploaded video

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');