Documentation

Creates a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.

See: newPlaybackConfiguration smart constructor.

Create a value of PlaybackConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:playbackEndpointPrefix:PlaybackConfiguration', playbackConfiguration_playbackEndpointPrefix - The URL that the player accesses to get a manifest from AWS Elemental MediaTailor.

$sel:hlsConfiguration:PlaybackConfiguration', playbackConfiguration_hlsConfiguration - The configuration for HLS content.

$sel:personalizationThresholdSeconds:PlaybackConfiguration', playbackConfiguration_personalizationThresholdSeconds - Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.

$sel:playbackConfigurationArn:PlaybackConfiguration', playbackConfiguration_playbackConfigurationArn - The Amazon Resource Name (ARN) for the playback configuration.

$sel:availSuppression:PlaybackConfiguration', playbackConfiguration_availSuppression - The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.

$sel:bumper:PlaybackConfiguration', playbackConfiguration_bumper - The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.

$sel:adDecisionServerUrl:PlaybackConfiguration', playbackConfiguration_adDecisionServerUrl - The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.

$sel:videoContentSourceUrl:PlaybackConfiguration', playbackConfiguration_videoContentSourceUrl - The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.

$sel:dashConfiguration:PlaybackConfiguration', playbackConfiguration_dashConfiguration - The configuration for a DASH source.

$sel:manifestProcessingRules:PlaybackConfiguration', playbackConfiguration_manifestProcessingRules - The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.

$sel:logConfiguration:PlaybackConfiguration', playbackConfiguration_logConfiguration - The Amazon CloudWatch log settings for a playback configuration.

$sel:livePreRollConfiguration:PlaybackConfiguration', playbackConfiguration_livePreRollConfiguration - The configuration for pre-roll ad insertion.

$sel:name:PlaybackConfiguration', playbackConfiguration_name - The identifier for the playback configuration.

$sel:sessionInitializationEndpointPrefix:PlaybackConfiguration', playbackConfiguration_sessionInitializationEndpointPrefix - The URL that the player uses to initialize a session that uses client-side reporting.

$sel:configurationAliases:PlaybackConfiguration', playbackConfiguration_configurationAliases - The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.

$sel:transcodeProfileName:PlaybackConfiguration', playbackConfiguration_transcodeProfileName - The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

$sel:tags:PlaybackConfiguration', playbackConfiguration_tags - The tags to assign to the playback configuration.

$sel:slateAdUrl:PlaybackConfiguration', playbackConfiguration_slateAdUrl - The URL for a video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

$sel:cdnConfiguration:PlaybackConfiguration', playbackConfiguration_cdnConfiguration - The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

The URL that the player accesses to get a manifest from AWS Elemental MediaTailor.

The configuration for HLS content.

Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.

The Amazon Resource Name (ARN) for the playback configuration.

The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.

The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.

The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.

The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.

The configuration for a DASH source.

The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.

The Amazon CloudWatch log settings for a playback configuration.

The configuration for pre-roll ad insertion.

The identifier for the playback configuration.

The URL that the player uses to initialize a session that uses client-side reporting.

The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.

The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

The tags to assign to the playback configuration.

The URL for a video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.