Video API, gRPC: SubtitleService.List
Lists all subtitles associated with a specific video with pagination support.
Results can be filtered and sorted using the provided parameters.
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 subtitles to return per page. The maximum value is 100. |
|
page_token |
string Page token for retrieving the next page of results. The maximum string length in characters is 15000. |
|
video_id |
string ID of the video containing the subtitles to list. The maximum string length in characters is 50. Includes only one of the fields Specifies the parent resource to list subtitles from (exactly one must be chosen). |
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[] |
List of subtitles matching the request criteria. |
|
next_page_token |
string Token for retrieving the next page of results. |
Subtitle
Entity representing a subtitle track that can be associated with a video.
Subtitles provide text versions of the audio content, enabling accessibility
and multilingual support for video content.
|
Field |
Description |
|
id |
string Unique identifier of the subtitle track. |
|
language |
string Language of the subtitle content according to ISO 639-2/T. |
|
label |
string Display label for the subtitle track shown in the video player's subtitle selection menu. |
|
status |
enum SubtitleStatus Current processing status of the subtitle.
|
|
source_type |
enum SubtitleSourceType Indicates how the subtitle was created or obtained.
|
|
filename |
string Original filename of the subtitle file. |
|
created_at |
Timestamp when the subtitle was initially created in the system. |
|
updated_at |
Timestamp of the last modification to the subtitle or its metadata. |
|
video_id |
string Identifier of the video this subtitle belongs to. Includes only one of the fields Specifies the parent content this subtitle is associated with. |