Interface CfnPlaybackConfigurationProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnPlaybackConfigurationProps.Jsii$Proxy
CfnPlaybackConfiguration.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.mediatailor.*;
Object configurationAliases;
CfnPlaybackConfigurationProps cfnPlaybackConfigurationProps = CfnPlaybackConfigurationProps.builder()
.adDecisionServerUrl("adDecisionServerUrl")
.name("name")
.videoContentSourceUrl("videoContentSourceUrl")
// the properties below are optional
.adConditioningConfiguration(AdConditioningConfigurationProperty.builder()
.streamingMediaFileConditioning("streamingMediaFileConditioning")
.build())
.availSuppression(AvailSuppressionProperty.builder()
.fillPolicy("fillPolicy")
.mode("mode")
.value("value")
.build())
.bumper(BumperProperty.builder()
.endUrl("endUrl")
.startUrl("startUrl")
.build())
.cdnConfiguration(CdnConfigurationProperty.builder()
.adSegmentUrlPrefix("adSegmentUrlPrefix")
.contentSegmentUrlPrefix("contentSegmentUrlPrefix")
.build())
.configurationAliases(Map.of(
"configurationAliasesKey", configurationAliases))
.dashConfiguration(DashConfigurationProperty.builder()
.manifestEndpointPrefix("manifestEndpointPrefix")
.mpdLocation("mpdLocation")
.originManifestType("originManifestType")
.build())
.hlsConfiguration(HlsConfigurationProperty.builder()
.manifestEndpointPrefix("manifestEndpointPrefix")
.build())
.insertionMode("insertionMode")
.livePreRollConfiguration(LivePreRollConfigurationProperty.builder()
.adDecisionServerUrl("adDecisionServerUrl")
.maxDurationSeconds(123)
.build())
.logConfiguration(LogConfigurationProperty.builder()
.percentEnabled(123)
// the properties below are optional
.adsInteractionLog(AdsInteractionLogProperty.builder()
.excludeEventTypes(List.of("excludeEventTypes"))
.publishOptInEventTypes(List.of("publishOptInEventTypes"))
.build())
.enabledLoggingStrategies(List.of("enabledLoggingStrategies"))
.manifestServiceInteractionLog(ManifestServiceInteractionLogProperty.builder()
.excludeEventTypes(List.of("excludeEventTypes"))
.build())
.build())
.manifestProcessingRules(ManifestProcessingRulesProperty.builder()
.adMarkerPassthrough(AdMarkerPassthroughProperty.builder()
.enabled(false)
.build())
.build())
.personalizationThresholdSeconds(123)
.slateAdUrl("slateAdUrl")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.transcodeProfileName("transcodeProfileName")
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnPlaybackConfigurationPropsstatic final classAn implementation forCfnPlaybackConfigurationProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectThe setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads.The URL for the ad decision server (ADS).default ObjectThe configuration for avail suppression, also known as ad suppression.default ObjectThe configuration for bumpers.default ObjectThe configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.default ObjectThe player parameters and aliases used as dynamic variables during session initialization.default ObjectThe configuration for a DASH source.default ObjectThe configuration for HLS content.default StringThe setting that controls whether players can use stitched or guided ad insertion.default ObjectThe configuration for pre-roll ad insertion.default ObjectDefines where AWS Elemental MediaTailor sends logs for the playback configuration.default ObjectThe configuration for manifest processing rules.getName()The identifier for the playback configuration.default NumberDefines the maximum duration of underfilled ad time (in seconds) allowed in an ad break.default StringThe URL for a video asset to transcode and use to fill in time that's not used by ads.getTags()The tags to assign to the playback configuration.default StringThe name that is used to associate this playback configuration with a custom transcode profile.The URL prefix for the parent manifest for the stream, minus the asset ID.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAdDecisionServerUrl
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.
- See Also:
-
getName
The identifier for the playback configuration.- See Also:
-
getVideoContentSourceUrl
The URL prefix for the parent manifest for the stream, minus the asset ID.The maximum length is 512 characters.
- See Also:
-
getAdConditioningConfiguration
The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads.Returns union: either
IResolvableorCfnPlaybackConfiguration.AdConditioningConfigurationProperty- See Also:
-
getAvailSuppression
The configuration for avail suppression, also known as ad suppression.For more information about ad suppression, see Ad Suppression .
Returns union: either
IResolvableorCfnPlaybackConfiguration.AvailSuppressionProperty- See Also:
-
getBumper
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 .
Returns union: either
IResolvableorCfnPlaybackConfiguration.BumperProperty- See Also:
-
getCdnConfiguration
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.Returns union: either
IResolvableorCfnPlaybackConfiguration.CdnConfigurationProperty- See Also:
-
getConfigurationAliases
The player parameters and aliases used as dynamic variables during session initialization.For more information, see Domain Variables .
Returns union: either Mapinvalid input: '<'String,
Object> orIResolvable- See Also:
-
getDashConfiguration
The configuration for a DASH source.Returns union: either
IResolvableorCfnPlaybackConfiguration.DashConfigurationProperty- See Also:
-
getHlsConfiguration
The configuration for HLS content.Returns union: either
IResolvableorCfnPlaybackConfiguration.HlsConfigurationProperty- See Also:
-
getInsertionMode
The setting that controls whether players can use stitched or guided ad insertion.The default,
STITCHED_ONLY, forces all player sessions to use stitched (server-side) ad insertion. ChoosingPLAYER_SELECTallows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.- See Also:
-
getLivePreRollConfiguration
The configuration for pre-roll ad insertion.Returns union: either
IResolvableorCfnPlaybackConfiguration.LivePreRollConfigurationProperty- See Also:
-
getLogConfiguration
Defines where AWS Elemental MediaTailor sends logs for the playback configuration.Returns union: either
IResolvableorCfnPlaybackConfiguration.LogConfigurationProperty- See Also:
-
getManifestProcessingRules
The configuration for manifest processing rules.Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
Returns union: either
IResolvableorCfnPlaybackConfiguration.ManifestProcessingRulesProperty- See Also:
-
getPersonalizationThresholdSeconds
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 .
- See Also:
-
getSlateAdUrl
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.
- See Also:
-
getTags
The tags to assign to the playback configuration.Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources .
- See Also:
-
getTranscodeProfileName
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.
- See Also:
-
builder
-