software.amazon.awssdk.services.mediatailor.model

Class PlaybackConfiguration

java.lang.Object

software.amazon.awssdk.services.mediatailor.model.PlaybackConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PlaybackConfiguration.Builder,PlaybackConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class PlaybackConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PlaybackConfiguration.Builder,PlaybackConfiguration>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PlaybackConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
String	adDecisionServerUrl() The URL for the ad decision server (ADS).
AvailSuppression	availSuppression() The configuration for avail suppression, also known as ad suppression.
static PlaybackConfiguration.Builder	builder()
Bumper	bumper() The configuration for bumpers.
CdnConfiguration	cdnConfiguration() The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
Map<String,Map<String,String>>	configurationAliases() The player parameters and aliases used as dynamic variables during session initialization.
DashConfiguration	dashConfiguration() The configuration for a DASH source.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasConfigurationAliases() For responses, this returns true if the service returned a value for the ConfigurationAliases property.
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
HlsConfiguration	hlsConfiguration() The configuration for HLS content.
LivePreRollConfiguration	livePreRollConfiguration() The configuration for pre-roll ad insertion.
LogConfiguration	logConfiguration() The Amazon CloudWatch log settings for a playback configuration.
ManifestProcessingRules	manifestProcessingRules() The configuration for manifest processing rules.
String	name() The identifier for the playback configuration.
Integer	personalizationThresholdSeconds() Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break.
String	playbackConfigurationArn() The Amazon Resource Name (ARN) for the playback configuration.
String	playbackEndpointPrefix() The URL that the player accesses to get a manifest from AWS Elemental MediaTailor.
List<SdkField<?>>	sdkFields()
static Class<? extends PlaybackConfiguration.Builder>	serializableBuilderClass()
String	sessionInitializationEndpointPrefix() The URL that the player uses to initialize a session that uses client-side reporting.
String	slateAdUrl() The URL for a video asset to transcode and use to fill in time that's not used by ads.
Map<String,String>	tags() The tags to assign to the playback configuration.
PlaybackConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	transcodeProfileName() The name that is used to associate this playback configuration with a custom transcode profile.
String	videoContentSourceUrl() The URL prefix for the parent manifest for the stream, minus the asset ID.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

adDecisionServerUrl

public final String 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.

Returns:

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.

availSuppression

public final AvailSuppression availSuppression()

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

Returns:

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

bumper

public final Bumper 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.

Returns:

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.

cdnConfiguration

public final CdnConfiguration cdnConfiguration()

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

Returns:

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

hasConfigurationAliases

public final boolean hasConfigurationAliases()

For responses, this returns true if the service returned a value for the ConfigurationAliases property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

configurationAliases

public final Map<String,Map<String,String>> configurationAliases()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasConfigurationAliases() method.

Returns:

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

dashConfiguration

public final DashConfiguration dashConfiguration()

The configuration for a DASH source.

Returns:

The configuration for a DASH source.

hlsConfiguration

public final HlsConfiguration hlsConfiguration()

The configuration for HLS content.

Returns:

The configuration for HLS content.

livePreRollConfiguration

public final LivePreRollConfiguration livePreRollConfiguration()

The configuration for pre-roll ad insertion.

Returns:

The configuration for pre-roll ad insertion.

logConfiguration

public final LogConfiguration logConfiguration()

The Amazon CloudWatch log settings for a playback configuration.

Returns:

The Amazon CloudWatch log settings for a playback configuration.

manifestProcessingRules

public final ManifestProcessingRules manifestProcessingRules()

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

Returns:

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

name

public final String name()

The identifier for the playback configuration.

Returns:

The identifier for the playback configuration.

personalizationThresholdSeconds

public final Integer 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.

Returns:

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.

playbackConfigurationArn

public final String playbackConfigurationArn()

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

Returns:

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

playbackEndpointPrefix

public final String playbackEndpointPrefix()

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

Returns:

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

sessionInitializationEndpointPrefix

public final String sessionInitializationEndpointPrefix()

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

Returns:

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

slateAdUrl

public final String 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.

Returns:

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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final Map<String,String> tags()

The tags to assign to the playback configuration.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

The tags to assign to the playback configuration.

transcodeProfileName

public final String 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.

Returns:

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.

videoContentSourceUrl

public final String videoContentSourceUrl()

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

Returns:

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

toBuilder

public PlaybackConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PlaybackConfiguration.Builder,PlaybackConfiguration>

builder

public static PlaybackConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends PlaybackConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo