Other Format Options

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

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>addMedia</action>
    <source>[SourceFile]</source> <!-- required-->
    <format> <!-- required -->
        <output>[output]</output> <!-- required -->
        <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>
        <stream_id_mapping>[IDMapping]</stream_id_mapping>
        <transport_stream_id>[TsID]</transport_stream_id>
        <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": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "addMedia", // required
        "source": "[SourceFile]", // required
        "format": {
            "output": "[output]", // required
            "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]",
            "stream_id_mapping": "[IDMapping]",
            "transport_stream_id": "[TsID]",
            "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
        }
    }
}

Parameter

Description

Allowed Values

Default Value

profile

This defines various sets of capabilities which are referred to as profiles, that target specific classes of applications.

high, main, baseline

fl9, mpeg4, flv: high
mp4, m4v: main
ipod, iphone, ipad, 3gp, psp: baseline

encoder

Specify which version of Encoding.com's engine to use.

v1, v3, edc1

v1

two_pass

Enable or disable two_pass encoding.

yes, no

no

two_pass_decoding

Decode to a lossless format prior to encoding to reduce errors.

1

none

bufsize

Specify the rate control buffer size in bits.

N or Nk – where N is any non-zero integer

none

rc_init_occupancy

Specify the initial rate control buffer occupancy in bits.

N or Nk – where N is any non-zero integer`

none

deinterlacing

Enable 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_interlaced

Specify the interlaced encoding type. Only works with MPEG-TS.

available formats: tff, bff, no
mxf: tff, bff, source, no

no

add_meta

Adds meta data to the file. Only works with FLV.

yes, no

All: none
flv: no

hint

Add RTP data (for streaming servers). Only works with MP4.

yes, no

All: none
mp4: no

preset

Specify 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

bframes

Specify the bframes format.

2 [on = IBBPBBP], 0 [off = IPPPPPP]

2

gop

Specify the group of picture format.

sgop [Strict (Locked)], cgop [Closed (Scene Detection)]

cgop

luma_spatial

Specify the spatial luma strength.

Positive integer from 0 to 255.

4

chroma_spatial

Specify the spatial chroma strength.

Positive integer from 0 to 255.

3

luma_temp

Specify the temporal luma strength.

Positive integer from 0 to 255.

6

strip_chapters

Strip the chapters markers.

yes, no

no

vidly_hls

Enables the HLS format for Vidly Lite outputs.

yes, no

no

vidly_hd

Enables HD button in Vid.ly player. High Definition (720p) videos will be generated.

yes, no

no

hard_cbr

Specify HRD information and pack the bitstream to the specified bitrate.

yes, no

no

pix_format

Specify the pixel format – ability to lock output to YUV420p colorspace.

yuv420p, yuv422p, yuvj420p, yuvj422p, source

yuv420p

best_quality

Specify the best quality mode (very slow) – dnxhd output only

yes, no

no

interlaced

Enable interlacing for dnxhd output only.

yes, no

no

copy_timestamps

Do not process input timestamps, but keep their values without trying to generate them.

yes, no

yes

slices

Specify the number of slices, used in parallelized encoding.

Positive Integer

none

speed

Specify the speed of video correction

Positive 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_matrix

Scaler Input Color Matrix

auto, bt601, bt740, smpte170m, bt709, fcc, smpte240m, bt2020

none

scale_out_color_matrix

Scaler Output Color Matrix

auto, bt601, bt740, smpte170m, bt709, fcc, smpte240m, bt2020

none

alpha_channel

Pass through alpha channel from source file

yes, no

no

black_padding_start

Prepends a specified number of black frames before video

Positive integer number

0

black_padding_end

Appends a specified number of black frames after video

Positive integer number

0

stream_id_mapping

Container stream id metadata mapping

Comma separated list of id pairs separated by colon.
E.g
[SourceID_1]:[OutputID_1],[SourceID_2]:[Output_ID2]

none

transport_stream_id

MPEG-TS Transport Stream ID

Hex number

none

Telecine Parameters

first_field

Interlaced type

top, bottom

top

pattern

Pulldown Pattern

string with digits

23

ATA Denoise Parameters

a0

Threshold A for 1st plane

Float number between 0 and 0.3

0.02

b0

Threshold B for 1st plane

Float number between 0 and 5

0.04

a1

Threshold A for 2nd plane

Float number between 0 and 0.3

0.02

b1

Threshold B for 2nd plane

Float number between 0 and 5

0.04

a2

Threshold A for 3rd plane

Float number between 0 and 0.3

0.02

b2

Threshold B for 3rd plane

Float number between 0 and 5

0.04

s

Number of frames that will be used for averaging.

Odd positive integer number.

9

p

What 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.