Skip to main content

Get subtitles of VOD

GET 

/bv/cms/v1/vods/:id/subtitles

This API will return subtitles by vod id

Request

Path Parameters

    id stringrequired

    Required. The unique id of the VOD resource.

Header Parameters

    x-bv-org-id stringrequired

    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

A successful response.

Schema
    subtitles object[]

    Required. The list of subtitles.

  • Array [
  • id string

    The unique id of subtitle.

    track_no string

    The number of audio track.

    lang_code string

    The language code of the subtitle. The format is ISO639-1+ISO-3166-1 (e.g., en-US).

    display string

    The display name of the subtitle.

    status string

    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
    id string

    Output only. The unique id of the file.

    type string

    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.

    name string

    Input only. The name of the file.

    size int64

    Input only. The size of the file in bytes.

    uri string

    Output only. The uri of the file.

    source stringrequired

    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
    property name* string
    has_subtitle Output Only. Indicate the video has subtitle or not when the file type is `FILE_TYPE_VIDEO` (boolean)
    subtitles object[]
  • Array [
  • id string

    The unique id of the subtitle.

    library_id string

    The unique id of the library subtitle file.

    name string

    The name of the subtitle file.

    code string

    The language code of the subtitle file. Follow RFC 5646 (shortest ISO 639 code).

    display string

    The display name of the subtitle file.

  • ]
  • status string

    Possible values: [FILE_STATUS_SUCCEED, FILE_STATUS_PROGRESSING, FILE_STATUS_FAILED]

    Output Only. The file status.

    permission object
    default_access_role stringrequired

    Possible values: [ACCESS_ROLE_DENY, ACCESS_ROLE_SUPER_EDITOR, ACCESS_ROLE_EDITOR, ACCESS_ROLE_VIEWER]

    assignments object[]
  • Array [
  • id stringrequired

    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.

    email string

    Output Only. It will return if the assigned_type matches ASSIGNED_TYPE_USER.

    name string

    Output Only. The name of user or group.

    assigned_type Required. Output Only. It indicates the assigned type is user or group. It is not accept the `ASSIGNED_TYPE_OWNER` (string)required

    Possible values: [ASSIGNED_TYPE_USER, ASSIGNED_TYPE_GROUP]

    access_role Required. Output Only. It indicates access role. It is not accept the `ACCESS_ROLE_DENY` (string)required

    Possible values: [ACCESS_ROLE_DENY, ACCESS_ROLE_SUPER_EDITOR, ACCESS_ROLE_EDITOR, ACCESS_ROLE_VIEWER]

  • ]
  • summary object

    Output Only. The summary of the Library.

    content string

    The content of summary.

    status string

    Possible values: [SUMMARY_STATUS_WAITING, SUMMARY_STATUS_PROCESSING, SUMMARY_STATUS_READY, SUMMARY_STATUS_FAILED, SUMMARY_STATUS_DELETED]

    The status of summary.

    library_id string

    The Library id of summary, it is existed when the summary is generated by AI.

    external_id string

    The unique id from the summary service.

    character_count int64

    The character count of summary.

    token_count int64

    The token count of summary.

    subtitle_id string

    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.

  • Array [
  • reason string

    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.

    domain string

    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.

    property name* string
  • ]
  • created_at date-time

    Output only.

    updated_at date-time

    Output only.

    contents object[]
  • Array [
  • index int32
    start_at string
    end_at string
    words string[]
  • ]
  • source_type string

    Possible values: [SUBTITLE_SOURCE_TYPE_LOCAL, SUBTITLE_SOURCE_TYPE_STT, SUBTITLE_SOURCE_TYPE_AI_TRANSLATE]

    The source type of subtitle.

    source_subtitle_id string

    The id of the source subtitle used for translation.

    created_at date-time

    Output only.

    updated_at date-time

    Output only.

  • ]
Loading...