Home » API Reference » Encoding Settings

All Parameters | VOD Parameters | Live Parameters Encoding Settings

Job

Setting Default Description
api_key none The API key for your Zencoder account.
input none An HTTP, S3, Cloud Files, GCS, FTP, FTPS, SFTP, or Aspera URL where we can download file to transcode.
live_stream false Create a Live streaming job.
outputs none An array or hash of output settings.
region us The region where a file is processed: US, Europe, Asia, or Australia.
test false Enable test mode ("Integration Mode") for a job.
private false Enable privacy mode for a job.
download_connections 5 Utilize multiple, simultaneous connections for download acceleration (in some circumstances).
pass_through none Optional information to store alongside this job.
mock false Send a mocked job request.
grouping none A report grouping for this job.
aspera_transfer_policy fair How to allocate available bandwidth for Aspera file transfers.
transfer_minimum_rate 1000 A targeted rate in Kbps for data transfer minimums.
transfer_maximum_rate 250000 A targeted rate in Kbps for data transfer maximums.
expected_md5_checksum none The expected checksum of the input file.
credentials none References saved credentials by a nickname.

General Output Settings

Setting Default Description
type standard The type of file to output.
label none An optional label for this output.
url none A S3, Cloud Files, GCS, FTP, FTPS, SFTP, Aspera, HTTP, or RTMP URL where we'll put the transcoded file.
secondary_url none A S3, Cloud Files, GCS, FTP, FTPS, SFTP, HTTP, RTMP, Aspera, or syndication URL where we'll put the transcoded file.
base_url none A base S3, Cloud Files, GCS, FTP, FTPS, SFTP, or Aspera directory URL where we'll put the transcoded file, without a filename.
filename none The filename of a finished file.
package_filename none The filename of a packaged output.
package_format none Zip/packaging format to use for the output file(s).
device_profile none A device profile to use for mobile device compatibility.
strict false Enable strict mode.
skip_video false Do not output a video track.
skip_audio false Do not output an audio track.
source none References a label on another job and uses the video created by that output for processing instead of the input file.
credentials none References saved credentials by a nickname.
generate_md5_checksum false Generate an MD5 checksum of the output file.
parallel_upload_limit 30 for S3, 10 for all other destinations. The maximum number of simultaneous uploads to attempt.
headers none HTTP headers to send with your file when we upload it.

Format And Codecs

Setting Default Description
format Determined by the output filename and then video or audio codec. Otherwise: mp4 (for standard outputs); ts (for segmented outputs). The output format to use.
video_codec Determined by the format, profile, or audio_codec. h264 if none are provided. The video codec to use.
audio_codec Determined by the format, profile, or video_codec. aac if none are provided. The audio codec to use.

Resolution

Setting Default Description
size none The resolution of the output video (WxH, in pixels).
width none The maximum width of the output video (in pixels).
height none The maximum height of the output video (in pixels).
upscale false Upscale the output if the input is smaller than the target output resolution.
aspect_mode preserve What to do when aspect ratio of input file does not match the target width/height aspect ratio.

Rate Control

Setting Default Description
quality 3 Autoselect the best video bitrate to to match a target visual quality.
video_bitrate none A target video bitrate in kbps. Not necessary if you select a quality setting, unless you want to target a specific bitrate.
audio_quality 3 Autoselect the best audio bitrate to to match a target sound quality.
audio_bitrate none A target audio bitrate in kbps. Not necessary if you select a audio_quality setting, unless you want to target a specific bitrate.
max_video_bitrate none A maximum average bitrate.
speed 3 A target transcoding speed. Slower encoding generally allows for more advanced compression.
decoder_bitrate_cap none Max bitrate fed to decoder buffer. Typically used for video intended for streaming, or for targeting specific devices (e.g. Blu-Ray).
decoder_buffer_size none Size of the decoder buffer, used in conjunction with bitrate_cap.
one_pass false Force one-pass encoding.
audio_constant_bitrate false Enable constant bitrate mode for audio if possible.

Frame Rate

Setting Default Description
frame_rate The original (input) frame rate. The frame rate to use.
max_frame_rate none The maximum frame rate to use.
decimate none Reduce the input frame rate by a divisor.
keyframe_interval 250 The maximum number of frames between each keyframe.
keyframe_rate keyframe_interval of 250 The number of keyframes per second.
fixed_keyframe_interval false Enable fixed keyframe interval mode (VP6 and H.264 only).
forced_keyframe_interval none Force keyframes at the specified interval (H.264 only).
forced_keyframe_rate none Specify the number of keyframes per-second, taking frame rate into account (H.264 only).

Audio

