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 |
|---|---|
| List of videos recorded from this video live. This connection joins an object of type video with a list of video objects. |
| List of videos related to this video. This connection joins an object of type video with a list of video objects. |
| List of subtitles available for this video. This connection joins an object of type video with a list of subtitle objects. |
recordings
recordingsList 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
relatedList 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
subtitlesList 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 |
|---|---|---|
| Data format SRT only is supported, if you have an other format please convert it to SRT. |
|
| Language of these subtitles. |
|
|
|
|
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>.
