05 August 2021

Transparent Background for DFXP/TTML closed captions

Added a new parameter to set a transparent background for DFXP/TTML closed capations.

Sidecar Closed Captions

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></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>dfxp</extract>
            <transparent_background>[yes|no]</transparent_background>
            <!-- closed captions params -->
        </closed_captions>
        <!-- Multiple closed captions params may be included in output format -->
        <closed_captions>
            <!-- closed captions params -->
        </closed_captions>
        <!-- format params -->
    </format></query>
{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // 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",
                    "transparent_background": "[yes|no]"
                    // closed captions params
                },
                {
                    // closed captions params
                }
            ]
          	// format params
        }
    }
}
ParameterDescriptionAllowed ValuesDefault Value
transparent_backgroundAdd transparent background for DFXP Closed Captionsyes, nono

🚧

For transparent_background

The <transparent_background /> parameter applied only if <extract /> set to dfxp and <mux_type /> not set.

Closed Captions Conversion

<?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>dfxp</type>
        <transparent_background>[yes|no]</transparent_background>
        <!-- format params -->
    </format>
</query>
{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "AddMedia", // required
        "source": "[ClosedCaptionsSourceFile]", // required
        "format": {
            "output": "closed_captions", // required
            "destination": "[DestinationURL]", // required
            "type": "dfxp",
            "transparent_background": "[yes|no]"
            // format params
        }
    }
}
ParameterDescriptionAllowed ValuesDefault Value
transparent_backgroundAdd transparent background for DFXP Closed Captionsyes, nono

🚧

For transparent_background

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