Classes

PBVision

PBVision

Methods

async getVideoEditors(vid)

index.js, line 56

Gets the email addresses (if any) which have editor access to a video your partner account uploaded.

Parameters:

Name	Type	Description
vid	string	video id

async sendVideoUrlToDownload(videoUrl, metadataopt) → {VideoUrlToDownloadResponse}

index.js, line 89

Tells PB Vision to download the specified video and process it. When processing is complete, your webhook URL will receive a callback.

Parameters:

Name	Type	Attributes	Description
videoUrl	string		the publicly available URL of the video
metadata	VideoMetadata	<optional>

Returns:

VideoUrlToDownloadResponse

async setVideoEditors(vid, editorEmails, viewerEmails)

index.js, line 70

Sets the email addresses (if any) which have editor access to a video your partner account uploaded.

Parameters:

Name	Type	Description
vid	string	video id
editorEmails	Array.<string>	a list of 0 to 8 email addresses to allow edit access to the video (replaces any previous editors list).
viewerEmails	Array.<string>	a list of 0 to 8 email addresses to allow view access to the video (replaces any previous editors list).

async setWebhook(webhookUrl)

index.js, line 44

Tells PB Vision to make an HTTP POST request your URL after each of your videos is done processing.

Parameters:

Name	Type	Description
webhookUrl	string	must start with https://

async uploadVideo(mp4Filename, metadataopt) → {VideoUrlToDownloadResponse}

index.js, line 142

Upload a video for processing by the AI. For passthrough partners, the video is only uploaded if the paying user has credit(s) available with which the video can be analyzed.

Parameters:

Name	Type	Attributes	Description
mp4Filename	string
metadata	VideoMetadata	<optional>

Returns:

VideoUrlToDownloadResponse