This is a complete request for our advanced ABR 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|advanced_dash|advanced_mss|fmp4_hls|advanced_fmp4]</output> <!-- required-->
<destination>[DestFile]</destination> <!-- required-->
<stream>
<!-- Video settings params -->
<profile>[high|main|baseline]</profile>
<!-- Audio settings params -->
<!-- Other format params -->
<!-- Editing features params -->
<still_image>[no|each_segment|first_segment]</still_image>
<still_image_time>[Time]</still_image_time>
<still_image_size>[Size]</still_image_size>
<byte_range>[yes|no]</byte_range>
<add_iframe_stream>[yes|no]</add_iframe_stream>
<audio_only>[yes|no]</audio_only>
<video_only>[yes|no]</video_only>
<group_id>[GroupID]</group_id>
<use_group_id>[CommaSeparatedList]</use_group_id>
<playlist_version>[Valid EXT-X-VERSION]</playlist_version>
<sub_path>[Playlist sub path]</sub_path>
<media_path>[Playlist sub path]</media_path>
<use_alternate_id>[AlternateSourceIndex0]</use_alternate_id>
<!-- Multiple alternate source ids may be included in stream -->
<use_alternate_id>[AlternateSourceIndexN]</use_alternate_id>
<track_type>[Type]</track_type>
<hdcp_level>[no|none|0|1]</hdcp_level>
<align_audio_segments_to_framerate>[FrameRate]</align_audio_segments_to_framerate>
<additional_alternate_id>[AlternateID_1]</additional_alternate_id>
<additional_alternate_id>[AlternateID_2]</additional_alternate_id>
<!-- ... -->
<additional_alternate_id>[AlternateID_N]</additional_alternate_id>
<get_from_manifest>[yes|no]</get_from_manifest>
<audio_stream>
<!-- audio_stream params -->
<audio_stream>
<scaler_lib>[default|zscale]</scaler_lib>
<init_extension>[Extension]</init_extension>
<init_sub_path>[SubPath]</init_sub_path>
<init_base_name>[BaseName]</init_base_name>
</stream>
<!-- Multiple stream params may be included in output format -->
<!-- Maximum number of available streams is 15 -->
<stream>
<!-- stream params -->
</stream>
<manifest>
<basename>[BaseName]</basename> <!-- required-->
<sources>[ManifestSource1]</sources>
<sources>[ManifestSource2]</sources>
<!-- ... -->
<sources>[ManifestSourceN]</sources>
<sub_path>[SubPath]</sub_path>
<add_cea_cc_channels>[CCChannels]</add_cea_cc_channels>
</manifest>
<manifest>
<!-- manifest params -->
</manifest>
<!-- Multiple manifests may be included -->
<main_source>
<type>[video_audio|video|audio]</type>
<video_name>[Name]</video_name>
<audio_name>[Name]</audio_name>
<use_stream_id>[CommaSeparatedList]</use_stream_id>
<language>[Language]</language>
<role>[MainSourceRole]</role>
</main_source>
<alternate_source>
<source>[FileURL]</source>
<type>[video_audio|video|audio]</type>
<video_name>[Name]</video_name>
<audio_name>[Name]</audio_name>
<use_stream_id>[CommaSeparatedList]</use_stream_id>
<language>[Language]</language>
<auto>[yes|no]</auto>
<dvs>[yes|no]</dvs>
<characteristics>[Characteristics]</characteristics>
<accessibility_scheme>[Scheme]</accessibility_scheme>
<accessibility_value>[Value]</accessibility_value>
<natural_order>[yes|no]</natural_order>
<sub_path>[SubPath]</sub_path>
<get_from_manifest>[yes|no]</get_from_manifest>
<add_to_manifest>[ManifestsList]</add_to_manifest>
<role>[AlternateSourceRole]</role>
<program_id>[ProgramID]</program_id>
</alternate_source>
<alternate_source>
<source>[FileURL]</source> <!-- ADM BWF File -->
<type>audio</type>
<audio_name>[Name]</audio_name>
<sub_path>[SubPath]</sub_path>
<!-- alternate_source params -->
</alternate_source>
<alternate_source>
<source>[FileURL]</source> <!-- DAMF Atmos File -->
<damf_audio>[DAMFAudioURL]</damf_audio>
<damf_metadata>[DAMFMetadataURL]</damf_metadata>
<type>audio</type>
<audio_name>[Name]</audio_name>
<sub_path>[SubPath]</sub_path>
<!-- alternate_source params -->
</alternate_source>
<alternate_source>
<!-- alternate_source params -->
</alternate_source>
<!-- multiple alternate_sources may be included -->
<image_media_playlist>
<!-- image_media_playlist doesn't work with advanced_mss -->
<interval>[ImageInterval]</interval>
<size>[ImageSize]</height>
<width>[ImageWidth]</width>
<height>[ImageHeight]</height>
<layout>[ImagesLayout]</layout>
<max_columns>[ColumnsPerTile]</max_columns>
<max_rows>[RowsPerTile]</max_rows>
<basename>[BaseName]</basename>
<sub_path>[SubPath]</sub_path>
<no_ext_x_tiles>[yes|no]</no_ext_x_tiles>
<segment_timeline>[yes|no]</segment_timeline>
<timescale>[Timescale]</timescale>
<add_to_manifest>[ManifestsList]</add_to_manifest>
<break_points>[default|adbreaks]</break_points>
<offset>[Offset]</offset>
<get_from_manifest>[yes|no]</get_from_manifest>
</image_media_playlist>
<image_media_playlist>
<!-- image_media_playlist params -->
</image_media_playlist>
<!-- multiple image_media_playlist may be included -->
<!-- format params -->
<duration_precision>[Number]</duration_precision>
<segment_duration>[Duration]</segment_duration>
<pack_files>[yes|no]</pack_files>
<pack_type>[tar|zip]</pack_type>
<pack_each_stream>[yes|no]</pack_each_stream>
<encryption>[yes|no]</encryption>
<encryption_method>[EncryptionMethod]</encryption_method>
<encryption_key>[128bit-key]</encryption_key>
<encryption_key_file>[SourceURL]</encryption_key_file>
<encryption_iv>[Hexidecimal string]</encryption_iv>
<segmenter>[v1|v2|v3|dolby_segmenter]</segmenter>
<playlist_version>[Valid EXT-X-VERSION]</playlist_version>
<merge_small_segments>[yes|no]</merge_small_segments>
<output_json>[yes|OutputJSONURL_1]</output_json>
<output_json>[yes|OutputJSONURL_2]</output_json>
<!-- ... -->
<output_json>[yes|OutputJSONURL_N]</output_json>
<!-- multiple output_json parameters may be included -->
<disable_alternate_source_index>[yes|no]</disable_alternate_source_index>
</format>
</query>
{
"query": {
"userid": "<<id>>", // required
"userkey": "<<key>>", // required
"action": "[Action]", // required
"source": "[SourceFile]", // required
"format": {
"output": "[advanced_hls|advanced_dash|advanced_mss|fmp4_hls|advanced_fmp4]", // required
"destination": "[DestFile]", // required
"stream": [
{
// Video settings params
"profile": "[high|main|baseline]",
// Audio settings params
// Other format params
// Editing features params
"still_image": "[no|each_segment|first_segment]",
"still_image_time": "[Time]",
"still_image_size": "[Size]",
"byte_range": "[yes|no]",
"add_iframe_stream": "[yes|no]",
"audio_only": "[yes|no]",
"video_only": "[yes|no]",
"group_id": "[GroupID]",
"use_group_id": "[CommaSeparatedList]",
"playlist_version": "[Valid EXT-X-VERSION]",
"sub_path": "[Playlist sub path]",
"media_path": "[Playlist sub path]",
"use_alternate_id": [
"[AlternateSourceIndex0]",
"[AlternateSourceIndexN]"
// Multiple alternate source ids may be included in stream
],
"track_type": "[Type]",
"hdcp_level": "[no|none|0|1]",
"align_audio_segments_to_framerate": "[FrameRate]",
"additional_alternate_id": [
"[AlternateID_1]",
"[AlternateID_2]",
// ...
"[AlternateID_N]"
],
"get_from_manifest": "[yes|no]",
"audio_stream": {
// audio_stream params
},
"scaler_lib": "[default|zscale]",
"init_extension": "[Extension]",
"init_sub_path": "[SubPath]",
"init_base_name": "[BaseName]"
},
{
// stream params
}
// Multiple stream params may be included in output format
// Maximum number of available streams is 15
],
"manifest": [
{
"basename": "[BaseName]", // required
"sources": [
"[ManifestSource1]",
"[ManifestSource2]",
// ...
"[ManifestSourceN]"
],
"sub_path": "[SubPath]",
"add_cea_cc_channels": "[CCChannels]"
},
{
// manifest params
}
// Multiple manifests may be included
],
"main_source": {
"type": "[video_audio|video|audio]",
"video_name": "[Name]",
"audio_name": "[Name]",
"use_stream_id": "[CommaSeparatedList]",
"language": "[Language]",
"role": "[MainSourceRole]"
},
"alternate_source": [
{
"source": "[FileURL]",
"type": "[video_audio|video|audio]",
"video_name": "[Name]",
"audio_name": "[Name]",
"use_stream_id": "[CommaSeparatedList]",
"language": "[Language]",
"auto": "[yes|no]",
"dvs": "[yes|no]",
"characteristics": "[Characteristics]",
"accessibility_scheme": "[Scheme]",
"accessibility_value": "[Value]",
"natural_order": "[yes|no]",
"sub_path": "[SubPath]",
"get_from_manifest": "[yes|no]",
"add_to_manifest": "[ManifestsList]",
"role": "[AlternateSourceRole]",
"program_id": "[ProgramID]"
},
{
"source": "[FileURL]", // ADM BWF File
"type": "audio",
"audio_name": "[Name]",
"damf_audio": "[DAMFAudioURL]",
"damf_metadata": "[DAMFMetadataURL]",
"sub_path": "[SubPath]"
// alternate_source params
},
{
"source": "[FileURL]", // DAMF Atmos File
"damf_audio": "[DAMFAudioURL]",
"damf_metadata": "[DAMFMetadataURL]",
"type": "audio",
"audio_name": "[Name]",
"sub_path": "[SubPath]"
// alternate_source params
},
{
// alternate_source params
}
// multiple alternate_sources may be included
],
"image_media_playlist": [
// image_media_playlist doesn't work with advanced_mss
{
"interval": "[ImageInterval]",
"size": "[ImageSize]",
"width": "[ImageWidth]",
"height": "[ImageHeight]",
"layout": "[ImagesLayout]",
"max_columns": "[ColumnsPerTile]",
"max_rows": "[RowsPerTile]",
"basename": "[BaseName]",
"sub_path": "[SubPath]",
"no_ext_x_tiles": "[yes|no]",
"segment_timeline": "[yes|no]",
"timescale": "[Timescale]",
"add_to_manifest": "[ManifestsList]",
"break_points": "[default|adbreaks]",
"offset": "[Offset]",
"get_from_manifest": "[yes|no]"
},
{
// image_media_playlist params
}
// multiple image_media_playlist may be included
],
// format params
"duration_precision": "[Number]",
"segment_duration": "[Duration]",
"pack_files": "[yes|no]",
"pack_type": "[tar|zip]",
"pack_each_stream": "[yes|no]",
"encryption": "[yes|no]",
"encryption_method": "[EncryptionMethod]",
"encryption_key": "[128bit-key]",
"encryption_key_file": "[SourceURL]",
"encryption_iv": "[Hexidecimal string]",
"segmenter": "[v1|v2|v3|dolby_segmenter]",
"playlist_version": "[Valid EXT-X-VERSION]",
"merge_small_segments": "[yes|no]",
"output_json": [
"[yes|OutputJSONURL_1]",
"[yes|OutputJSONURL_2]",
// ...
"[yes|OutputJSONURL_N]"
// multiple output_json parameters may be included
],
"disable_alternate_source_index": "[yes|no]"
}
}
}
For image_media_playlist parameters
The <image_media_playlist /> parameter is incompatible with the advanced_mss output format.
For no_ext_x_tiles
The <no_ext_x_tiles /> parameter of <image_media_playlist /> is only available for advanced_hls, fmp4_hls, and HLS manifests of advanced_fmp4 output formats.
For align_audio_segments_to_framerate
The <align_audio_segments_to_framerate /> is only available for advanced_hls, advanced_dash, and advanced_fmp4 output formats.
The <align_audio_segments_to_framerate /> only appliable if <audio_only /> set to yes in the block.
For advanced_hls output format media should have <multijob_workflow /> set to yes, or <pack_audio_to_mpegts /> set to yes.
For break_points
The <break_points /> applieable only if <segment_timeline /> set to yes.
For damf_audio and damf_metadata
The <damf_audio /> and <damf_metadata /> parameters available only for advanced_dash, advanced_fmp4, and fmp4_hls output formats.
For additional_alternate_id
The <additional_alternate_id /> parameter is only available for advanced_hls, fmp4_hls, and HLS manifests of advanced_fmp4 output formats.
For get_from_manifest
The <get_from_manifest /> parameter available only if manifest <sources /> are specified.
For add_cea_cc_channels
The <add_cea_cc_channels /> parameter is only available for advanced_hls, fmp4_hls, and HLS manifests of advanced_fmp4 output formats.
For init_extension, init_sub_path, and init_base_name
The <init_extension />, <init_sub_path />, and <init_base_name /> parameters are only available for advanced_dash, fmp4_hls, and advanced_fmp4 output formats.