Get subtitles of VOD
GET/bv/cms/v1/vods/:id/subtitles
This API will return subtitles by vod id
Request
Path Parameters
Required. The unique id of the VOD resource.
Header Parameters
To invoke this API using api_token
, you need to set the x-bv-org-id
header to specify the organization for which you want to perform the action.
Responses
- 200
- 400
- 401
- 403
- 500
- default
A successful response.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
subtitles object[]
Required. The list of subtitles.
The unique id of subtitle.
The number of audio track.
The language code of the subtitle. The format is ISO639-1+ISO-3166-1 (e.g., en-US).
The display name of the subtitle.
Possible values: [SUBTITLE_STATUS_GENERATING
, SUBTITLE_STATUS_SUCCEED
, SUBTITLE_STATUS_FAILED
, SUBTITLE_STATUS_NOT_FOUND
]
The status of subtitle.
subtitle_file_info object
The information of subtitle.
file object
Output only. The unique id of the file.
Possible values: [FILE_TYPE_VIDEO
, FILE_TYPE_IMAGE
, FILE_TYPE_SUBTITLE
, FILE_TYPE_DOCUMENT
, FILE_TYPE_WEB_LINK
, FILE_TYPE_AUDIO
]
Input only. The type of the file.
Input only. The name of the file.
Input only. The size of the file in bytes.
Output only. The uri of the file.
Possible values: [FILE_SOURCE_LIVE_EVENT
, FILE_SOURCE_UPLOAD_IN_LIBRARY
, FILE_SOURCE_ADD_VOD
, FILE_SOURCE_CLOUD_STORAGE_AWS
, FILE_SOURCE_STT
, FILE_SOURCE_ADD_AOD
, FILE_SOURCE_AISK
, FILE_SOURCE_GOOGLE_DRIVE
, FILE_SOURCE_GOOGLE_CALENDAR
, FILE_SOURCE_HIGHLIGHT
, FILE_SOURCE_TRANSLATE
]
Required. The source of the file, only for display.
attrs object
subtitles object[]
The unique id of the subtitle.
The unique id of the library subtitle file.
The name of the subtitle file.
The language code of the subtitle file. Follow RFC 5646 (shortest ISO 639 code).
The display name of the subtitle file.
Possible values: [FILE_STATUS_SUCCEED
, FILE_STATUS_PROGRESSING
, FILE_STATUS_FAILED
]
Output Only. The file status.
permission object
Possible values: [ACCESS_ROLE_DENY
, ACCESS_ROLE_SUPER_EDITOR
, ACCESS_ROLE_EDITOR
, ACCESS_ROLE_VIEWER
]
assignments object[]
Required. Output Only. if the assigned_type
is ASSIGNED_TYPE_USER
, the id is user id.
if the assigned_type
is ASSIGNED_TYPE_GROUP
, the id is group id.
Output Only. It will return if the assigned_type
matches ASSIGNED_TYPE_USER
.
Output Only. The name of user or group.
Possible values: [ASSIGNED_TYPE_USER
, ASSIGNED_TYPE_GROUP
]
Possible values: [ACCESS_ROLE_DENY
, ACCESS_ROLE_SUPER_EDITOR
, ACCESS_ROLE_EDITOR
, ACCESS_ROLE_VIEWER
]
summary object
Output Only. The summary of the Library.
The content of summary.
Possible values: [SUMMARY_STATUS_WAITING
, SUMMARY_STATUS_PROCESSING
, SUMMARY_STATUS_READY
, SUMMARY_STATUS_FAILED
, SUMMARY_STATUS_DELETED
]
The status of summary.
The Library id of summary, it is existed when the summary is generated by AI.
The unique id from the summary service.
The character count of summary.
The token count of summary.
The subtitle id of summary, only existed when the summary is generated by subtitle.
error_infos object[]
Output only. Optional. A list of messages that carry the error infos when vod encoding is failed.
The reason of the error. This is a constant value that identifies the
proximate cause of the error. Error reasons are unique within a particular
domain of errors. This should be at most 63 characters and match a
regular expression of [A-Z][A-Z0-9_]+[A-Z0-9]
, which represents
UPPER_SNAKE_CASE.
The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
metadata object
Additional structured details about this error.
Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
Output only.
Output only.
contents object[]
Possible values: [SUBTITLE_SOURCE_TYPE_LOCAL
, SUBTITLE_SOURCE_TYPE_STT
, SUBTITLE_SOURCE_TYPE_AI_TRANSLATE
]
The source type of subtitle.
The id of the source subtitle used for translation.
Output only.
Output only.
{
"subtitles": [
{
"id": "string",
"track_no": "string",
"lang_code": "string",
"display": "string",
"status": "SUBTITLE_STATUS_GENERATING",
"subtitle_file_info": {
"file": {
"id": "string",
"type": "FILE_TYPE_VIDEO",
"name": "string",
"size": "string",
"uri": "string",
"source": "FILE_SOURCE_LIVE_EVENT",
"attrs": {},
"has_subtitle": true,
"subtitles": [
{
"id": "string",
"library_id": "string",
"name": "string",
"code": "string",
"display": "string"
}
],
"status": "FILE_STATUS_SUCCEED",
"permission": {
"assignments": [
{
"access_role": "ACCESS_ROLE_SUPER_EDITOR",
"assigned_type": "ASSIGNED_TYPE_OWNER",
"email": "",
"id": "",
"name": ""
}
],
"default_access_role": "ACCESS_ROLE_DENY"
},
"summary": {
"content": "string",
"status": "SUMMARY_STATUS_WAITING",
"library_id": "string",
"external_id": "string",
"character_count": "string",
"token_count": "string",
"subtitle_id": "string",
"error_infos": [
{
"reason": "string",
"domain": "string",
"metadata": {}
}
]
},
"created_at": "2024-07-29T15:51:28.071Z",
"updated_at": "2024-07-29T15:51:28.071Z"
},
"contents": [
{
"index": 0,
"start_at": "string",
"end_at": "string",
"words": [
"string"
]
}
]
},
"source_type": "SUBTITLE_SOURCE_TYPE_LOCAL",
"source_subtitle_id": "string",
"created_at": "2024-07-29T15:51:28.071Z",
"updated_at": "2024-07-29T15:51:28.071Z"
}
]
}
A bad request response.
The code
is 3
means got an invalid argument. There are more HTTP status code mappings listed on here and gRPC code on here.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- If no scheme is provided,
https
is assumed. - An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
- Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
- ]
details object[]
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
A unauthenticated response.
The header authorization
was missing or unidentified.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- If no scheme is provided,
https
is assumed. - An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
- Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
- ]
details object[]
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
A forbidden response.
It means that the provided authorization
did not have enough permission to access the resource or the API.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- If no scheme is provided,
https
is assumed. - An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
- Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
- ]
details object[]
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
A server error response. There are more HTTP status code mappings listed on here.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- If no scheme is provided,
https
is assumed. - An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
- Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
- ]
details object[]
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- If no scheme is provided,
https
is assumed. - An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
- Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
- ]
details object[]
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration
). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http
, https
, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http
, https
(or the empty scheme) might be
used with implementation specific semantics.
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}