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]</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>
    </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]",
            "strip_formatting": "[yes|no]",
            "time_offset": "[TIME_OFFSET]",
            "cea_data_field": "[0|1]",
            "transparent_background": "[yes|no]"
        }
    }
}

Parameter

Description

Allowed Values

Default 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 type

srt, scc, webvtt or dfxp

srt

strip_formatting

Remove all formatting tags (available only for DFXP).

yes, no

no

time_offset

Specify the time offset for time in CC file.

Positive or negative integer.

0

cea_data_field

CEA-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_background

Add transparent background for DFXP Closed Captions

yes, no

no

🚧

For transparent_background

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