get list of comments on a video
set showAll
param to true
to include un-redacted values of comments (admin only)
get list of comments on a video
set showAll
param to true
to include un-redacted values of comments (admin only)
Download a video. does not parse the output body. Note that content is sent as transfer-encoding: chunked;
download specified chapter. The chapter object has an imageUrl, this just wraps the functionality and adds the authorization header
chapter object returned from the video.chapters(videoId) API call
Download the thumbnail sheet image for a video
the thumbnailSheetUri or Thumbnail Configuration (get from video.thumbnailConfiguration)
Optional
options: RequestOptionsDownload the thumbnail sheet image for a video
the thumbnailSheetUri or Thumbnail Configuration (get from video.thumbnailConfiguration)
Optional
options: RequestOptionsDownload the thumbnail sheet image for a video
the thumbnailSheetUri or Thumbnail Configuration (get from video.thumbnailConfiguration)
Optional
options: RequestOptionsReplace an existing video with an uploaded file
Upload a video, and returns the resulting video ID
A File/Blob. if using nodejs you can also pass in the path to a file
metadata to add to video (title, etc.) - see API docs
Additional RequestInit
options, as well as customizing the contentType/contentLength/filename of the file
in the POST upload form (only needed if they can't be inferred from input)
the resulting video id
const rev = new RevClient(...config...);
await rev.connect();
// if browser - pass in File
const file = fileInputElement.files[0];
// if nodejs - can pass in path to file instead
// const file = "/path/to/local/video.mp4";
// upload returns resulting ID when complete
const videoId = await rev.upload.video(file, {
uploader: 'username.of.uploader',
title: 'video uploaded via the API',
//categories: [EXISTING_REV_CATEGORY_NAME],
unlisted: true,
isActive: true
/// ...any additional metadata
});
Optional
options: RequestOptionsOptional
options: RequestOptionsOptional
language: SupportedLanguage | SupportedLanguage[]Optional
options: RequestOptionsget details of a video
Optional
options: RequestOptionsOptional
options: RequestOptionsOptional
options: RequestOptionsOptional
options: RequestOptionsOptional
options: RequestOptionsId of video to submit emails for external access
Optional
q: stringSearch string
Optional
options: Rev.SearchOptions<ExternalAccess>search options
Optional
requestOptions: RequestOptionsOptional
options: RequestOptionsOptional
options: RequestOptionssearch for videos, return as one big list. leave blank to get all videos in the account
Example of using the video search API to search for videos, then getting the details of each video
Helper - update the audio language for a video. If index isn't specified then update the default language
videoId or video details (from video.details api call)
language to use, for example 'en'
Optional
trackIndex: numberindex of audio track - if not supplied then update default or first index
Optional
options: RequestOptionsUse the Patch API to update a single Custom Field.
id of video to update
the custom field object (with id and value)
get processing status of a video
Optional
options: RequestOptionsOptional
options: RequestOptionsOptional
options: RequestOptionsOptional
options: RequestOptionsOptional
options: RequestOptionsOptional
options: RequestOptionsOptional
options: RequestOptionsOptional
options: RequestOptionsHelper - wait for video transcode to complete. This doesn't indicate that a video is playable, rather that all transcoding jobs are complete
Optional
requestOptions: RequestOptions
Video API methods
See
Video API Docs