Specific Options for advanced_hls and fmp4_hls Outputs

<?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]</output>
        <stream>
            <!-- Manifests fields -->
            <manifest>
                <basename>[BaseName]</basename> <!-- required-->
                <add_to_manifest>
                    [ManifestName]:[Position],[ManifestName]:[Position]
                </add_to_manifest>
                <clearkey_drm>[yes|no]</clearkey_drm>
                <fairplay_drm>[yes|no]</fairplay_drm>
                <access_drm>[yes|no]</access_drm>
                <playready_drm>[yes|no]</playready_drm>
                <destination>[ManifestDestination]</destination>
            </manifest>
            <!-- Multiple manifests may be included -->
            <manifest>
               <!-- manifest params -->
            </manifest>
            <stream_title>[Title]</stream_title>
            <pack_audio_to_mpegts>[yes|no]</pack_audio_to_mpegts>
        </stream>
        <!-- Multiple stream params may be included in advanced_hls output format -->
        <!-- Maximum number of available streams is 15 -->
        <stream>
           <!-- stream params -->
        </stream>
        <!-- Manifests fields -->
        <manifest>
            <basename>[BaseName]</basename> <!-- required-->
            <destination>[ManifestDestination]</destination>
            <add_audio_only>[yes|no]</add_audio_only>
            <add_hls_drm_metadata>[yes|no]</add_hls_drm_metadata>
            <add_audio_channels>[yes|no|auto]</add_audio_channels>
        </manifest>
        <!-- Multiple manifests may be included -->
        <manifest>
           <!-- manifest params -->
        </manifest>
        <!-- Alternate source fields -->
        <!-- multiple alternate_sources may be included -->
        <alternate_source>
            <alternate_default>[yes|no|auto]</alternate_default>
            <alternate_autoselect>[yes|no]</alternate_autoselect>
        </alternate_source>
        <!-- multiple ad_breaks may be included -->
        <ad_break>
           <start>[StartTime]</start>
           <end>[EndTime]</end>
           <duration>[BreakDuration]</duration>
           <drop_segments>[yes|no]</drop_segments>
           <marker_type>[MarkerType]</marker_type>
           <id>[BreakID]</id>
        </ad_break>
        <ad_break>
           <!-- ad_break params -->
        </ad_break>
        <!-- multiple cue_inserts may be included -->
        <cue_insert>
           <start>[StartTime]</start>
           <end>[EndTime]</end>
           <duration>[BreakDuration]</duration>
           <drop_segments>[yes|no]</drop_segments>
           <marker_type>[MarkerType]</marker_type>
           <id>[BreakID]</id>
        </cue_insert>
        <cue_insert>
           <!-- cue_insert params -->
        </cue_insert>
        <cmaf_conformant>[yes|no]</cmaf_conformant>
        <bif>[yes|no]</bif>
        <bif_destination>[BIFDestination1]</bif_destination>
        <!-- Multiple BIF destinations may be included -->
        <bif_destination>[BIFDestinationN]</bif_destination>
        <reduce_structural_overhead>[yes|no]</reduce_structural_overhead>
        <add_audio_only>[yes|no]</add_audio_only>
        <init_extension>[Extension]</init_extension>
        <segment_extension>[Extension]</segment_extension>
        <!-- Format params -->
        <!-- Nielsen metadata settings -->
    </format>
</query>
{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "[Action]", // required
        "source": "[SourceFile]", // required
        "format": {
            "output": "[advanced_hls|fmp4_hls]",
            "stream": [
                {
                    "manifest": [
                        {
                            "basename": "[BaseName]",
                            "add_to_manifest": "[ManifestName]:[Position],[ManifestName]:[Position]",
                            "clearkey_drm": "[yes|no]",
                            "fairplay_drm": "[yes|no]",
                            "access_drm": "[yes|no]",
                            "playready_drm": "[yes|no]",
                            "destination": "[ManifestDestination]"
                        },
                        {
                            // manifest params
                        }
                    ],
                    "stream_title": "[Title]",
                    "pack_audio_to_mpegts": "[yes|no]"
                },
                {
                    // stream params
                }
            ],
            "manifest": [
                {
                    "basename": "[BaseName]",
                    "destination": "[ManifestDestination]",
                    "add_audio_only": "[yes|no]",
                    "add_hls_drm_metadata": "[yes|no]",
                    "add_audio_channels": "[yes|no|auto]"
                },
                {
                    // manifest params
                }
            ],
            "alternate_source": [
                {
                    "alternate_default": "[yes|no|auto]",
                    "alternate_autoselect": "[yes|no]"
                  },
                {
                    // alternate_source params
                }
            ],
            "ad_break": [
                {
                    "start": "[StartTime]",
                    "end": "[EndTime]",
                    "duration": "[BreakDuration]",
                    "drop_segments": "[yes|no]",
                    "marker_type": "[MarkerType]",
                    "id": "[BreakID]"
                },
                {
                    // ad_break params
                }
            ],
            "cue_insert": [
                {
                    "start": "[StartTime]",
                    "end": "[EndTime]",
                    "duration": "[BreakDuration]",
                    "drop_segments": "[yes|no]",
                    "marker_type": "[MarkerType]",
                    "id": "[BreakID]"
                },
                {
                    // cue_insert params
                }
            ],
            "cmaf_conformant": "[yes|no]",
            "bif": "[yes|no]",
            "bif_destination": [
                "[BIFDestination1]",
                "[BIFDestinationN]"
            ],
            "reduce_structural_overhead": "[yes|no]",
            "add_audio_only": "[yes|no]",
            "init_extension": "[Extension]",
            "segment_extension": "[Extension]"
            // format params
        }
    }
}

🚧

Note

Closed caption webVTT and cea-608 mux types are only available for advanced_hls output format.

🚧

Note

The <ad_break /> feature is only available for advanced_hls, fmp4_hls, and advanced_fmp4 (HLS manifest) output formats.

🚧

Note

The <cmaf_conformant /> feature is available for fmp4_hls and other fmp4 output formats.

🚧

Note

<init_extension /> and <segment_extension /> features are restricted to the fmp4_hls output format.

🚧

Note

The <pack_audio_to_mpegts /> feature is restricted to the advanced_hls output format.