Video API, gRPC: SubtitleService.List
List subtitles.
gRPC request
rpc List (ListSubtitlesRequest) returns (ListSubtitlesResponse)
ListSubtitlesRequest
{
"page_size": "int64",
"page_token": "string",
// Includes only one of the fields `video_id`
"video_id": "string"
// end of the list of possible fields
}
|
Field |
Description |
|
page_size |
int64 The maximum number of the results per page to return. |
|
page_token |
string Page token for getting the next page of the result. |
|
video_id |
string ID of the video. Includes only one of the fields |
ListSubtitlesResponse
{
"subtitles": [
{
"id": "string",
"language": "string",
"label": "string",
"status": "SubtitleStatus",
"source_type": "SubtitleSourceType",
"filename": "string",
"created_at": "google.protobuf.Timestamp",
"updated_at": "google.protobuf.Timestamp",
// Includes only one of the fields `video_id`
"video_id": "string"
// end of the list of possible fields
}
],
"next_page_token": "string"
}
|
Field |
Description |
|
subtitles[] |
|
|
next_page_token |
string Token for getting the next page. |
Subtitle
|
Field |
Description |
|
id |
string ID of the subtitle. |
|
language |
string Subtitle language in any of the following formats:
|
|
label |
string Subtitle caption to be displayed on screen during video playback. |
|
status |
enum SubtitleStatus Subtitle status.
|
|
source_type |
enum SubtitleSourceType Source type.
|
|
filename |
string Subtitle filename. |
|
created_at |
Time when subtitle was created. |
|
updated_at |
Time of last subtitle update. |
|
video_id |
string ID of the video. Includes only one of the fields |