07 June 2018

FMP4 Timescale

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>[Action]</action> <!-- required-->
    <format>
        <output>[fmp4_hls|advanced_dash|advanced_mss|advanced_fmp4]</output>
        <stream>
            <timescale>[TimeScale]</timescale>
        </stream>
    </format>
</query>

{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "action": "[Action]",
        "format": {
            "output": "[fmp4_hls|advanced_dash|advanced_mss|advanced_fmp4]",
            "stream": {
                "timescale": "[TimeScale]"
            }
        }
    }
}

Field Name	Description	Allowed Values	Default Values
timescale	set FMP4 timescale	Non negative integer number.
Note:	timescale feature available only for advanced_dash, fmp4_hls, advanced_fmp4, advanced_mss output formats

CMAF Conformant

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>[Action]</action> <!-- required-->
    <format>
        <output>[fmp4_hls|advanced_dash|advanced_mss|advanced_fmp4]</output>
        <cmaf_conformant>[yes|no]</cmaf_conformant>
    </format>
</query>

{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "action": "[Action]",
        "format": {
            "output": "[fmp4_hls|advanced_dash|advanced_mss|advanced_fmp4]",
            "cmaf_conformant": "[yes|no]"
        }
    }
}

Field Name	Description	Allowed Values	Default Values
cmaf_conformant	produce CMAF conformant output	yes, no	no
Note:	cmaf_conformant feature available only for advanced_dash, fmp4_hls, advanced_fmp4, advanced_mss output formats

Playready DRM for HLS

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>[Action]</action> <!-- required-->
    <format>
        <output>[advanced_hls|fmp4_hls]</output>
        <stream>
            <manifest>
                <playready_drm>[yes|no]</playready_drm>
            </manifest>
        </stream>
    </format>
</query>

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

Field Name	Description	Allowed Values	Default Values
playready_drm	Protect with Playready DRM	yes, no	no

BIF

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>[Action]</action> <!-- required-->
    <format>
        <output>[advanced_hls|fmp4_hls|advanced_dash]</output>
        <bif>[yes|no]</bif>
        <bif_destination>[BIFDestination1]</bif_destination>
        <!-- Multiple BIF destinations may be included -->
        <bif_destination>[BIFDestinationN]</bif_destination>
    </format>
</query>

{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "action": "[Action]",
        "format": {
            "output": "[advanced_hls|fmp4_hls|advanced_dash]",
            "bif": "[yes|no]",
            "bif_destination": [
                "[BIFDestination1]",
                "[BIFDestinationN]"
            ]
        }
    }
}

Field Name	Description	Allowed Values	Default Values
bif	produce BIF files	yes, no	no
bif_destination	BIF files destination	Valid destination URL. If it's not specified BIF files will be uploaded to the same destination as manifest.
Note:	bif and bif_destination features available only for advanced_hls, fmp4_hls, advanced_dash output formats

VTT thumbnails advanced_dash option

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>[Action]</action> <!-- required-->
    <format>
        <output>advanced_dash</output>
        <vtt_thumbnail>
           <interval>[ThumbnailInterval]</interval>
           <width>[ThumbnailWidth]</width>
           <height>[ThumbnailHeight]</height>
           <max_columns>[ColumnsPerTile]</max_columns>
           <max_rows>[RowsPerTile]</max_rows>
        </vtt_thumbnail>
    </format>
</query>

{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "action": "[Action]",
        "format": {
            "output": "advanced_dash",
            "vtt_thumbnail": {
                "interval": "[ThumbnailInterval]",
                "width": "[ThumbnailWidth]",
                "height": "[ThumbnailHeight]",
                "max_columns": "[ColumnsPerTile]",
                "max_rows": "[RowsPerTile]"
            }
        }
    }
}

Field Name	Description	Allowed Values	Default Values
interval	Time interval between images in seconds or percentage rate	N - Positive float number greater than 0.01	11
N%- Positive float number
width	Image width	Non negative integer number	160
height	Image height	Non negative integer number
max_columns	Columns per tile	Non negative integer number
max_rows	Rows per tile	Non negative integer number

Additional VTT options for thumbnail output

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>[Action]</action> <!-- required-->
    <format>
        <output>thumbnail</output>
        <vtt_max_lines>[MaxLinesPerTile]</vtt_max_lines>
        <vtt_destination>[VTTDestination]</vtt_destination>
        <public_url>[PublicURL]</public_url>
        <public_vtt_url>[VTTManifestPublicURL]</public_vtt_url>
    </format>
</query>

{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "action": "[Action]",
        "format": {
            "output": "thumbnail",
            "vtt_max_lines": "[MaxLinesPerTile]",
            "vtt_destination": "[VTTDestination]",
            "public_url": "[PublicURL]",
            "public_vtt_url": "[VTTManifestPublicURL]"
        }
    }
}

Field Name	Description	Allowed Values
vtt_max_lines	Maximum count of lines per tile. In case more than one tile needed than set of tiles will be generated.	Non negative integer number
vtt_destination	VTT manifest file destination.	Valid Destination URL
public_url	Public URL to use in VTT manifest to point to tiles	Valid URL
public_vtt_url	Public URL to VTT manifest file	Valid URL

Video codec prores_ks for mov output

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>[Action]</action> <!-- required-->
    <format>
        <output>mov</output>
        <video_codec>prores_ks</video_codec>
    </format>
</query>

{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "action": "[Action]",
        "format": {
            "output": "mov",
            "video_codec": "prores_ks"
        }
    }
}

Field Name	Description	Allowed Values	Default Values
video_codec	Video codec	mov: mpeg4, libx264, xdcam, dvcpro, dvcpro50, dvcprohd, mjpeg, prores_ks, copy	mov: mpeg4

Multijob workflow for advanced_dash and fmp4_hls output formats

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>[Action]</action> <!-- required-->
    <source>[SourceSegment][SegmentDuration]</source>
    <!-- Multiple source segments -->
    <source>[SourceSegment][SegmentDuration]</source>
    <multijob_workflow>[yes|no]</multijob_workflow>
    <format>
        <output>[advanced_hls|fmp4_hls|advanced_dash]</output> <!-- required-->
    </format>
</query>

{
    "query": {
        "userid": "<<id>>",
        "userkey": "<<key>>",
        "action": "[Action]",
        "source": [
            "[SourceSegment][SegmentDuration]",
            "[SourceSegment][SegmentDuration]"
        ],
        "multijob_workflow": "[yes|no]",
        "format": {
            "output": "[advanced_hls|fmp4_hls|advanced_dash]"
        }
    }
}