software.amazon.awscdk.services.mediatailor

Interface CfnPlaybackConfigurationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPlaybackConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.958Z")
 @Stability(value=Stable)
public interface CfnPlaybackConfigurationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `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
         .availSuppression(AvailSuppressionProperty.builder()
                 .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())
         .livePreRollConfiguration(LivePreRollConfigurationProperty.builder()
                 .adDecisionServerUrl("adDecisionServerUrl")
                 .maxDurationSeconds(123)
                 .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnPlaybackConfigurationProps.Builder A builder for CfnPlaybackConfigurationProps
static class	CfnPlaybackConfigurationProps.Jsii$Proxy An implementation for CfnPlaybackConfigurationProps

Method Summary

Modifier and Type	Method and Description
static CfnPlaybackConfigurationProps.Builder	builder()
String	getAdDecisionServerUrl() The URL for the ad decision server (ADS).
default Object	getAvailSuppression() The configuration for avail suppression, also known as ad suppression.
default Object	getBumper() The configuration for bumpers.
default Object	getCdnConfiguration() The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
default Object	getConfigurationAliases() The player parameters and aliases used as dynamic variables during session initialization.
default Object	getDashConfiguration() The configuration for DASH content.
default Object	getLivePreRollConfiguration() The configuration for pre-roll ad insertion.
default Object	getManifestProcessingRules() The configuration for manifest processing rules.
String	getName() The identifier for the playback configuration.
default Number	getPersonalizationThresholdSeconds() Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break.
default String	getSlateAdUrl() The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads.
default List<CfnTag>	getTags() The tags to assign to the playback configuration.
default String	getTranscodeProfileName() The name that is used to associate this playback configuration with a custom transcode profile.
String	getVideoContentSourceUrl() 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 Detail

getAdDecisionServerUrl

@Stability(value=Stable)
 @NotNull
String getAdDecisionServerUrl()

The URL for the ad decision server (ADS).

This includes the specification of static parameters and placeholders for dynamic parameters. 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.

getName

@Stability(value=Stable)
 @NotNull
String getName()

The identifier for the playback configuration.

getVideoContentSourceUrl

@Stability(value=Stable)
 @NotNull
String getVideoContentSourceUrl()

The URL prefix for the parent manifest for the stream, minus the asset ID.

The maximum length is 512 characters.

getAvailSuppression

@Stability(value=Stable)
 @Nullable
default Object getAvailSuppression()

The configuration for avail suppression, also known as ad suppression.

For more information about ad suppression, see Ad Suppression .

getBumper

@Stability(value=Stable)
 @Nullable
default Object 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 .

getCdnConfiguration

@Stability(value=Stable)
 @Nullable
default Object getCdnConfiguration()

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

getConfigurationAliases

@Stability(value=Stable)
 @Nullable
default Object getConfigurationAliases()

The player parameters and aliases used as dynamic variables during session initialization.

For more information, see Domain Variables .

getDashConfiguration

@Stability(value=Stable)
 @Nullable
default Object getDashConfiguration()

The configuration for DASH content.

getLivePreRollConfiguration

@Stability(value=Stable)
 @Nullable
default Object getLivePreRollConfiguration()

The configuration for pre-roll ad insertion.

getManifestProcessingRules

@Stability(value=Stable)
 @Nullable
default Object getManifestProcessingRules()

The configuration for manifest processing rules.

Manifest processing rules enable customization of the personalized manifests created by MediaTailor.

getPersonalizationThresholdSeconds

@Stability(value=Stable)
 @Nullable
default Number 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 MediaTailor .

getSlateAdUrl

@Stability(value=Stable)
 @Nullable
default String getSlateAdUrl()

The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads.

MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

The tags to assign to the playback configuration.

getTranscodeProfileName

@Stability(value=Stable)
 @Nullable
default String 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.

builder

@Stability(value=Stable)
static CfnPlaybackConfigurationProps.Builder builder()

Returns:

a CfnPlaybackConfigurationProps.Builder of CfnPlaybackConfigurationProps