Contact Support | System Status
Page Contents

    Auto Captions

    This topic contains details for encoding settings related to automatically generating captions for your videos when they are processed.

    Overview

    Zencoder can automatically generate captions of the audio track for your videos. The job may also include transcoding by including video outputs, but does not have to.

    Output formats supported for captions (set using format ):

    • mp4 files, with caption track in CEA-608 format
    • m3u8 outputs (segmented outputs with H.264 video in TS format)
    • SCC, WebVTT, VTT, and DFXP formats are also supported with captions type output

    In addition to the settings described below, you will need to use the following settings:

    Enabling auto captions

    If you are a credit card customer, you can enable auto captions by going to Account > Subscription and clicking on the button shown in the image below:

    Enable Auto Captions
    Enable Auto Captions

    If you are a premium customers need to contact your account manager to have auto captions enabled.

    caption_from_audio_transcription

    caption_from_audio_transcription:Boolean

    API Versions: V2

    Parent: outputs

    Default: false

    Compatible Job Types: All

    Description:

    Uses audio transcription to generate captions when captions are not available in the source file.

    {
      "input": "s3://zencodertesting/test.mov",
      "outputs": [
        {
          "type": "captions",
          "caption_from_audio_transcription": true
        }
      ]
    }

    select_audio_language

    select_audio_language:String

    API Versions: V2

    Parent: outputs

    Default: auto (same as the audio_language value)

    Compatible Job Types: All

    Description:

    The language of the audio track to be used for transcription.

    Valid values: ISO 639-1 or 639-2 language code

    {
      "input": "s3://zencodertesting/test.mov",
      "outputs": [
        {
          "type": "captions",
          "select_audio_language": "en"
        }
      ]
    }

    select_audio_service_type

    select_audio_service_type:String

    API Versions: V2

    Parent: outputs

    Default: auto (same as the audio_language value)

    Compatible Job Types: All

    Description:

    The type of audio to be transcribed.

    Valid values: 'main', 'music_and_effects', 'visually_impaired', 'hearing_impaired', 'dialogue', 'commentary', 'emergency', 'voice_over'

    {
      "input": "s3://zencodertesting/test.mov",
      "outputs": [
        {
          "type": "captions",
          "select_audio_service_type": "dialogue"
        }
      ]
    }

    audio_language

    audio_language:String

    API Versions: V2

    Parent: outputs

    Default: auto (same as the audio_language value)

    Compatible Job Types: All

    Description:

    The language of the input audio for using on transcription.

    This value is a BCP-47 style language code, for instance “en-US”, “en-GB”.

    Valid values: af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, and zh-CN

    {
      "input": "s3://zencodertesting/test.mov",
      "outputs": [
        {
          "type": "captions",
          "audio_language": "es-ES"
        }
      ]
    }

    Page last updated on 05 Oct 2021