07 October 2021

Closed Captions Sub Path

Added ability to set sub directory for ISMT and WebVTT Closed Captions for advanced multi-bitrate output formats.

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>[Action]</action> <!-- required-->
    <source>[SourceFile]</source> <!-- required-->
    <format>
        <output>[advanced_hls|fmp4_hls|advanced_dash|advanced_mss|advanced_fmp4]</output> <!-- required-->
        <!-- Format params -->
        <closed_captions>
            <mux_type>[webvtt|ismt]</mux_type>
            <sub_path>[SubPath]</sub_path>
            <!-- 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": "[advanced_hls|fmp4_hls|advanced_dash|advanced_mss|advanced_fmp4]", // required
            "closed_captions": [
                {
                    "mux_type": "[webvtt|ismt]",
                    "sub_path": "[SubPath]"
                    // closed captions params
                },
                {
                    // closed captions params
                }
            ]
          	// format params
        }
    }
}
ParameterDescriptionAllowed ValuesDefault Value
sub_pathISMT and WebVTT Closed Captions files sub directory relative to the output destinationStringnone

🚧

For sub_path

  • The <sub_path /> parameter available only for advanced multi-bitrate output formats.
  • The <sub_path /> parameter applied only if <mux_type /> set to ismt or webvtt.