Class PlaybackConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<PlaybackConfiguration.Builder,
PlaybackConfiguration>
A playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The URL for the ad decision server (ADS).final AvailSuppression
The configuration for avail suppression, also known as ad suppression.builder()
final Bumper
bumper()
The configuration for bumpers.final CdnConfiguration
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.The player parameters and aliases used as dynamic variables during session initialization.final DashConfiguration
The configuration for a DASH source.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ConfigurationAliases property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final HlsConfiguration
The configuration for HLS content.final InsertionMode
The setting that controls whether players can use stitched or guided ad insertion.final String
The setting that controls whether players can use stitched or guided ad insertion.final LivePreRollConfiguration
The configuration for pre-roll ad insertion.final LogConfiguration
The Amazon CloudWatch log settings for a playback configuration.final ManifestProcessingRules
The configuration for manifest processing rules.final String
name()
The identifier for the playback configuration.final Integer
Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break.final String
The Amazon Resource Name (ARN) for the playback configuration.final String
The URL that the player accesses to get a manifest from AWS Elemental MediaTailor.static Class
<? extends PlaybackConfiguration.Builder> final String
The URL that the player uses to initialize a session that uses client-side reporting.final String
The URL for a video asset to transcode and use to fill in time that's not used by ads.tags()
The tags to assign to the playback configuration.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The name that is used to associate this playback configuration with a custom transcode profile.final String
The URL prefix for the parent manifest for the stream, minus the asset ID.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
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 theisEmpty()
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
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
The configuration for a DASH source.
- Returns:
- The configuration for a DASH source.
-
hlsConfiguration
The configuration for HLS content.
- Returns:
- The configuration for HLS content.
-
insertionMode
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_SELECT
allows 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.If the service returns an enum value that is not available in the current SDK version,
insertionMode
will returnInsertionMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominsertionModeAsString()
.- Returns:
- 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_SELECT
allows 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:
-
insertionModeAsString
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_SELECT
allows 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.If the service returns an enum value that is not available in the current SDK version,
insertionMode
will returnInsertionMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominsertionModeAsString()
.- Returns:
- 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_SELECT
allows 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:
-
livePreRollConfiguration
The configuration for pre-roll ad insertion.
- Returns:
- The configuration for pre-roll ad insertion.
-
logConfiguration
The Amazon CloudWatch log settings for a playback configuration.
- Returns:
- The Amazon CloudWatch log settings for a playback configuration.
-
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
The identifier for the playback configuration.
- Returns:
- The identifier for the playback configuration.
-
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
The Amazon Resource Name (ARN) for the playback configuration.
- Returns:
- The Amazon Resource Name (ARN) for the playback configuration.
-
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
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
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 theisEmpty()
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
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.
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. 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.
-
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<PlaybackConfiguration.Builder,
PlaybackConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-