10 May 2016

Custom Channel Mapping

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>[Action]</action> <!-- required-->
    <format>
        <!-- Format fields -->
        <audio_stream>
            <channel>
                <id>[OutputChannelID]</id>
                <in>
                    <id>[SourceTrackID:SourceChannelID]</id>
                    <gain>[ChannelGainLevel]</gain>
                </in>
                <in>
                    <!-- input channel params -->
                </in>
            </channel>
            <channel>
                <!-- audio channel params -->
            </channel>
            <normalize>[yes|no]</normalize>
            <layout>[AudioLayoutName]</layout>
        </audio_stream>
        <!-- multiple audio streams -->
        <audio_stream>
            <!-- audio stream params -->
        </audio_stream>
    </format>
</query>

{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "action": "[Action]",
        "format": {
            "audio_stream": [
                {
                    "channel": [
                        {
                            "id": "[OutputChannelID]",
                            "in": [
                                {
                                    "id": "[SourceTrackID:SourceChannelID]",
                                    "gain": "[ChannelGainLevel]"
                                },
                                "  "
                            ]
                        },
                        "  "
                    ],
                    "normalize": "[yes|no]",
                    "layout": "[AudioLayoutName]"
                }
            ]
        }
    }
}

Field Name	Description	Allowed Values	Default Values
Mapping params
normalize	Renormalize output output track to avoid clipping noise	yes, no
layout	Output channels layout	One of these channel layouts: mono — FC stereo — FL+FR 2.1 — FL+FR+LFE 3.0 — FL+FR+FC 3.0-back — FL+FR+BC 4.0 — FL+FR+FC+BC quad — FL+FR+BL+BR quad-side — FL+FR+SL+SR 3.1 — FL+FR+FC+LFE 5.0 — FL+FR+FC+BL+BR 5.0-side — FL+FR+FC+SL+SR 4.1 — FL+FR+FC+LFE+BC 5.1 — FL+FR+FC+LFE+BL+BR 5.1-side — FL+FR+FC+LFE+SL+SR 6.0 — FL+FR+FC+BC+SL+SR 6.0-front — FL+FR+FLC+FRC+SL+SR hexagonal — FL+FR+FC+BL+BR+BC 6.1 — FL+FR+FC+LFE+BC+SL+SR 6.1 — FL+FR+FC+LFE+BL+BR+BC 6.1-front — FL+FR+LFE+FLC+FRC+SL+SR 7.0 — FL+FR+FC+BL+BR+SL+SR 7.0-front — FL+FR+FC+FLC+FRC+SL+SR 7.1 — FL+FR+FC+LFE+BL+BR+SL+SR 7.1-wide — FL+FR+FC+LFE+BL+BR+FLC+FRC 7.1-wide-side — FL+FR+FC+LFE+FLC+FRC+SL+SR octagonal — FL+FR+FC+BL+BR+BC+SL+SR * downmix — DL+DR
- ouput audio channel params
- input audio channel params
- output audio channel params
id	Input audio channel ID	Input channel ID in format [track_id]:[channel_id]
gain	Input audio channel gain level	Float positive number from 0 to 1	1
id	Output channel ID	Channel number or one of these channel names: FL — front left FR — front right FC — front center LFE — low frequency BL — back left BR — back right FLC — front left-of-center FRC — front right-of-center BC — back center SL — side left SR — side right TC — top center TFL — top front left TFC — top front center TFR — top front right TBL — top back left TBC — top back center TBR — top back right DL — downmix left DR — downmix right WL — wide left WR — wide right SDL — surround direct left SDR — surround direct right * LFE2 — low frequency 2

merge_small_segments

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>[Action]</action> <!-- required-->
    <format>
        <!-- Format fields -->
        <output>advanced_hls</output>
        <merge_small_segments>[yes|no]</merge_small_segments>
    </format>
</query>

{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "action": "[Action]",
        "format": {
            "output": "advanced_hls",
            "merge_small_segments": "[yes|no]"
        }
    }
}

Field Name	Description	Allowed Values	Default Values
merge_small_segments	Merge last chunk with previous one if its length less than 1 second.	yes, no	no

sub_path and media_path

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>[Action]</action> <!-- required-->
    <format>
        <!-- Format fields -->
        <output>advanced_hls</output>
        <stream>
            <sub_path>[Playlist sub path]</sub_path>
            <media_path>[Playlist sub path]</media_path>
        </stream>
    </format>
</query>

{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "action": "[Action]",
        "format": {
            "output": "advanced_hls",
            "stream": {
                "sub_path": "[Playlist sub path]",
                "media_path": "[Playlist sub path]"
            }
        }
    }
}

Field Name	Description	Allowed Values	Default Values
sub_path	Stream manifest and media files location relative path	valid pathname	None
media_path	Media files location path relative to the <sub_path>	valid pathname	None