Caption to Caption Conversion

Convert captions files between formats.

<?xml version="1.0"?>
<query>
    <userid>[UserID]</userid> <!-- required-->
    <userkey>[UserKey]</userkey> <!-- required-->
    <action>AddMedia</action> <!-- required-->
    <source>[ClosedCaptionsSourceFile]</source> <!-- required-->
    <format>
        <output>closed_captions</output> <!-- required-->
        <destination>[DestinationURL]</destination> <!-- required-->
        <type>[srt|scc|webvtt|dfxp|ttml|mcc|stl]</type>
        <strip_formatting>[yes|no]</strip_formatting>
        <time_offset>[TIME_OFFSET]</time_offset>
        <cea_data_field>[0|1]</cea_data_field>
        <transparent_background>[yes|no]</transparent_background>
        <cea_stream>[video|text|auto]</cea_stream>
        <teletext_page_id>[PageID]</teletext_page_id>
        <ttml_profile>[TTMLProfile]</ttml_profile>
        <make_preconvert>[no|scc]</make_preconvert>
    </format>
</query>
{
    "query": {
        "userid": "[UserID]", // required
        "userkey": "[UserKey]", // required
        "action": "AddMedia", // required
        "source": ["[ClosedCaptionsSourceFile]"], // required
        "format": {
            "output": "closed_captions", // required
            "destination": "[DestinationURL]", // required
            "type": "[srt|scc|webvtt|dfxp|ttml|mcc|stl]",
            "strip_formatting": "[yes|no]",
            "time_offset": "[TIME_OFFSET]",
            "cea_data_field": "[0|1]",
            "transparent_background": "[yes|no]",
            "cea_stream": "[video|text|auto]",
            "teletext_page_id": "[PageID]",
            "ttml_profile": "[TTMLProfile]",
            "make_preconvert": "[no|scc]"
        }
    }
}
ParameterDescriptionAllowed ValuesDefault Value
sourceSpecify the URL to Closed Captions file or video with muxed closed captions.Valid URL to Closed Captions file (in one of the following formats: SCC, SubRip, DFXP (TTML), SAMI, WebvTT, PAC, STL) or video with muxed closed captions (in cea-6/708 or timed-text format).none
typeConvert closed captions to specified typesrt, scc, webvtt, dfxp, ttml, mcc, stlsrt
strip_formattingRemove all formatting tags (available only for DFXP).yes, nono
time_offsetSpecify the time offset for time in CC file.Positive or negative integer.0
cea_data_fieldCEA-608 data field id (data type) to be extracted from cea-608 CC data.0 – NTSCCC_FIELD_1
_1
– NTSC_CC_FIELD_2
0
transparent_backgroundAdd transparent background for DFXP Closed Captionsyes, nono
cea_streamStream type for closed captions extractionvideo, text, autoauto
teletext_page_idTeletext page id to copy or extractNon-negative integer numbernone
ttml_profileTTML profilebasic, smpte_st2052, smpte_ismc1, smpte_ismc1_1, smpte_ittbasic
make_preconvertPerform a pre-conversion of the source file to another format. For example, you may pre-convert TTML to SCC before converting to MCC to remove paint-on emulation in the original source file.no, sccno

🚧

For transparent_background

The <transparent_background /> parameter applied only if set to dfxp.

🚧

For ttml_profile

The <ttml_profile /> parameter applied only if set to ttml.

🚧

For type=mcc

If multiple source files are specified in the source array, these files will be merged into a single MCC file.