跳到主要内容

Get STT subtitle

GET 

/bv/cms/v1/library/subtitles/:id

Get STT subtitle

Request

Path Parameters

    id stringrequired

    The id of the subtitle.

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
    video_subtitle object

    Deprecated. Use subtitle_info instead.

    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.

    vod_id string

    The id of VOD. If the video has been encoded, it will provide the vod id for getting vod information.

    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]

    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]

  • ]
  • 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]

    The source type of subtitle.

    created_at date-time

    Output only.

    updated_at date-time

    Output only.

    subtitle_info object
    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.

    media_id string

    The id of media, it can be vod_id or aod_id. If the subtitle is generated by video, it will provide the vod id for getting vod information. If the subtitle is generated by audio, it will provide the aod id for getting aod information.

    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]

    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]

  • ]
  • 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]

    The source type of subtitle.

    created_at date-time

    Output only.

    updated_at date-time

    Output only.

Loading...