software.amazon.awssdk.services.mediatailor.model

Interface PlaybackConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<PlaybackConfiguration.Builder,PlaybackConfiguration>, SdkBuilder<PlaybackConfiguration.Builder,PlaybackConfiguration>, SdkPojo

Enclosing class:

PlaybackConfiguration

public static interface PlaybackConfiguration.Builder
extends SdkPojo, CopyableBuilder<PlaybackConfiguration.Builder,PlaybackConfiguration>

Method Summary

Modifier and Type	Method and Description
PlaybackConfiguration.Builder	adDecisionServerUrl(String adDecisionServerUrl) The URL for the ad decision server (ADS).
PlaybackConfiguration.Builder	availSuppression(AvailSuppression availSuppression) The configuration for Avail Suppression.
default PlaybackConfiguration.Builder	availSuppression(Consumer<AvailSuppression.Builder> availSuppression) The configuration for Avail Suppression.
PlaybackConfiguration.Builder	bumper(Bumper bumper) The configuration for bumpers.
default PlaybackConfiguration.Builder	bumper(Consumer<Bumper.Builder> bumper) The configuration for bumpers.
PlaybackConfiguration.Builder	cdnConfiguration(CdnConfiguration cdnConfiguration) The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
default PlaybackConfiguration.Builder	cdnConfiguration(Consumer<CdnConfiguration.Builder> cdnConfiguration) The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
default PlaybackConfiguration.Builder	dashConfiguration(Consumer<DashConfiguration.Builder> dashConfiguration) The configuration for DASH content.
PlaybackConfiguration.Builder	dashConfiguration(DashConfiguration dashConfiguration) The configuration for DASH content.
default PlaybackConfiguration.Builder	hlsConfiguration(Consumer<HlsConfiguration.Builder> hlsConfiguration) The configuration for HLS content.
PlaybackConfiguration.Builder	hlsConfiguration(HlsConfiguration hlsConfiguration) The configuration for HLS content.
PlaybackConfiguration.Builder	name(String name) The identifier for the playback configuration.
PlaybackConfiguration.Builder	personalizationThresholdSeconds(Integer personalizationThresholdSeconds) The maximum duration of underfilled ad time (in seconds) allowed in an ad break.
PlaybackConfiguration.Builder	playbackConfigurationArn(String playbackConfigurationArn) The Amazon Resource Name (ARN) for the playback configuration.
PlaybackConfiguration.Builder	playbackEndpointPrefix(String playbackEndpointPrefix) The URL that the player accesses to get a manifest from AWS Elemental MediaTailor.
PlaybackConfiguration.Builder	sessionInitializationEndpointPrefix(String sessionInitializationEndpointPrefix) The URL that the player uses to initialize a session that uses client-side reporting.
PlaybackConfiguration.Builder	slateAdUrl(String slateAdUrl) The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads.
PlaybackConfiguration.Builder	tags(Map<String,String> tags) The tags assigned to the playback configuration.
PlaybackConfiguration.Builder	transcodeProfileName(String transcodeProfileName) The name that is used to associate this playback configuration with a custom transcode profile.
PlaybackConfiguration.Builder	videoContentSourceUrl(String videoContentSourceUrl) The URL prefix for the master playlist for the stream, minus the asset ID.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

adDecisionServerUrl

