Configuration parameters
HLS or Dash over CMAF

HLS or DASH over CMAF

Below are the parameters accessed in the HLS or DASH over CMAF output.

General

General

ParameterDescription
Output nameOutput name. The name you want to use for the output.
Naming scheme
Naming schemes for DASH manifests.
Possible schemes: Index or Timeline.
In Index mode, fragment names are computed by the played based on data given in the manifest.
In Timeline mode, every fragment is listed and requested by the player.
GOP per segmentThe number of GOP (group of pictures) included into each segment.
Segments per manifestNumber for segments to include in the manifests.
trun v1Enable trun version 1 for fragments allowing negative CTO (Composition Time Offset) values
Trick Mode supportEnables IFrame representations.
Low latencyEnables low latency mode.
Enable thumbnailsEnable thumbnails generation

Subtitles

ParameterDescription
Name
Name of the subtitle track.
This name will be used in generated manifests/playlists.
This setting does not apply to OnDemand assets where subtitles are delivered as passthrough from the source TTML file.
Type
Type of subtitle.
Possible values: 'Closed captions [14]', 'DVB Subtitles' or 'DVB Teletext'
This setting does not apply to OnDemand assets where subtitles are delivered as passthrough from the source TTML file.
Convert
Defines the conversion that applies to ingested subtitle or closed caption.
Possible values: 'None', 'Passthrough', 'SMPTETT' or 'WebVTT'.
For all assets a value of 'None' disables the given subtitle or closed caption track.
For OnDemand assets, 'Passthrough' means that subtitles are delivered as passthrough from the source TTML file. 'Passthrough' does not apply to Live assets.
For OnDemand assets, if a conversion is applied, then specified filename will be delivered in fragmented packages.

Parameters mapping & advanced settings

ParameterDescription
Parameters mapping keyMapping key that will be used to override output parameters in individual OnDemand content or Live Packaging Services
Event Message Box version
Version of Event Message Box (emsg) used to carry timed metadata information.
Possible values: 'Version 0' for legacy DASH or 'Version 1' for CMAF compatible DASH

Related information
HLS or DASH over CMAF output configuration

Dash

Manifest

ParameterDescription
NameName of the manifest/playlist generated for the current output.. Default value is index (for HLS) or manifest (for HSS and DASH). If a filtering has been applied to the manifest/playlist, it is recommended to use a name that clearly identifies the defined filtering.
Important: The manifest name must be unique and different from any other manifest name.

Filtering - Stream characteristics

ParameterDescription
Audio streams filter
Build a filter to select the audio streams that will be included in manifest/playlist.
Applicable filters: bitrate in kbps
Video streams filter
Build a filter to select the video streams that will be included in manifest/playlist.
Applicable filters: bitrate in kbps and codec (H.264 or HEVC)
Subtitle streams filter
Build a filter to select the subtitle streams that will be included in manifest/playlist.
Applicable filters: bitrate in kbps
Thumbnail streams filter
Build a filter to select the thumbnail streams that will be included in manifest/playlist.
Applicable filters: width and height in pixels

Nielsen Watermarking

ParameterDescription
No FilteringAll the available audio streams within the audio bitrate range defined above will be integrated to the generated output.
LinearOnly the linear audio streams within the audio bitrate range defined above will be integrated to the generated output.
C3Only the C3 (catch-up 3-days) audio streams within the audio bitrate range defined above will be integrated to the generated output.
C7Only the C7 (catch-up 7-days) audio streams within the audio bitrate range defined above will be integrated to the generated output.

Player wall-clock

ParameterDescription
SchemeScheme to use for the UTCTiming element in DASH manifest.
ValueValue to use for UTCTiming element depending on the selected scheme.

Advanced settings

ParameterDescription
Audio merge policyDefines the merge policy to apply to audio AdataptationSets.
Compatibility modeEnables compatibility mode.

HLS

Playlist

ParameterDescription
NameName of the manifest/playlist generated for the current output. Default value is index (for HLS) or manifest (for HSS and DASH).
Recommendation: If a filtering has been applied to the manifest/playlist, it is recommended to use a name that clearly identifies the defined filtering.

Important: The manifest name must be unique and different from any other manifest name.

Filtering - Stream characteristics

ParameterDescription
Audio streams filter
Build a filter to select the audio streams that will be included in manifest/playlist.
Applicable filters: bitrate in kbps
Video streams filter
Build a filter to select the video streams that will be included in manifest/playlist.
Applicable filters: bitrate in kbps and codec (H.264 or HEVC)
Subtitle streams filter
Build a filter to select the subtitle streams that will be included in manifest/playlist.
Applicable filters: bitrate in kbps
Thumbnail streams filter
Build a filter to select the thumbnail streams that will be included in manifest/playlist.
Applicable filters: width and height in pixels

