Format Parameters

These are the general format parameters available for our adaptive outputs.

❗️

Note

Audio and video parameters aren’t applicable to the <format /> level and should instead be set in each <stream /> parameter.

Parameter

Description

Available Values

Default Value

duration_precision

Specify the number of decimal accuracy for the duration of the playlist file.

Integer

0

segment_duration

Specify the duration to split output into segment files, measured in seconds.

Positive float number

9.0

fragment_duration

Specify the duration of fMP4 fragment inside of segment file, measured in seconds.

Positive integer number

equals to <segment_duration />

pack_files

Specify whether to package output in compressed file.

yes, no

yes

pack_type

Specify the type of compressed file to package output.

tar, zip

tar

pack_each_stream

Specify whether or not to package each stream in its own file.

yes, no

no

encryption

Enable AES-128 encryption.

yes, no

no

encryption_method

Specify the encryption method used.

advanced_hls: aes-128-cbc, sample-aes
fmp4_hls: aes-128-cbc, mpeg_cbcs, mpeg_cens, mpeg_cbc1, mpeg_cenc
advanced_dash, advanced_mss, advanced_fmp4: mpeg_cbcs, mpeg_cens, mpeg_cbc1, mpeg_cenc

advanced_hls, fmp4_hls: aes-128-cbc
advanced_fmp4, advanced_dash, advanced_mss: mpeg_cenc

encryption_key

Specify the encryption key.

32 hexidecimal characters ([0-9a-f])

none

encryption_key_file

URL to encryption key file.

Valid URL.

none

encryption_iv

Specify the encryption initialization vector.

32 hexidecimal characters ([0-9a-f]).

aes-128-cbc – sequence number of the segment file,
sample-aes – randomly generated value

segmenter

Specify which segmenter to use.

v1 – This is the segmenter bundled with FFMPEG and carries significant overhead (as much as 27% with a 364kbps file or 17.3% with a 864kbps file!), and generated several warnings.
v2 – This is based on HTTP Live Segmenter tool. It carries with it the same overhead, but generates far fewer warnings.
v3 – This version, we call tsparser was built in-house from the ground up to be optimized for our cloud infrastructure. This has significantly less overhead (5.8% with a 364kbps file or 3.8% with a 864kbps file), and does not generate any warnings.
dolby_segmenter – Dolby Media Generator segmenter(dolby_segmenter) will update libfaac audio codec to dolby_aac, in case libfaac codec specified. In case copy specified as audio_codec then source audio codec will be tried. In case iframe stream requested then v3 segmenter wil be used.

playlist_version

Specify the version of the m3u8 playlist file.

Integer(EXT-X-VERSION)

none

merge_small_segments

Merge the next chunk with the previous chunk if previous length is less than one second.

yes, no

no

dash_profile

Specify which dash output profile to use.

ondemand — urn:mpeg:​dash:profile:isoff-on-demand:2011,
live — urn:mpeg:​dash:profile:isoff-live:2011,
live_static — live with [email protected]=static

ondemand

cmaf_conformant

This will create an output that is CMAF conformant.

yes, no

no

reduce_structural_overhead

Perform reducing mpeg-ts structural overhead.

yes, no

yes

add_audio_only

Add an audio only stream to master HLS manifest.

yes, no

yes

init_extension

Initialization file's extension.

string (max length: 4 characters)

mp4

segment_extension

Segment file's extension.

string (max length: 4 characters)

m4s

split_segments

Split output to segments

yes, no

yes

widevine_drm

Apply Widevine DRM for whole output

yes. no

no

playready_drm

Apply PlayReady DRM for whole output

yes. no

no

hls_manifests

Create HLS manifests

yes. no

yes

dash_manifests

Create DASH manifests

yes. no

yes

mss_manifests

Create MSS manifests

yes. no

no

segment_template

Select which SegmentTemplate placeholder will be used

number$Number$
time$Time$

number

output_json

Upload output format processing summary to the output destination or the specified URL

yes, Valid URL

none

🚧

For pack_type parameter

<pack_type /> parameter is ignored if <pack_files /> is disabled.

🚧

For pack_each_stream parameter

<pack_each_stream /> parameter is ignored if <pack_files /> is disabled.

🚧

For dash_profile parameter

<dash_profile /> options available only for advanced_dash output.

🚧

For cmaf_conformant parameter

<cmaf_conformant /> feature available only for advanced_dash, fmp4_hls, advanced_fmp4, advanced_mss output formats.

🚧

For cmaf_conformant parameter

<cmaf_conformant /> feature not working with muxed streams.

🚧

For duration_precision parameter

<duration_precision /> parameter not available if <segmenter /> parameter set to dolby_segmenter.

🚧

For reduce_structural_overhead parameter

<reduce_structural_overhead /> feature is available only for advanced_hss output format.

This feature is available only if <segmenter /> set to v3

🚧

For add_audio_only parameter

<add_audio_only /> parameter is available only for advanced_hls, fmp4_hls, and advanced_fmp4 output formats.

It works only for unmuxed output, where audio and video are stored in separate variant streams.

🚧

For init_extension and segment_extension parameters

<init_extension /> and <segment_extension /> parameters are available only for fmp4_hls output format.

🚧

For fragment_duration parameter

<fragment_duration /> parameter is available only for advanced_fmp4 output format.

🚧

For widevine_drm and playready_drm parameters

<widevine_drm /> and <playready_drm /> parameters are available only for advanced_dash and dash manifests of advanced_fmp4 output formats.

🚧

For segment_template parameter

<segment_template /> parameter is available only for advanced_dash and advanced_fmp4 output formats.

Nielsen Metadata Settings

🚧

Note

This feature is available only for advanced_dash and advanced_hls output.

Nielsen Metadata Settings