Other Format Options

A variety of additional output configuration parameters can be found here.

<?xml version="1.0"?>
<query>
    <userid>[UserID]</userid> <!-- required-->
    <userkey>[UserKey]</userkey> <!-- required-->
    <action>[Action]</action>
    <source>[SourceFile]</source> <!-- required-->
    <format> <!-- required -->
        <output>[output]</output> <!-- required -->
        <destination>[DestinationPath]</destination> <!-- required for multi-bitrate formats
        and if reference_movie_alias set to non-default value
        and pack_files set to no -->
        <profile>[ProfileName]</profile>
        <encoder>[EncoderVersion]</encoder>
        <two_pass>[yes|no]</two_pass>
        <two_pass_decoding>[1|]</two_pass_decoding>
        <bufsize>[BufferSize]</bufsize>
        <rc_init_occupancy>[BufferOccupancy]</rc_init_occupancy>
        <deinterlacing>[yes|filter|no|auto]</deinterlacing>
        <force_interlaced>[InterlacedType]</force_interlaced>
        <add_meta>[yes|no]</add_meta>
        <hint>[yes|no]</hint>
        <preset>[WebMPreset]</preset>
        <bframes>[BFramesMode]</bframes>
        <!-- bframes option only available for mpeg2 output -->
        <gop>[GOPType]</gop>
        <luma_spatial>[SpatialLumaStrength]</luma_spatial>
        <chroma_spatial>[SpatialChromaStrength]</chroma_spatial>
        <luma_temp>[TemporalLumaStrength]</luma_temp>
        <strip_chapters>[yes|no]</strip_chapters>
        <vidly_hls>[yes|no]</vidly_hls>
        <vidly_hd>[yes|no]</vidly_hd>
        <hard_cbr>[yes|no]</hard_cbr>
        <pix_format>[PixFormat]</pix_format>
        <best_quality>[yes|no]</best_quality>
        <interlaced>[yes|no]</interlaced>
        <copy_timestamps>[yes|no]</copy_timestamps>
        <slices>[SlicesNumber]</slices>
        <speed>[SpeedCorrection]</speed>
        <scale_in_color_matrix>[ColorMatrix]</scale_in_color_matrix>
        <scale_out_color_matrix>[ColorMatrix]</scale_out_color_matrix>
        <alpha_channel>[yes|no]</alpha_channel>
        <black_padding_start>[FramesPadding]</black_padding_start>
        <black_padding_end>[FramesPadding]</black_padding_end>
        <black_padding_keyframe>[yes|no]</black_padding_keyframe>
        <stream_id_mapping>[IDMapping]</stream_id_mapping>
        <transport_stream_id>[TsID]</transport_stream_id>
        <intermediate_stitch_multijob>[yes|no]</intermediate_stitch_multijob>
        <reference_movie_alias>[0|2|3]</reference_movie_alias>
        <ommcp_repack>[yes|no]</ommcp_repack>
        <ommq_data>[name=value]</ommq_data>
        <pack_files>[yes|no]</pack_files>
        <dpp_metadata_file>[DPPFileURL]</dpp_metadata_file>
        <cut_before_speed>[yes|no]</cut_before_speed>
        <telecine>
            <first_field>[top|bottom]</first_field>
            <pattern>[PulldownPattern]</pattern>
        </telecine>
        <atadenoise>
            <a0>[AThresholdPane1]</a0>
            <b0>[BThresholdPane1]</b0>
            <a1>[AThresholdPane2]</a1>
            <b1>[BThresholdPane2]</b1>
            <a2>[AThresholdPane3]</a2>
            <b2>[BThresholdPane3]</b2>
            <s>[AveragingFramesNumber]</s>
            <p>[AveragingPlanes]</p>
        </atadenoise>
        <!-- format params -->
    </format>