Setting Default Description
audio_sample_rate none The audio sample rate, in Hz.
max_audio_sample_rate none The max audio sample rate, in Hz.
audio_channels 1 if the original file is mono; otherwise, 2. The number of audio channels: 1 or 2.

Thumbnails

Setting Default Description
thumbnails none Capture thumbnails for a given video.
label none A label to identify each set of thumbnail groups.
format png The format of the thumbnail image.
number none A number of thumbnails, evenly-spaced.
start_at_first_frame false Start generating the thumbnails starting at the first frame.
interval none Take thumbnails at an even interval, in seconds.
interval_in_frames none Take thumbnails at an even interval, in frames.
times none An array of times, in seconds, at which to grab a thumbnail.
aspect_mode preserve How to handle a thumbnail width/height that differs from the aspect ratio of the input file.
size none Thumbnail resolution as WxH.
width none The maximum width of the thumbnail (in pixels).
height none The maximum height of the thumbnail (in pixels).
base_url none A base S3, Cloud Files, GCS, FTP, FTPS, or SFTP directory URL where we'll place the thumbnails, without a filename.
prefix frame Prefix for thumbnail filenames.
filename frame Interpolated thumbnail filename.
public false Make the output publicly readable on S3.
access_control none Fine-grained access control rules for files sent to S3.
grantee none Set the grantee for fine-grained S3 access_control permissions.
permission none Set the permission for a grantee when using fine-grained access_control.
rrs false Amazon S3's Reduced Redundancy Storage.
headers none HTTP headers to send with your thumbnails when we upload them.
credentials none References saved credentials by a nickname.
parallel_upload_limit 30 for S3, 10 for all other destinations. The maximum number of simultaneous uploads to attempt.

Watermarks

Setting Default Description
watermarks none Add one or more watermarks to an output video.
url none The URL of a remote image file to use as a watermark.
x -10 Where to place a watermark, on the x axis.
y -10 Where to place a watermark, on the y axis.
width Scale to height, or original image width. The scaled width of a watermark.
height Scale to width, or original image height. The scaled height of a watermark.
origin content Which part of the output to base the watermark position on.
opacity 1.0 Make the watermark transparent.

Captions

Setting Default Description
caption_url none URL to an SCC, DFXP, or SAMI caption file to include in the output.
skip_captions false Don't add or pass through captions to the output file.

Live Streaming

Setting Default Description
live_stream false Create a live_stream job or output that is ready for playback within seconds.
reconnect_time 30 The time, in seconds, to wait for a stream to reconnect.
event_length none The minimum time, in seconds, to keep a live stream available.
live_sliding_window_duration 7200 The time, in seconds, to keep in the HLS playlist.

Video Processing

Setting Default Description
rotate automatically detected Rotate a video.
deinterlace detect Deinterlace input video.
sharpen false Apply a sharpen filter.
denoise none Apply denoise filter.
autolevel false Apply a color auto-level filter.
deblock false Apply deblock filter.

Audio Processing

Setting Default Description
audio_gain none Apply a gain amount to the audio, in dB.
audio_normalize false Normalize audio to 0dB.
audio_pre_normalize false Normalize the audio before applying expansion or compression effects.
audio_post_normalize false Normalize the audio after applying expansion or compression effects.
audio_bass none Increase or decrease the amount of bass in the audio.
audio_treble none Increase or decrease the amount of treble in the audio.
audio_highpass none Apply a high-pass filter to the audio.
audio_lowpass none Apply a low-pass filter to the audio.
audio_compression_ratio none Compress the dynamic range of the audio.
audio_compression_threshold -20 Compress the dynamic range of the audio.
audio_expansion_ratio none Expand the dynamic range of the audio.
audio_expansion_threshold -35 Expand the dynamic range of the audio.
audio_fade none Apply fade-in and fade-out effects to the audio.
audio_fade_in none Apply a fade-in effect to the audio.
audio_fade_out none Apply a fade-out effect to the audio.
audio_karaoke_mode false Apply a karaoke effect to the audio.

Clips

Setting Default Description
start_clip none Encode only a portion of the input file by setting a custom start time.
clip_length none Encode only a portion of the input file by setting a custom clip length.

S3 Settings

Setting Default Description
public false Make the output publicly readable on S3.
rrs false Amazon S3's Reduced Redundancy Storage.
access_control none Fine-grained access control rules for files sent to S3.
grantee none Set the grantee for fine-grained S3 access_control permissions.
permission none Set the permission for a grantee when using fine-grained access_control.

Notifications

Setting Default Description
notifications none Be notified when a job or output is complete.
url none Be notified when a job or output is complete.
format none A format and content type for notifications.
headers none Headers to pass along on HTTP notifications.
event none The event that triggers a notification. Used for Instant Play.

