Stream Parameters

If no streams are specified, 9 default streams will be created for advanced_hls, 9 default streams for appletv and appletv_43, and 9 default streams will be created for advanced_dash/advanced_mss. The maximum number of available streams is 15

Acceptable parameters from:
Video Settings
Audio Settings
Other Format Options
Watermarking
Video Rotation
Cropping
Fading
Video Overlays
Audio Overlays
Text Overlays
Burn-in Timecode Options
Closed Captions

Parameter

Description

Allowed Values

Default Value

still_image

Specify how to embed a still image in an audio only stream.

no, each_segment, first_segment

no

still_image_time

Specify the time from the beginning of the video to capture a still image.

Non-negative number greater than 0.01 or hh:mm:ss.ms.

5

still_image_size

Specify the size of the still image.

WxH where W and H — positive integers.

none

byte_range

Enable byte-range playlist – do not split mpeg-ts file into segments.

yes, no

no

add_iframe_stream

Add i-frame playlist for this stream (allowed only for video).

yes, no

no

audio_only

Enable the creation of audio only segments.

yes, no

no

video_only

Enable the creation of video only segments.

yes, no

no

group_id

Specify an alternate group id based on the current stream.

String

none

use_group_id

Specify a group id list to use as alternate for current stream.

Comma separated group_id list.

none

base_name

Specify the customer stream result filename.

Valid filename.

none

playlist_version

Specify the version of the m3u8 playlist.

Integer(EXT-X-VERSION)

none

sub_path

Specify the stream manifest and media file location.

Valid URL.

none

media_path

Specify the media file location path relative to the sub_path.

Valid URL.

none

add_to_manifest

Add to one or several main manifests. If not value is specified it will be added to all main manifests.

Comma separated list of manifests.

none

use_alternate_id

Add one or several alternate sources. If no value is specified all alternate sources will be added to the stream.

Integer number. Should be less than <alternate_source /> parameter count.

none

timescale

Specify the fmp4 timescale.

Non-negative integer.

none

stream_title

HLS EXTINF tag's title attribute

String

none

pack_audio_to_mpegts

Pack audio only stream to MPEG-TS container

yes, no

no

track_type

Used to map stream and keys from CPIX response. Value should match with cpix:[email protected] If it's value doesn't match with any ContentKeyUsageRule first key from CPIX response will be used.
In dash manifest Representations will be grouped to different AdaptationSets by track_type.

String

none

hdcp_level

HDCP-LEVEL attribute for HLS EXT-X-STREAM-INF tag in master manifest.

no – to not add tag
none – HDCP-LEVEL=NONE
0 – HDCP-LEVEL=TYPE-0
1 – HDCP-LEVEL=TYPE-1

no

align_audio_segments_to_framerate

Align audio segment count to framerate value. If it's value same as video framerate value audio and video manifests will have equal segments count.

Valid framerate string

none

additional_alternate_id

List of additional alternate source ids to be added to HLS Media group.

Array of integer numbers

none

get_from_manifest

Use data from external manifest

yes, no

no

🚧

For byte_range parameter

The <byte_range /> is available for advanced_hls and fmp4_hls outputs only.

🚧

For add_iframe_stream parameter

The <add_iframe_stream /> available only for advanced_hls and advanced_fmp4 output formats.

🚧

For media_path parameter

The <media_path /> feature available only for advanced_dash and advanced_mss output.

📘

For use_alternate_id parameter

Each alternate source must be added via a separate **<use_alternate_id /> parameter.

🚧

For timescale parameter

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

🚧

For stream_title parameter

The <stream_title /> feature available only for advanced_hls and fmp4_hls output formats.

🚧

For pack_audio_to_mpegts parameter

The <pack_audio_to_mpegts /> feature available only for advanced_hls output format.

🚧

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 <stream /> block.

For advanced_hls output format media should have <multijob_workflow /> set to yes, or <pack_audio_to_mpegts  /> set to yes.

🚧

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.