Subtitles / Closed Captions
To embed the subtitles for a VOD, make a PUT request to the following API with specific VOD id provided:
PUT /bv/cms/v1/vods/:id/subtitles
Configure the subtitle request body with the following options:
| Attribute | Type | Description |
|---|---|---|
id | string | Specify the ID of the subtitle you would like to embed. You can upload and obtain the ID for a subtile file using this API: POST /bv/cms/v1/library/files:uploadsrt, vtt 3 MB |
name | string | The name of the subtitle as it will appear on BlendVision console. |
code | string | Language code follows the RFC 5646 standard, utilizing the shortest ISO 639-1 & ISO 3166-1 code. Please refer to Language Code Table as below. |
display | string | The name of the subtitle language as it will appear on the player. |
Supported Language Code
| Language | Language Code | Language |
|---|---|---|
| Afrikaans | af-ZA | Afrikaans (South Africa) |
| Albanian | sq-AL | Albanian (Albania) |
| Amharic | am-ET | Amharic (Ethiopia) |
| Arabic | ar-AE | Arabic (U.A.E.) |
| Armenian | hy-AM | Armenian (Armenia) |
| Assamese | as-IN | Assamese (India) |
| Bashkir | ba-RU | Bashkir (Russia) |
| Basque | eu-ES | Basque (Basque) |
| Bengali (Bangla) | bn-BD | Bengali (Bangladesh) |
| Bhutani | dz-BT | Bhutani (Bhutan) |
| Bihari | bh-IN | Bihari (India) |
| Bislama | bi-VU | Bislama(Vanuatu) |
| Breton | br-FR | Breton (France) |
| Bulgarian | bg-BG | Bulgarian (Bulgaria) |
| Burmese | my-MM | Burmese (Myanmar) |
| Byelorussian (Belarusian) | be-BY | Belarusian (Belarus) |
| Catalan | ca-ES | Catalan (Catalan) |
| Chinese (Simplified) | zh-CN | Chinese (China) |
| Chinese (Traditional) | zh-TW | Chinese (Taiwan) |
| Corsican | co-FR | Corsican (France) |
| Croatian | hr-HR | Croatian (Croatia) |
| Czech | cs-CZ | Czech (Czech Republic) |
| Danish | da-DK | Danish (Denmark) |
| Dutch | nl-NL | Dutch (Netherlands) |
| English | en-US | English (United States) |
| Estonian | et-EE | Estonian (Estonia) |
| Fijian | fj-FJ | Fijian (Fiji) |
| Finnish | fi-FI | Finnish (Finland) |
| French | fr-FR | French (France) |
| Frisian | fy-NL | Frisian (Netherlands) |
| Galician | gl-ES | Galician (Galician) |
| Gaelic (Scottish) | gd-IE | Gaelic (Ireland) |
| Georgian | ka-GE | Georgian (Georgia) |
| German | de-DE | German (Germany) |
| Greek | el-GR | Greek (Greece) |
| Greenlandic | kl-GL | Greenlandic (Greenland) |
| Guarani | gn-PY | Guarani (Paraguay) |
| Gujarati | gu-IN | Gujarati (India) |
| Hausa | ha-NG | Hausa (Nigeria) |
| Hebrew | he-IL | Hebrew (Israel) |
| Hindi | hi-IN | Hindi (India) |
| Hungarian | hu-HU | Hungarian (Hungary) |
| Icelandic | is-IS | Icelandic (Iceland) |
| Indonesian | id-ID | Indonesian (Indonesia) |
| Inuktitut | iu-CA | Inuktitut (Canada) |
| Irish | ga-IE | Irish (Ireland) |
| Italian | it-IT | Italian (Italy) |
| Japanese | ja-JP | Japanese (Japan) |
| Javanese | ja-ID | Javanese (Indonesia) |
| Kannada | kn-IN | Kannada (India) |
| Kashmiri | ks-IN | Kashmiri (India) |
| Korean | ko-KR | Korean (Korea) |
| Malay | ms-MY | Malay (Malaysia) |
| Malayalam | ml-IN | Malayalam (India) |
| Norwegian | nn-NO | Norwegian (Norway) |
| Polish | pl-PL | Polish (Poland) |
| Portuguese | pt-PT | Portuguese (Portugal) |
| Romanian | ro-RO | Romanian (Romania) |
| Russian | ru-RU | Russian (Russia) |
| Slovak | sk-SK | Slovak (Slovakia) |
| Spanish | es-ES | Spanish (Spain) |
| Swedish | sv-SE | Swedish (Sweden) |
| Thai | th-TH | Thai (Thailand) |
| Turkish | tr-TR | Turkish (Turkey) |
| Turkmen | tk-TM | Turkmen (Turkmenistan) |
| Ukrainian | uk-UA | Ukrainian (Ukraine) |
| Vietnamese | vi-VN | Vietnamese (Vietnam) |
| Welsh | cy-GB | Welsh (United Kingdom) |
Here is an example of a request body:
{
"subtitles":[
{
"id":"your-subtitle-id",
"name":"English",
"code":"en",
"display":"English"
}
]
}