Skip to main content

Common Data Formats

MediaFormat​

An enumeration representing the supported media formats.

Enum Values:​

  • MP4 ("MP4"): Represents media in MP4 format.
  • MOV ("MOV"): Represents media in MOV format.
  • MP3 ("MP3"): Represents media in MP3 format.

ServiceType​

Defines the types of services that can be requested.

Enum Values:​

  • TRANSCRIBE ("TRANSCRIBE"): Represents a transcription service.
  • TRANSLATE ("TRANSLATE"): Represents a translation service.
  • ANALYSIS ("ANALYSIS"): Represents an analysis service.

ServiceCategory​

Represents the category of services available.

Enum Values:​

  • AI ("AI"): Indicates that the service is powered by artificial intelligence.

ServiceStatus​

Represents the status of a service.

Enum Values:​

  • PENDING ("PENDING"): Indicates that the service is in progress.
  • READY ("READY"): Indicates that the service has been completed.
  • FAILED ("FAILED"): Indicates that the service has failed.

TranscriptionFormat​

Represents the format of a transcription.

Enum Values:​

  • DOCX ("DOCX"): Represents a transcription in DOCX format.
  • TXT ("TXT"): Represents a transcription in TXT format.

CaptionFormat​

Represents the format of a caption.

Enum Values:​

  • VTT ("VTT"): Represents a transcription in VTT format.
  • SRT ("SRT"): Represents a transcription in SRT format.
  • TTML ("TTML"): Represents a transcription in TTML format.
  • XML ("XML"): Represents a transcription in XML format.

AudioFormat​

Represents the format of an audio file.

Enum Values:​

  • MP3 ("MP3"): Represents an audio file in MP3 format.

AspectRatio​

Represents the aspect ratio of a video.

Enum Values:​

  • 16:9 ("16:9"): Represents a 16:9 aspect ratio. (Landscape)
  • 9:16 ("9:16"): Represents a 9:16 aspect ratio. (Portrait)
  • 4:5 ("4:5"): Represents a 4:5 aspect ratio. (Vertical)
  • 1:1 ("1:1"): Represents a 1:1 aspect ratio. (Square)
  • Original ("Original"): Represents the original aspect ratio.

Language (Transcribe)​

The following languages are supported for transcription.

  • en-AU: English (Australian)
  • en-GB: English (British)
  • en-US: English (US)
  • en-IN: English (Indian)
  • en-IE: English (Irish)
  • en-AB: English (Scottish)
  • en-WL: English (Welsh)
  • en-ZA: English (South African)
  • en-NZ: English (New Zealand)
  • af-ZA: Afrikaans
  • ar-AE: Arabic (Gulf)
  • ar-SA: Arabic (Modern Standard)
  • zh-CN: Chinese (Simplified)
  • zh-TW: Chinese (Traditional)
  • da-DK: Danish
  • nl-NL: Dutch
  • fr-FR: French
  • fr-CA: French (Canadian)
  • de-DE: German
  • de-CH: German (Swiss)
  • he-IL: Hebrew
  • hi-IN: Hindi (Indian)
  • id-ID: Indonesian
  • it-IT: Italian
  • ja-JP: Japanese
  • ko-KR: Korean
  • ms-MY: Malay
  • pt-PT: Portuguese
  • pt-BR: Portuguese (Brazilian)
  • ru-RU: Russian
  • es-ES: Spanish
  • es-US: Spanish (US)
  • ta-IN: Tamil
  • te-IN: Telugu
  • th-TH: Thai
  • tr-TR: Turkish

Language (Translate)​

The following languages are supported for translation.

Translate To and From​

