Video API, gRPC: SubtitleService.Create
Creates a new subtitle record for a specific video.
This method only creates the metadata record; the actual subtitle file must be uploaded
using the URL obtained from the GenerateUploadURL method.
gRPC request
rpc Create (CreateSubtitleRequest) returns (operation.Operation)
CreateSubtitleRequest
{
"language": "string",
"label": "string",
// Includes only one of the fields `video_id`
"video_id": "string",
// end of the list of possible fields
// Includes only one of the fields `upload`
"upload": {
"filename": "string"
}
// end of the list of possible fields
}
|
Field |
Description |
|
language |
string Subtitle language represented as a three-letter code according to ISO 639-2/T. |
|
label |
string Contains the subtitle label (or title) that will be displayed on screen during video playback. |
|
video_id |
string ID of the video. Includes only one of the fields |
|
upload |
Upload subtitle. Includes only one of the fields Source type. |
SubtitleUploadParams
|
Field |
Description |
|
filename |
string Required field. Original filename of the subtitle file being uploaded. |
operation.Operation
{
"id": "string",
"description": "string",
"created_at": "google.protobuf.Timestamp",
"created_by": "string",
"modified_at": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"subtitle_id": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"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
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
|
Field |
Description |
|
id |
string ID of the operation. |
|
description |
string Description of the operation. 0-256 characters long. |
|
created_at |
Creation timestamp. |
|
created_by |
string ID of the user or service account who initiated the operation. |
|
modified_at |
The time when the Operation resource was last modified. |
|
done |
bool If the value is |
|
metadata |
Service-specific metadata associated with the operation. |
|
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
|
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
CreateSubtitleMetadata
|
Field |
Description |
|
subtitle_id |
string ID of the subtitle being created. |
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. |