Caption to Caption Conversion

Convert captions files between formats.

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></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]</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>
    </format>
</query>
{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "AddMedia", // required
        "source": "[ClosedCaptionsSourceFile]", // required
        "format": {
            "output": "closed_captions", // required
            "destination": "[DestinationURL]", // required
            "type": "[srt|scc|webvtt|dfxp|ttml|mcc]",
            "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]"
        }
    }
}
ParameterDescriptionAllowed ValuesDefault Value
source Specify 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
type Convert closed captions to specified typesrt, scc, webvtt, dfxp, ttml, mccsrt
strip_formatting Remove all formatting tags (available only for DFXP).yes, nono
time_offset Specify 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 – NTSC_CC_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

🚧

For transparent_background

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

🚧

For ttml_profile

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