Conditional Outputs

Setting Default Description
min_size none Skip output if the input file is smaller than the given dimensions.
max_size none Skip output if the input file is larger than the given dimensions.
min_duration none Skip output if the input file is shorter than the given duration, in seconds.
max_duration none Skip output if the input file is longer than the given duration, in seconds.

Segmented Streaming

Setting Default Description
segment_seconds 10 Sets the maximum duration of each segment a segmented output
segment_size none Sets the maximum data size of each segment in a segmented output
streams none Provides a list of stream info to be reformatted as a playlist
path none Specifies the path to a stream manifest file
bandwidth none Specifies the bandwidth of a playlist stream
resolution none Specifies the resolution of a playlist stream
codecs none Specifies the codecs used in a playlist stream
segment_image_url none An image to display on audio-only segments
segment_video_snapshots false When segmenting a video file into audio-only segments, take snapshots of the video as thumbnails for each segment.
source none References a label on another job and uses the video created by that output for processing instead of the input file.
max_hls_protocol_version 3 for Live and Instant Play outputs; otherwise, 2. The maximum HLS protocol to use.
hls_optimized_ts true Optimize TS segment files for HTTP Live Streaming on iOS.
prepare_for_segmenting none Include captions and keyframe timing for segmenting.
instant_play false Create an instant play output that is ready for playback within seconds.
smil_base_url none Add <meta base="smil_base_url_value"/> to the <head> section of an SMIL playlist.

Encryption

Setting Default Description
encryption_method none Set the encryption method to use for encrypting.
encryption_key none Set a single encryption key to use rather than having Zencoder generate one
encryption_key_url none Set a URL to a single encryption key to use rather than having Zencoder generate one
encryption_key_rotation_period none Rotate to a new encryption key after a number of segments
encryption_key_url_prefix none Prepend key URLs with the passed string
encryption_iv none Set an initialization vector to use when encrypting
encryption_password none Sets a password to use for generating an initialization vector

Decryption

Setting Default Description
decryption_method aes-128 (if decryption_key or decryption_key_url are set) Set the decryption algorithm to use.
decryption_key none Set the decryption key to use.
decryption_key_url none The URL of a decryption key file to use.
decryption_password none The password used in combination with the key to decrypt the input file.

H.264

Setting Default Description
h264_reference_frames 3 A number of reference frames to use in H.264 video.
h264_profile baseline The H.264 profile to use.
h264_level Automatically calculated using H.264 level chart based on the output video. The H.264 level to use.
h264_bframes 0 The maximum number of consecutive B-frames.
tuning none Tune the output video for a specific content type.
crf none Bitrate control setting.

FLV

Setting Default Description
cue_points none Add event or navigation cue points to a FLV video.
type none A cue point type.
time none A cue point time, in seconds.
name none A cue point name.
data none Cue point data.

VP6

Setting Default Description
vp6_temporal_down_watermark 20 VP6 temporal down watermark percentage.
vp6_temporal_resampling True when encoding with a low number of bits per pixel. Otherwise, false. Enable or disable VP6 temporal resampling.
vp6_undershoot_pct 90 Target a slightly lower datarate.
vp6_profile vp6e VP6 profile: vp6s or vp6e.
vp6_compression_mode good VP6 compression mode: good or best.
vp6_2pass_min_section 40 For two-pass VBR encoding, the lowest datarate that the encoder will allow.
vp6_2pass_max_section 400 For two-pass VBR encoding, the highest datarate that the encoder will allow.
vp6_stream_prebuffer 6 Seconds of preload that are necessary before starting playback.
vp6_stream_max_buffer none Maximum decoder buffer size
vp6_deinterlace_mode adaptive Deinterlace mode for VP6
vp6_denoise_level 0 Denoise level for VP6
alpha_transparency false Enable alpha transparency. Currently, only supported by VP6.
constant_bitrate false Use constant bitrate (CBR) encoding.

MP4

Setting Default Description
hint false Enable hinting of MP4 files for RTP/RTSP.
mtu_size 1450 Set MTU size for MP4 hinting.

AAC

Setting Default Description
max_aac_profile he-aac What is the most advanced (compressed) AAC profile to allow?
force_aac_profile none Force the use of a particular AAC profile, rather than letting Zencoder choose the best profile for the bitrate.

Aspera

Setting Default Description
aspera_transfer_policy fair How to allocate available bandwidth for Aspera file transfers.
transfer_minimum_rate 1000 A targeted rate in Kbps for data transfer minimums.
transfer_maximum_rate 250000 A targeted rate in Kbps for data transfer maximums.

Transmuxing

Setting Default Description
copy_video false Copy the video track of the input file
copy_audio false Copy the audio track of the input file