PlaybackConfiguration.Builder adDecisionServerUrl(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

availSuppression

PlaybackConfiguration.Builder availSuppression(AvailSuppression availSuppression)

The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.

Parameters:

availSuppression - The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.

Returns:

Returns a reference to this object so that method calls can be chained together.

availSuppression

default PlaybackConfiguration.Builder availSuppression(Consumer<AvailSuppression.Builder> availSuppression)

The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.

This is a convenience that creates an instance of the AvailSuppression.Builder avoiding the need to create one manually via AvailSuppression.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to availSuppression(AvailSuppression).

Parameters:

availSuppression - a consumer that will call methods on AvailSuppression.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

availSuppression(AvailSuppression)

bumper

PlaybackConfiguration.Builder bumper(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

bumper

default PlaybackConfiguration.Builder bumper(Consumer<Bumper.Builder> 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.

This is a convenience that creates an instance of the Bumper.Builder avoiding the need to create one manually via Bumper.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to bumper(Bumper).

Parameters:

bumper - a consumer that will call methods on Bumper.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

bumper(Bumper)

cdnConfiguration

PlaybackConfiguration.Builder cdnConfiguration(CdnConfiguration cdnConfiguration)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

cdnConfiguration

default PlaybackConfiguration.Builder cdnConfiguration(Consumer<CdnConfiguration.Builder> cdnConfiguration)

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

This is a convenience that creates an instance of the CdnConfiguration.Builder avoiding the need to create one manually via CdnConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cdnConfiguration(CdnConfiguration).

Parameters:

cdnConfiguration - a consumer that will call methods on CdnConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

cdnConfiguration(CdnConfiguration)

dashConfiguration

PlaybackConfiguration.Builder dashConfiguration(DashConfiguration dashConfiguration)

The configuration for DASH content.

Parameters:

dashConfiguration - The configuration for DASH content.

Returns:

Returns a reference to this object so that method calls can be chained together.

dashConfiguration

default PlaybackConfiguration.Builder dashConfiguration(Consumer<DashConfiguration.Builder> dashConfiguration)

The configuration for DASH content.

This is a convenience that creates an instance of the DashConfiguration.Builder avoiding the need to create one manually via DashConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dashConfiguration(DashConfiguration).

Parameters:

dashConfiguration - a consumer that will call methods on DashConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

dashConfiguration(DashConfiguration)

hlsConfiguration

PlaybackConfiguration.Builder hlsConfiguration(HlsConfiguration hlsConfiguration)

The configuration for HLS content.

Parameters:

hlsConfiguration - The configuration for HLS content.

Returns:

Returns a reference to this object so that method calls can be chained together.

hlsConfiguration

default PlaybackConfiguration.Builder hlsConfiguration(Consumer<HlsConfiguration.Builder> hlsConfiguration)

The configuration for HLS content.

This is a convenience that creates an instance of the HlsConfiguration.Builder avoiding the need to create one manually via HlsConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to hlsConfiguration(HlsConfiguration).

Parameters:

hlsConfiguration - a consumer that will call methods on HlsConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

hlsConfiguration(HlsConfiguration)

name

PlaybackConfiguration.Builder name(String name)

The identifier for the playback configuration.

Parameters:

name - The identifier for the playback configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

playbackConfigurationArn

PlaybackConfiguration.Builder playbackConfigurationArn(String playbackConfigurationArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

playbackEndpointPrefix

PlaybackConfiguration.Builder playbackEndpointPrefix(String playbackEndpointPrefix)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

sessionInitializationEndpointPrefix

PlaybackConfiguration.Builder sessionInitializationEndpointPrefix(String sessionInitializationEndpointPrefix)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

slateAdUrl

PlaybackConfiguration.Builder slateAdUrl(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

tags

PlaybackConfiguration.Builder tags(Map<String,String> tags)

The tags assigned to the playback configuration.

Parameters:

tags - The tags assigned to the playback configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

transcodeProfileName

PlaybackConfiguration.Builder transcodeProfileName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

personalizationThresholdSeconds

PlaybackConfiguration.Builder personalizationThresholdSeconds(Integer personalizationThresholdSeconds)

The maximum duration of underfilled ad time (in seconds) allowed in an ad break.

Parameters:

personalizationThresholdSeconds - The maximum duration of underfilled ad time (in seconds) allowed in an ad break.

Returns:

Returns a reference to this object so that method calls can be chained together.

videoContentSourceUrl

PlaybackConfiguration.Builder videoContentSourceUrl(String videoContentSourceUrl)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.