Available languages for translation from and translation to are:

  • af: Afrikaans
  • ak: Twi (Akan)
  • am: Amharic
  • ar: Arabic
  • as: Assamese
  • ay: Aymara
  • az: Azerbaijani
  • be: Belarusian
  • bg: Bulgarian
  • bho: Bhojpuri
  • bm: Bambara
  • bn: Bengali
  • bs: Bosnian
  • ca: Catalan
  • ceb: Cebuano
  • ckb: Kurdish (Sorani)
  • co: Corsican
  • cs: Czech
  • cy: Welsh
  • da: Danish
  • de: German
  • doi: Dogri
  • dv: Dhivehi
  • ee: Ewe
  • el: Greek
  • en: English
  • eo: Esperanto
  • es: Spanish
  • et: Estonian
  • eu: Basque
  • fa: Persian
  • fi: Finnish
  • fil: Filipino (Tagalog)
  • fr: French
  • fy: Frisian
  • ga: Irish
  • gd: Scots Gaelic
  • gl: Galician
  • gn: Guarani
  • gom: Konkani
  • gu: Gujarati
  • ha: Hausa
  • haw: Hawaiian
  • he: Hebrew
  • hi: Hindi
  • hmn: Hmong
  • hr: Croatian
  • ht: Haitian Creole
  • hu: Hungarian
  • hy: Armenian
  • id: Indonesian
  • is: Icelandic
  • it: Italian
  • ja: Japanese
  • jw: Javanese
  • ka: Georgian
  • kk: Kazakh
  • km: Khmer
  • kn: Kannada
  • ko: Korean
  • kri: Krio
  • ku: Kurdish
  • ky: Kyrgyz
  • la: Latin
  • lb: Luxembourgish
  • lg: Luganda
  • ln: Lingala
  • lo: Lao
  • lt: Lithuanian
  • lus: Mizo
  • lv: Latvian
  • mai: Maithili
  • mg: Malagasy
  • mi: Maori
  • mk: Macedonian
  • ml: Malayalam
  • mn: Mongolian
  • mni-Mtei: Meitei (Manipuri)
  • mr: Marathi
  • ms: Malay
  • mt: Maltese
  • my: Myanmar (Burmese)
  • nb: Norwegian (Bokmål)
  • ne: Nepali
  • nl: Dutch
  • no: Norwegian
  • nso: Sepedi
  • ny: Nyanja (Chichewa)
  • om: Oromo
  • or: Odia (Oriya)
  • pa: Punjabi
  • pl: Polish
  • ps: Pashto
  • pt: Portuguese (Portugal, Brazil)
  • qu: Quechua
  • ro: Romanian
  • ru: Russian
  • rw: Kinyarwanda
  • sa: Sanskrit
  • sd: Sindhi
  • si: Sinhala (Sinhalese)
  • sk: Slovak
  • sl: Slovenian
  • sm: Samoan
  • sn: Shona
  • so: Somali
  • sq: Albanian
  • sr: Serbian
  • st: Sesotho
  • su: Sundanese
  • sv: Swedish
  • sw: Swahili
  • ta: Tamil
  • te: Telugu
  • tg: Tajik
  • th: Thai
  • ti: Tigrinya
  • tk: Turkmen
  • tl: Tagalog (Filipino)
  • tr: Turkish
  • ts: Tsonga
  • tt: Tatar
  • ug: Uyghur
  • uk: Ukrainian
  • ur: Urdu
  • uz: Uzbek
  • vi: Vietnamese
  • xh: Xhosa
  • yi: Yiddish
  • yo: Yoruba
  • zh: Chinese (Simplified)
  • zh-TW: Chinese (Traditional)
  • zu: Zulu

Translate From Only​

The following languages support translation from only:

  • en: English
  • pt: Portuguese

Translate to Only​

The following languages support translation to only:

  • en-GB: English (British)
  • en-US: English (US)
  • pt-PT: Portuguese
  • pt-BR: Portuguese (Brazilian)

Caption Guidelines​

Guidelines for caption formatting based on popular platforms.

Enum Values:​

  • BBC ("BBC"): Represents the caption guidelines for BBC.
  • Netflix ("Netflix"): Represents the caption guidelines for Netflix.
  • TED ("TED"): Represents the caption guidelines for TED.
  • YouTube ("YouTube"): Represents the caption guidelines for YouTube.

Guideline Settings​

The table below shows the guideline settings for each platform.

  • maxLines: Maximum number of lines per caption.
  • maxCharsLine: Maximum number of characters per line.
  • maxCharsSec: Maximum number of characters per second.
  • maxCueDuration: Maximum duration of a caption.
  • maxLineWords: Maximum number of words per line.
GuideLinemaxLinesmaxCharsLinemaxCharsSecmaxCueDurationmaxLineWords
BBC2422170007
Netflix2422070007
TED2382170007
YouTube2391860006

Caption Alignment​

The alignment of captions in the video.

Enum Values:​

  • BOTTOM_LEFT ("BOTTOM_LEFT"): Represents bottom left alignment.
  • BOTTOM_CENTER ("BOTTOM_CENTER"): Represents bottom center alignment.
  • BOTTOM_RIGHT ("BOTTOM_RIGHT"): Represents bottom right alignment.
  • MIDDLE_LEFT ("MIDDLE_LEFT"): Represents middle left alignment.
  • MIDDLE_CENTER ("MIDDLE_CENTER"): Represents middle center alignment.
  • MIDDLE_RIGHT ("MIDDLE_RIGHT"): Represents middle right alignment.
  • TOP_LEFT ("TOP_LEFT"): Represents top left alignment.
  • TOP_CENTER ("TOP_CENTER"): Represents top center alignment.
  • TOP_RIGHT ("TOP_RIGHT"): Represents top right alignment.

Report Types​

The types of reports that can be generated.

Enum Values:​

  • ACCESSIBILITY ("ACCESSIBILITY"): Accessibility report.