Filtering - Stream index

ParameterDescription
Indexes
Range or comma separated list of stream indexes, based on the stream position in the input.
Index of the first stream is '0'.

Nielsen Watermarking

ParameterDescription
No FilteringAll the available audio streams within the audio bitrate range defined above will be integrated to the generated output.
LinearOnly the linear audio streams within the audio bitrate range defined above will be integrated to the generated output.
C3Only the C3 (catch-up 3-days) audio streams within the audio bitrate range defined above will be integrated to the generated output.
C7Only the C7 (catch-up 7-days) audio streams within the audio bitrate range defined above will be integrated to the generated output.

URL signing

ParameterDescription
Replacement type
Defines the content replacement strategy applied to the output.
Possible values: None or POIS (Placement Opportunity Information Service)

Cisco URL signature

ParameterDescription
VersionURL signing version number. Version 0 uses MD5 hash algorithm. Version 2 uses SHA1 hash algorithm.
Key ownerKey owner value (Provided by Cisco)
Key IDKey ID associated to the Key (Provided by Cisco)
KeyKey value (Provided by Cisco)
Expiration timeDuration of availabilty of the URL with current signature Default: 3600
URL preambuleURL preambue to be use for this output
Client IPIP address of the client

Delivery

General parameters

ParameterDescription
Access URLPortion of the complete access URL that defines the service.
Prefer URI unreserved characters (alphanumerical characters plus (, ), -, _, .). Declaring a subpath (a/b) is possible but may impact performance.
Example: https://[Server IP or FQDN]/[Output Access URL]/[Live Packaging Service Access URL]/[index.m3u8 OR manifest OR manifest.mpd]

External origin Server

ParameterDescription
DetailsRemote location for playlists, manifests and segments.
Example: http://host/directory or file://host/directory

Common encryption (CENC)

Fixed key generation mode

ParameterDescription
KeyAES key used for encrypting the content.
Key IDIdentifier used to uniquely identify the key within the system.
PlayReadyEnables PlayReady encryption.
WidevineEnables Widevine encryption.
Marlin MS3Enables Marlin MS3 encryption.

PlayReady mode enabled:

ParameterDescription
License acquisition URLLicense acquisition URL to be used by the player.
License UI URLNonsilent license acquisition URL to be used by the player.
Domain service IDDomain service identifier.<br>Microsoft provides a unique identifier to the PlayReady technology supplier.

Widevine mode enabled:

ParameterDescription
ProviderName of the content provider. Also used as the name of the signer.
PolicyUsage rules for the encypted output.

Compatible CPIX ext. key

ParameterDescription
Key server URLURL of the server that will deliver the encryption keys.
PlayReadyEnables PlayReady encryption.
WidevineEnables Widevine encryption.
Marlin MS3Enables Marlin MS3 encryption.

Key rotation enabled:

ParameterDescription
PeriodKey rotation period. Choose a value and a unit for the period
Start timeDate and time of the first occurrence
Time spreadDuration (in seconds) of the time window for spreading key requests out in time
Period modeChoose mode for rotation keys.Possible values are:
- index: the interval is defined by a sequence number.
- start/end: the interval is defined by [start, end], meaning that the key is in use at the start time but not at the end time.
Number of key periods to request Number of key periods to request in advance from the key server

Key usage rules

ParameterDescription
Track filters/Filtering
Build a filter to select the streams that will be included in Cpix track.
Applicable filters: streamType (video or audio), width (in pixels), height (in pixels) and codec (H.264 or HEVC)
Track type
Type of a track associated to the track.
Only AZaz09 _,;:@ and space character are accepted
Labels
List of labels associated to the track
Only AZaz09 _,;:@ and space character are accepted
Disable audio encryption
Disables audio encryption for the output.
This setting overrides any encryption setting received from the key provider.

Google Widevine interface ext. key

ParameterDescription
Key server URLURL of the server that will deliver the encryption keys.
ProviderName of the content provider. Also used as the name of the signer.
Signature initialization vectorSignature Initialization Vector to be used with the signature key.
Signature AES keyAES key used to sign the request.
PolicyUsage rules for the encypted output.
PlayReadyEnables PlayReady encryption.
WidevineEnables Widevine encryption.

Key usage rules

ParameterDescription
Disable audio encryption
Disables audio encryption for the output.
This setting overrides any encryption setting received from the key provider.

Bouygues Telecom interface ext. key

ParameterDescription
Key server URLURL of the server that will deliver the encryption keys.
PlayReadyEnables PlayReady encryption.
WidevineEnables Widevine encryption.

