Video API, REST: Subtitle.List
List subtitles.
HTTP request
GET https://video.api.cloud.yandex.net/video/v1/subtitles
Query parameters
|
Field |
Description |
|
pageSize |
string (int64) The maximum number of the results per page to return. |
|
pageToken |
string Page token for getting the next page of the result. |
|
videoId |
string ID of the video. Includes only one of the fields |
Response
HTTP Code: 200 - OK
{
"subtitles": [
{
"id": "string",
"language": "string",
"label": "string",
"status": "string",
"filename": "string",
"createdAt": "string",
"updatedAt": "string",
// Includes only one of the fields `videoId`
"videoId": "string"
// end of the list of possible fields
}
],
"nextPageToken": "string"
}
|
Field |
Description |
|
subtitles[] |
|
|
nextPageToken |
string Token for getting the next page. |
Subtitle
|
Field |
Description |
|
id |
string ID of the subtitle. |
|
language |
string Subtitle language represented as a three-letter ISO 639-3 code. |
|
label |
string Subtitle caption to be displayed on screen during video playback. |
|
status |
enum (SubtitleStatus) Subtitle status.
|
|
filename |
string Subtitle filename. |
|
createdAt |
string (date-time) Time when subtitle was created. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
updatedAt |
string (date-time) Time of last subtitle update. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
videoId |
string ID of the video. Includes only one of the fields |