manifest_personalization

Property Manager name: Manifest Personalization
Behavior version: The v2024-01-09 rule format supports the manifest_personalization behavior v1.0.
Rule format status: GA, stable
Access: Read/Write
Allowed in includes: Yes

Allows customers who use the Adaptive Media Delivery product to enhance content based on the capabilities of each end user's device. This behavior configures a manifest for both HLS Live and on-demand streaming. For more information, see Adaptive Media Delivery.

Option	Type	Description	Requires
`enabled`	boolean	Enables the Manifest Personalization feature.		{"displayType":"boolean","tag":"input","type":"checkbox"}
`hls_enabled`	boolean	Allows you to customize the HLS master manifest that's sent to the requesting client.		{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`hls_mode`	enum	Applies with `hls_enabled` on.	`hls_enabled` is `true`	{"displayType":"enum","options":["BEST_PRACTICE","CUSTOM"],"tag":"select"} {"if":{"attribute":"hlsEnabled","op":"eq","value":true}}
	`BEST_PRACTICE`	Specify the default best practice mode.
	`CUSTOM`	Specify a custom manifest.
`hls_preferred_bitrate`	string	Sets the preferred bit rate in Kbps. This causes the media playlist specified in the `#EXT-X-STREAM-INF` tag that most closely matches the value to list first. All other playlists maintain their current position in the manifest.	`hls_mode` is `CUSTOM`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"hlsMode","op":"eq","value":"CUSTOM"}}
`hls_filter_in_bitrates`	string	Specifies a comma-delimited set of preferred bit rates, such as `100,200,400`. Playlists specified in the `#EXT-X-STREAM-INF` tag with bit rates outside of any of those values by up to 100 Kbps are excluded from the manifest.	`hls_mode` is `CUSTOM`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"hlsMode","op":"eq","value":"CUSTOM"}}
`hls_filter_in_bitrate_ranges`	string	Specifies a comma-delimited set of bit rate ranges, such as `100-400,1000-4000`. Playlists specified in the `#EXT-X-STREAM-INF` tag with bit rates outside of any of those ranges are excluded from the manifest.	`hls_mode` is `CUSTOM`	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"hlsMode","op":"eq","value":"CUSTOM"}}
`hls_query_param_enabled`	boolean	Specifies query parameters for the HLS master manifest to customize the manifest's content. Any settings specified in the query string override those already configured in Property Manager.	`hls_enabled` is `true`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"hlsEnabled","op":"eq","value":true}}
`hls_query_param_secret_key`	object array	Specifies a primary key as a token to accompany the request.	`hls_query_param_enabled` is `true`	{"displayType":"object array","tag":"input","todo":true} {"if":{"attribute":"hlsQueryParamEnabled","op":"eq","value":true}}
`hls_query_param_transition_key`	object array	Specifies a transition key as a token to accompany the request.	`hls_query_param_enabled` is `true`	{"displayType":"object array","tag":"input","todo":true} {"if":{"attribute":"hlsQueryParamEnabled","op":"eq","value":true}}
`hls_show_advanced`	boolean	Allows you to configure advanced settings.	`hls_enabled` is `true`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"hlsEnabled","op":"eq","value":true}}
`hls_enable_debug_headers`	boolean	Includes additional `Akamai-Manifest-Personalization` and `Akamai-Manifest-Personalization-Config-Source` debugging headers.	`hls_show_advanced` is `true`	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"hlsShowAdvanced","op":"eq","value":true}}