Skip to main content

Update subtitles of VOD

PUT 

https://api.one.blendvision.com/bv/cms/v1/vods/:id/subtitles

Modifies the subtitles of a VOD resource with the specified subtitle file.


Required field(s):

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

Body

required
    subtitles object[]

    Optional. The subtitles that will be added to the VOD resource.

  • Array [
  • id stringrequired

    The unique id of the library subtitle file.

    name string

    The name of the subtitle file.

    code string

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

    display stringrequired

    The display name of the subtitle file.

    translate_settings object[]

    The translate settings of the subtitle. It's only supported in AddVODSubtitles, TranslateVODSubtitle and CreateVOD API.

  • Array [
  • source_lang_code stringrequired

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

    target_lang_code stringrequired

    The target language code you want to translate into. The format is ISO639-1+ISO-3166-1 (e.g., en-US).

    display stringrequired

    The display name of the translated subtitle file.

  • ]
  • ]
  • stt_subtitles object[]

    Optional. The subtitle will auto-generated and added to VOD resource.

  • Array [
  • track_no string

    The number of audio track.

    lang_code string

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

    display stringrequired

    The display name of the subtitle file.

    translate_settings object[]

    The translate settings of the subtitle. It's only supported in AddVODSubtitles, TranslateVODSubtitle and CreateVOD API.

  • Array [
  • source_lang_code stringrequired

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

    target_lang_code stringrequired

    The target language code you want to translate into. The format is ISO639-1+ISO-3166-1 (e.g., en-US).

    display stringrequired

    The display name of the translated subtitle file.

  • ]
  • ]

Responses

A successful response.

Schema

    object

Authorization: authorization

name: authorizationtype: apiKeydescription: Enter the token with Bearer schema prefix, eg. `Bearer <token-string>`in: header
curl -L -X PUT 'https://api.one.blendvision.com/bv/cms/v1/vods/:id/subtitles' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'authorization: <API_KEY_VALUE>' \
-d '{
"stt_subtitles": [
{
"display": "English",
"lang_code": "en",
"track_no": "0"
}
],
"subtitles": [
{
"code": "en",
"display": "English",
"id": "34386ef5-209e-453f-93c7-6f48a24ad38c",
"name": "english.srt"
},
{
"code": "zh",
"display": "Chinese",
"id": "daedaa0c-6250-4637-965e-c70c24568c73",
"name": "chinese.vtt"
}
]
}'
Request Collapse all
Base URL
https://api.one.blendvision.com
Auth
Parameters
— pathrequired
— headerrequired
Body required
{
"stt_subtitles": [
{
"display": "English",
"lang_code": "en",
"track_no": "0"
}
],
"subtitles": [
{
"code": "en",
"display": "English",
"id": "34386ef5-209e-453f-93c7-6f48a24ad38c",
"name": "english.srt"
},
{
"code": "zh",
"display": "Chinese",
"id": "daedaa0c-6250-4637-965e-c70c24568c73",
"name": "chinese.vtt"
}
]
}
ResponseClear

Click the Send API Request button above and see the response here!