Image Playlist Parameters

The Image Playlist specification, developed by Disney and Warner Media, defines a format using compressed graphic image files for HLS and DASH that provides a sparse track of video frames for a client to use during trick-play and seek operations. This alternative format uses image files that have been compressed (usually via commonly-employed encoding schemes, e.g., JPEG). The HLS EXT-X-IMAGE-STREAM-INF tag identifies an Image Media Playlist file containing Images in a compressed graphic image format. It stands alone, in that it does not apply to a particular URI in the Master Playlist. Read more in the specification.

🚧

Note

Image Playlist Parameters feature doesn't work with advanced_mss output format.

Parameter

Description

Allowed Values

Defalt Value

interval

Specify the time interval between images in seconds or percentage of time passed.

N – Positive float number greater than 0.01

11

size

Specify the image width and height.

Pair of image width and height divided by ‘x’.

none

width

Specify the image width.

Non-negative integer.

160

height

Specify the image height.

Non-negative integer.

none

layout

Specify the playlist rows and columns layout.

Rows and Columns number divided by ‘x’.

none

max_columns

Specify the number of columns per tile.

Non-negative integer.

none

max_rows

Specify the number of rows per tile.

Non-negative integer.

none

sub_path

Directory where images would be uploaded.
Relative to output destination.

String

none

basename

Image name prefix

String

none

no_ext_x_tiles

Don't include #EXT-X-TILES tag to the output stream's image playlist

yes, no

no

segment_timeline

Turns on segment timelines for thumbnails description in a DASH manifest.
Thumbnails will be processed for each ad break interval separately, if they are set.

yes, no

no

timescale

Set timescale for DASH VTT thumbnails.

Positive integer, usually 1000

none

add_to_manifest

List of manifests names to include specified image media playlist.
By default image media playlist will be added to all manifests.

Comma separated strings

none

break_points

Define which ad breaks elements is used to split image list

default – split on both ad_break and cue_insert
adbreaks – split on ad_break only

default

offset

Sets first thumbnail offset

auto – we will calcualte offset as half of the specified <interval /> value
•integer number – frame offset in seconds

auto

get_from_manifest

Use data from external manifest

yes, no

no

🚧

For size parameter

<size /> parameter overwrites <width /> and <height /> parameters.

🚧

For layout parameter

<layout /> parameter overwrites <max_columns /> and <max_rows /> parameters.

🚧

For no_ext_x_tiles

<no_ext_x_tiles /> parameter only available for advanced_hls, fmp4_hls, and HLS manifests of advanced_fmp4 output formats.

🚧

For segment_timeline

<segment_timeline /> parameter only available for advanced_dash and DASH manifests of advanced_fmp4 output formats.

🚧

For timescale

<timescale /> parameter only available for advanced_dash and DASH manifests of advanced_fmp4 output formats.

🚧

For break_points

The <break_points /> applieable only if <segment_timeline /> set to yes.

🚧

For get_from_manifest

The <get_from_manifest /> parameter available only if manifest <sources /> are specified.