</query>
{
    "query": {
        "userid": "[UserID]", // required
        "userkey": "[UserKey]", // required
        "action": "addMedia", // required
        "source": "[SourceFile]", // required
        "format": {
            "output": "[output]", // required
            "destination": "[DestinationPath]", // required for multi-bitrate formats
            // and if reference_movie_alias set to non-default value
            // and pack_files set to no
            "profile": "[ProfileName]",
            "encoder": "[EncoderVersion]",
            "two_pass": "[yes|no]",
            "two_pass_decoding": "[1|]",
            "bufsize": "[BufferSize]",
            "rc_init_occupancy": "[BufferOccupancy]",
            "deinterlacing": "[yes|filter|no|auto]",
            "force_interlaced": "[InterlacedType]",
            "add_meta": "[yes|no]",
            "hint": "[yes|no]",
            "preset": "[WebMPreset]",
            "bframes": "[BFramesMode]",
            // bframes option only available for mpeg2 output
            "gop": "[GOPType]",
            "luma_spatial": "[SpatialLumaStrength]",
            "chroma_spatial": "[SpatialChromaStrength]",
            "luma_temp": "[TemporalLumaStrength]",
            "strip_chapters": "[yes|no]",
            "vidly_hls": "[yes|no]",
            "vidly_hd": "[yes|no]",
            "hard_cbr": "[yes|no]",
            "pix_format": "[PixFormat]",
            "best_quality": "[yes|no]",
            "interlaced": "[yes|no]",
            "copy_timestamps": "[yes|no]",
            "slices": "[SlicesNumber]",
            "speed": "[SpeedCorrection]",
            "scale_in_color_matrix": "[ColorMatrix]",
            "scale_out_color_matrix": "[ColorMatrix]",
            "alpha_channel": "[yes|no]",
            "black_padding_start": "[FramesPadding]",
            "black_padding_end": "[FramesPadding]",
            "black_padding_keyframe": "[yes|no]",
            "stream_id_mapping": "[IDMapping]",
            "transport_stream_id": "[TsID]",
            "intermediate_stitch_multijob": "[yes|no]",
            "reference_movie_alias": "[0|2|3]",
            "ommcp_repack": "[yes|no]",
            "ommq_data": "[name=value]",
            "pack_files": "[yes|no]",
            "dpp_metadata_file": "[DPPFileURL]",
            "cut_before_speed": "[yes|no]",
            "telecine": {
                "first_field": "[top|bottom]",
                "pattern": "[PulldownPattern]"
            },
            "atadenoise": {
                "a0": "[AThresholdPane1]",
                "b0": "[BThresholdPane1]",
                "a1": "[AThresholdPane2]",
                "b1": "[BThresholdPane2]",
                "a2": "[AThresholdPane3]",
                "b2": "[BThresholdPane3]",
                "s": "[AveragingFramesNumber]",
                "p": "[AveragingPlanes]"
            }
            // format params
        }
    }
}
ParameterDescriptionAllowed ValuesDefault Value
profileThis defines various sets of capabilities which are referred to as profiles, that target specific classes of applications.high, main, baselinefl9, mpeg4, flv: high
mp4, m4v: main
ipod, iphone, ipad, 3gp, psp: baseline
encoderSpecify which version of Encoding.com's engine to use.v1, v3, edc1v1
two_passEnable or disable two_pass encoding.yes, nono
two_pass_decodingDecode to a lossless format prior to encoding to reduce errors.1none
bufsizeSpecify the rate control buffer size in bits.N or Nk – where N is any non-zero integernone
rc_init_occupancySpecify the initial rate control buffer occupancy in bits.N or Nk – where N is any non-zero integer`none
deinterlacingEnable de-interlacing.yes – force apply de-interlacing
filter – use ffmpeg de-interlacing filter
no – don't apply de-interlacing
auto – use de-interlacing if source's scan type is interlaced
auto
force_interlacedSpecify the interlaced encoding type. Only works with MPEG-TS.available formats: tff, bff, no
mxf: tff, bff, source, no
no
add_metaAdds meta data to the file. Only works with FLV.yes, noAll: none
flv: no
hintAdd RTP data (for streaming servers). Only works with MP4.yes, noAll: none
mp4: no
presetSpecify format preset. Only works with WebM.1 — 2-Pass Best Quality VBR Encoding
2 — 2-Pass Faster VBR Encoding
3 — 2-Pass VBR Encoding for Smooth Playback on Low-end Hardware
4 — 2-Pass CBR Encoding for Limited-bandwidth Streaming
5 — 2-Pass VBR Encoding for Noisy / Low-quality Input Source
6 — 1-Pass Good Quality VBR Encoding
7 — 1-Pass Fast VBR Encoding
8 — Real-time CBR Encoding and Streaming
6
bframesSpecify the bframes format.2 lock:parameter, 0
"data": {
2
gopSpecify the group of picture format.sgop k:parameters]
{
, cgop : {
"h-0": "Parameter"
cgop
luma_spatialSpecify the spatial luma strength.Positive integer from 0 to 255.4
chroma_spatialSpecify the spatial chroma strength.Positive integer from 0 to 255.3
luma_tempSpecify the temporal luma strength.Positive integer from 0 to 255.6
strip_chaptersStrip the chapters markers.yes, nono
vidly_hlsEnables the HLS format for Vidly Lite outputs.yes, nono
vidly_hdEnables HD button in Vid.ly player. High Definition (720p) videos will be generated.yes, nono
hard_cbrSpecify HRD information and pack the bitstream to the specified bitrate.yes, nono
pix_formatSpecify the pixel format – ability to lock output to YUV420p colorspace.all: yuv420p, yuv422p, yuvj420p, yuvj422p, yuv420p10le, yuv422p10le, yuv444p10le, source
qtrle: rgb24, rgb555be, argb, gray, source
all: yuv420p
qtrle: rgb24
best_qualitySpecify the best quality mode (very slow) – dnxhd output onlyyes, nono
interlacedEnable interlacing for dnxhd output only.yes, nono
copy_timestampsDo not process input timestamps, but keep their values without trying to generate them.yes, noyes
slicesSpecify the number of slices, used in parallelized encoding.Positive Integernone
speedSpecify the speed of video correctionPositive float number or percentage value
Number – output speed will be changed to match specified
number of frames per second
Percentage – output speed will be set to specified
percent of source media
none
scale_in_color_matrixScaler Input Color Matrixauto, bt601, bt740, smpte170m, bt709, fcc, smpte240m, bt2020none
scale_out_color_matrixScaler Output Color Matrixauto, bt601, bt740, smpte170m, bt709, fcc, smpte240m, bt2020none
alpha_channelPass through alpha channel from source fileyes, nono
black_padding_startPrepends a specified number of black frames before videoPositive integer number0
black_padding_endAppends a specified number of black frames after videoPositive integer number0
black_padding_keyframeAdd IDR frames to the end of appended black frames.
Prepended black frames always starts with IDR.
yes, noyes
stream_id_mappingContainer stream id metadata mappingComma separated list of id pairs separated by colon.
E.g
"data": {
: "h-0": "P,rameter",
: "h-1": "Des
none
transport_stream_idMPEG-TS Transport Stream IDHex numbernone
intermediate_stitch_multijobStitch adaptive intermediate program segments into single fileyes, nono
reference_movie_aliasReference Movie Alias Type.
If this parameter value set to non-default value then each output stream will be put to the separate file.
• 0 – None
• 2 – Apple. Stream files will be put to the same directory as index file.
• 3 – Omneon. Stream files will be put to the "media.dir" subdirectory.
0
ommcp_repackMake the output pass through ommcp tool (for special purposes).yes, nono
ommq_dataMake the output pass through ommq tool (to add specific omneon metadata).[N:]name=valuenone
pack_filesPack all MOV streams files in one tar fileyes, nono
dpp_metadata_fileDPP AS11 metadata fileValid URLnone
cut_before_speedCut source file before manipulating with speedyes, nono
Telecine Parameters
first_fieldInterlaced typetop, bottomtop
patternPulldown Patternstring with digits23
ATA Denoise Parameters
a0Threshold A for 1st planeFloat number between 0 and 0.30.02
b0Threshold B for 1st planeFloat number between 0 and 50.04
a1Threshold A for 2nd planeFloat number between 0 and 0.30.02
b1Threshold B for 2nd planeFloat number between 0 and 50.04
a2Threshold A for 3rd planeFloat number between 0 and 0.30.02
b2Threshold B for 3rd planeFloat number between 0 and 50.04
sNumber of frames that will be used for averaging.Odd positive integer number.9
pWhat planes of frame will be used for averaging all - all planes
positive integer number - planes count
none

🚧

For bframes parameter

Bframes option available only for mpeg2 output format!

🚧

For pix_format parameter

If 'source' specified as value, then <pix_format /> won't be added to format options.

🚧

For interlaced parameter

Bitrate for dnxhd output is specified separately and the default is 145m.

🚧

For alpha_channel

The <alpha_channel /> parameter available only for webm output format.

🚧

For transport_stream_id

The <transport_stream_id /> parameter available only for mpegts output format.

🚧

For force_interlaced

The <force_interlaced /> parameter available only for apple_prores, cablelabs_mpegts, dnxhd, dnxhd_mxf, hds, ipad, iphone, ipod, kindle_fire, mainconcept_mxf, mov, mov_prores, mp4, mpeg_dash, mpegts, mxf, psp, roku_1200, roku_1800, roku_2700, roku_800, roku_hls, smooth_streaming, wowza, wowza_multibitrate, wowza_multibitrate_mp4, advanced_hls, fmp4_hls, advanced_dash, advanced_fmp4, and advanced_mss output formats.

🚧

For reference_movie_alias and pack_files parameters

The <reference_movie_alias /> and <pack_files /> parameters supported only for the mov output format.

The <pack_files /> parameter will work only if <reference_movie_alias /> has non-default value.

If <reference_movie_alias /> parameter set to non-default value and <pack_files /> set to no then parameter becomes required.

🚧

For ommcp_repack parameter

The <ommcp_repack/> parameter available only for mov output format with non-default reference_movie_alias
`
🚧 For ommq_data parameter

The <ommcp_data/> parameter available only for mxf_op1a output format
`>
🚧 For dpp_metadata_file parameter

The <dpp_metadata_file/> parameter available only for mxf_as11 output format