Video connections

Connections through the data API are used to link objects with each others

Some objects can only be accessed and/or created through connections since they have no point in existing on their own.

Here is the list of connections available through the video object.


Filters

Description

recordings

List of videos recorded from this video live. This connection joins an object of type video with a list of video objects.

related

List of videos related to this video. This connection joins an object of type video with a list of video objects.

subtitles

List of subtitles available for this video. This connection joins an object of type video with a list of subtitle objects.




recordings

List of videos recorded from this video live, this connection joins an object of type video with a list of video objects.

Read the video's recordings connection

You can retrieve the list of recordings connected to a video object by issuing a GET request to /video/<VIDEO_ID>/recordings.

You can specify the list of fields from the video objects to be returned using the fields parameter.


related

List of videos related to this video, this connection joins an object of type video with a list of video objects.

Read the video's related connection

You can retrieve the list of related connected to a video object by issuing a GET request to /video/<VIDEO_ID>/related.

You can specify the list of fields from the video objects to be returned using the fields parameter.


subtitles

List of subtitles available for this video, this connection joins an object of type video with a list of subtitle objects.

Read the video's subtitles connection

You can retrieve the list of subtitles connected to a video object by issuing a GET request to /video/<VIDEO_ID>/subtitles.

You can specify the list of fields from the subtitle objects to be returned using the fields parameter.


Create a video's subtitles connection

You can create a new subtitle object and automatically connect it to an existing video object by issuing a POST request to /video/<VIDEO_ID>/subtitles with the following parameters.


Parameter

Description

Type

format

Data format SRT only is supported, if you have an other format please convert it to SRT.

string

language

Language of these subtitles.

string

url

  • With GET, provides the URL pointing to the latest version of the subtitles.
  • With POST, URL pointing to the subtitle data in on of the valid formats.
  • You don’t need to host the file, you can use the GET /file/upload API ressource to create a temporary URL to a file of your own, just like when you upload a video source file.
  • If you host your own file, the file will be fetched and the subtitles URL will point to a local copy.

url


Delete a video's subtitles connection

You can delete a subtitle object connected to a video object the same way you would if it wasn't attached, that is by issuing a DELETE request to /subtitle/<SUBTITLE_ID>.