Key usage rules

ParameterDescription
Disable audio encryption
Disables audio encryption for the output.
This setting overrides any encryption setting received from the key provider.

Verimatrix Telecom interface ext. key

ParameterDescription
Key server URLURL of the server that will deliver the encryption keys.
Site IDUnique identifier of the site for which the content is being created.
PlayReadyEnables PlayReady encryption.
WidevineEnables Widevine encryption.

Key usage rules

ParameterDescription
Disable audio encryption
Disables audio encryption for the output.
This setting overrides any encryption setting received from the key provider.

Kaltura interface ext. key

ParameterDescription
Key server URLURL of the server that will deliver the encryption keys.
Account IDIdentifier of the key requestor.
Signature AES keyAES key used to sign the request.
PlayReadyEnables PlayReady encryption.
WidevineEnables Widevine encryption.

Key usage rules

ParameterDescription
Disable audio encryption
Disables audio encryption for the output.
This setting overrides any encryption setting received from the key provider.

Irdeto interface ext. key

ParameterDescription
Key server URLURL of the server that will deliver the encryption keys.
Account IDIdentifier of the key requestor.
Crypto period
Time span that a key is authorized for use.
A new key is retrieved at the start of each new period.
A value of '0' means that a single key will be used.
PlayReadyEnables PlayReady encryption.
WidevineEnables Widevine encryption.

Key usage rules

ParameterDescription
Disable audio encryption
Disables audio encryption for the output.
This setting overrides any encryption setting received from the key provider.

Nagra KSS interface ext. key

ParameterDescription
Key server URLURL of the server that will deliver the encryption keys.
Key update periodDefines the period between two key requests from the packager to the key server.
PlayReadyEnables PlayReady encryption.
WidevineEnables Widevine encryption.

Key usage rules

ParameterDescription
Disable audio encryption
Disables audio encryption for the output.
This setting overrides any encryption setting received from the key provider.

Common encryption (CBCS)

Fixed key generation mode

ParameterDescription
KeyAES key used for encrypting the content. Unit: hexadecimal.
Initialization vectorInitialization vector to be used with the key.
Key IDIdentifier used to uniquely identify the key within the system.
PlayReadyEnables PlayReady encryption.
WidevineEnables Widevine encryption.
AppleEnables Apple encryption.

PlayReady mode enabled:

ParameterDescription
License acquisition URLLicense acquisition URL to be used by the player.
License UI URLNonsilent license acquisition URL to be used by the player.
Domain service ID
Domain service identifier.
Microsoft provides a unique identifier to the PlayReady technology supplier.

Widevine mode enabled:

ParameterDescription
ProviderName of the content provider. Also used as the name of the signer.
PolicyUsage rules for the encypted output.

Apple mode enabled:

ParameterDescription
URIURI to be used by the player.
Key formatSpecify how the key is declared in the resource specified in the URL.
Key format versionsIndicate which version of the key format is used.

Key usage rules

ParameterDescription
Disable audio encryption
Disables audio encryption for the output.
This setting overrides any encryption setting received from the key provider.

Compatible CPIX ext. key

ParameterDescription
Key server URLURL of the server that will deliver the encryption keys.
PlayReadyEnables PlayReady encryption.
WidevineEnables Widevine encryption.
AppleEnables Apple encryption.

Key rotation enabled:

ParameterDescription
PeriodKey rotation period. Choose a value and a unit for the period
Start timeDate and time of the first occurrence
Time spreadDuration (in seconds) of the time window for spreading key requests out in time
Period modeChoose mode for rotation keys.Possible values are:
- index: the interval is defined by a sequence number.
- start/end: the interval is defined by [start, end], meaning that the key is in use at the start time but not at the end time.
Number of key periods to request Number of key periods to request in advance from the key server

Key usage rules

ParameterDescription
Track filters/Filtering
Build a filter to select the streams that will be included in Cpix track.
Applicable filters: streamType (video or audio), width (in pixels), height (in pixels) and codec (H.264 or HEVC)
Track type
Type of a track associated to the track.
Only AZaz09 _,;:@ and space character are accepted
Labels
List of labels associated to the track
Only AZaz09 _,;:@ and space character are accepted
Disable audio encryption
Disables audio encryption for the output.
This setting overrides any encryption setting received from the key provider.

Content replacement

Placement opportunity information service (POIS)

ParameterDescription
POIS server URL
URL of the POIS (Placement Opportunity Information Service).
Upon placement opportunity notification, POIS returns either a list of URLs to insert in place of the initial one, or specific tags to be inserted within the playlist.

Related information
HLS or DASH over CMAF output configuration
HLS over TS output configuration
HSS output configuration