Closed Captions

<?xml version="1.0"?>
<query>
    <userid>[UserID]</userid> <!-- required-->
    <userkey>[UserKey]</userkey> <!-- required-->
    <action>[Action]</action> <!-- required-->
    <source>[SourceFile]</source> <!-- required-->
    <format>
        <output>[OutputFormat]</output> <!-- required-->
        <closed_captions>
            <source>[CCSource]</source>
            <copy>[yes|no]</copy>
            <direct_copy>[yes|no]</direct_copy>
            <extract>[srt|scc|dfxp]</extract>
            <mux_type>[cea-608|cea-708|timed-text|webvtt|burn-in|ismt|436m|dvb|mp4-ttml|mp4-webvtt]</mux_type>
            <language>[LanguageCode]</language>
            <name>[NameCode]</name>
            <time_offset>[TimeOffset]</time_offset>
            <vtt_segment_duration>[SegmentDuration]</vtt_segment_duration>
            <font_source>[FontSourceURL]</font_source>
            <font_size>[FontSize]</font_size>
            <align>[left|right|center]</align>
            <valign>[top|bottom|center]</valign>
            <margin_vertical>[VerticalMargin]</margin_vertical>
            <margin_left>[LeftMargin]</margin_left>
            <margin_right>[RightMargin]</margin_right>
            <add_source_offset>[yes|no]</add_source_offset>
            <!-- add_source_offset feature works only with mxf source -->
            <ignore_cc_absence>[yes|no]</ignore_cc_absence>
            <cea_data_field>[0|1]</cea_data_field>
            <scte20>[yes|no]</scte20>
            <characteristics>[Characteristics]</characteristics>
            <accessibility_scheme>[Scheme]</accessibility_scheme>
            <accessibility_value>[Value]</accessibility_value>
            <timescale>[Timescale]</timescale>
            <cea_track_id>[TrackID]</cea_track_id>
            <transparent_background>[yes|no]</transparent_background>
            <sub_path>[SubPath]</sub_path>
            <forced>[yes|no]</forced>
            <role>[SubtitleRole]</role>
            <get_from_manifest>[yes|no]</get_from_manifest>
            <add_to_manifest>[ManifestsList]</add_to_manifest>
            <vtt_split_segments>[yes|no]</vtt_split_segments>
            <cea_stream>[video|text|auto]</cea_stream>
            <page>[PageNumber]</page>
            <teletext_page_id>[PageID]</teletext_page_id>
            <emulate_rollup>[yes|no]</emulate_rollup>
            <strip_formatting>[yes|no]</strip_formatting>
        </closed_captions>
        <!-- Multiple closed captions params may be included in output format -->
        <closed_captions>
            <!-- closed captions params -->
        </closed_captions>
        <teletext>
            <vanc_line_1>[VANCLine1]</vanc_line_1>
            <vanc_line_2>[VANCLine2]</vanc_line_2>
            <vbi_line_1>[VBILine1]</vbi_line_1>
            <vbi_line_2>[VBILine2]</vbi_line_2>
        </teletext>
        <!-- format params -->
    </format>
</query>

{
    "query": {
        "userid": "[UserID]", // required
        "userkey": "[UserKey]", // required
        "action": "[Action]", // required
        "source": "[SourceFile]", // required
        "format": {
            "output": "[OutputFormat]", // required
            "closed_captions": [
                {
                    "source": "[CCSource]",
                    "copy": "[yes|no]",
                    "direct_copy": "[yes|no]",
                    "extract": "[srt|scc|dfxp]",
                    "mux_type": "[cea-608|cea-708|timed-text|webvtt|burn-in|ismt|436m|dvb|mp4-ttml|mp4-webvtt]",
                    "language": "[LanguageCode]",
                    "name": "[NameCode]",
                    "time_offset": "[TimeOffset]",
                    "vtt_segment_duration": "[SegmentDuration]",
                    "font_source": "[FontSourceURL]",
                    "font_size": "[FontSize]",
                    "align": "[left|right|center]",
                    "valign": "[top|bottom|center]",
                    "margin_vertical": "[VerticalMargin]",
                    "margin_left": "[LeftMargin]",
                    "margin_right": "[RightMargin]",
                    "add_source_offset": "[yes|no]",
                    // add_source_offset feature works only with mxf source
                    "ignore_cc_absence": "[yes|no]",
                    "cea_data_field": "[0|1]",
                    "scte20": "[yes|no]",
                    "characteristics": "[Characteristics]",
                    "accessibility_scheme": "[Scheme]",
                    "accessibility_value": "[Value]",
                    "timescale": "[Timescale]",
                    "cea_track_id": "[TrackID]",
                    "transparent_background": "[yes|no]",
                    "sub_path": "[SubPath]",
                    "forced": "[yes|no]",
                    "role": "[SubtitleRole]",
                    "get_from_manifest": "[yes|no]",
                    "add_to_manifest": "[ManifestsList]",
                    "vtt_split_segments": "[yes|no]",
                    "cea_stream": "[video|text|auto]",
                    "page": "[PageNumber]",
                    "teletext_page_id": "[PageID]",
                    "emulate_rollup": "[yes|no]",
                    "strip_formatting": "[yes|no]"
                },
                {
                    // closed captions params
                }
            ],
            "teletext": {
                "vanc_line_1": "[VANCLine1]",
                "vanc_line_2": "[VANCLine2]",
                "vbi_line_1": "[VBILine1]",
                "vbi_line_2": "[VBILine2]"
            }
          	// format params
        }
    }
}