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>

The AWSMediaTailor configuration.

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).
static PlaybackConfiguration.Builder	builder()
CdnConfiguration	cdnConfiguration() The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
DashConfiguration	dashConfiguration() The configuration for DASH content.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
HlsConfiguration	hlsConfiguration() The configuration for HLS content.
String	name() The identifier for the playback configuration.
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 high-quality video asset to transcode and use to fill in time that's not used by ads.
Map<String,String>	tags() The tags assigned 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 master playlist 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 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.

cdnConfiguration

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

dashConfiguration

public DashConfiguration dashConfiguration()

The configuration for DASH content.

Returns:

The configuration for DASH content.

hlsConfiguration

public HlsConfiguration hlsConfiguration()

The configuration for HLS content.

Returns:

The configuration for HLS content.

name

public String name()

The identifier for the playback configuration.

Returns:

The identifier for the playback configuration.

playbackConfigurationArn

public String playbackConfigurationArn()

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

Returns:

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

playbackEndpointPrefix

public String playbackEndpointPrefix()

The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.

Returns:

The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.

sessionInitializationEndpointPrefix

public 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 String slateAdUrl()

The URL for a high-quality 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 high-quality 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.

tags

public Map<String,String> tags()

The tags assigned to the playback configuration.

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

Returns:

The tags assigned to the playback configuration.

transcodeProfileName

public 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 String videoContentSourceUrl()

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

Returns:

The URL prefix for the master playlist 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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo