Package software.amazon.awssdk.services.mediatailor.model

Interface PutPlaybackConfigurationRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<PutPlaybackConfigurationRequest.Builder,PutPlaybackConfigurationRequest>, MediaTailorRequest.Builder, SdkBuilder<PutPlaybackConfigurationRequest.Builder,PutPlaybackConfigurationRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
PutPlaybackConfigurationRequest
public static interface PutPlaybackConfigurationRequest.Builder extends MediaTailorRequest.Builder, SdkPojo, CopyableBuilder<PutPlaybackConfigurationRequest.Builder,PutPlaybackConfigurationRequest>

  • Method Details

    • adDecisionServerUrl

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

      PutPlaybackConfigurationRequest.Builder availSuppression(AvailSuppression availSuppression)

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

      Parameters:
      availSuppression - The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • availSuppression

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

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

      This is a convenience method 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:

    • bumper

      PutPlaybackConfigurationRequest.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. To learn more about bumpers, see Bumpers.

      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. To learn more about bumpers, see Bumpers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bumper

      default PutPlaybackConfigurationRequest.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. To learn more about bumpers, see Bumpers.

      This is a convenience method 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:

    • cdnConfiguration

      PutPlaybackConfigurationRequest.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 PutPlaybackConfigurationRequest.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 method 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:

    • configurationAliases

      PutPlaybackConfigurationRequest.Builder configurationAliases(Map<String,? extends Map<String,String>> configurationAliases)

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

      Parameters:
      configurationAliases - The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dashConfiguration

      PutPlaybackConfigurationRequest.Builder dashConfiguration(DashConfigurationForPut 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 PutPlaybackConfigurationRequest.Builder dashConfiguration(Consumer<DashConfigurationForPut.Builder> dashConfiguration)

      The configuration for DASH content.

      This is a convenience method that creates an instance of the DashConfigurationForPut.Builder avoiding the need to create one manually via DashConfigurationForPut.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dashConfiguration(DashConfigurationForPut).

      Parameters:
      dashConfiguration - a consumer that will call methods on DashConfigurationForPut.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • insertionMode

      PutPlaybackConfigurationRequest.Builder insertionMode(String 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. Choosing PLAYER_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.

      Parameters:
      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. Choosing PLAYER_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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • insertionMode

      PutPlaybackConfigurationRequest.Builder insertionMode(InsertionMode 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. Choosing PLAYER_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.

      Parameters:
      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. Choosing PLAYER_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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • livePreRollConfiguration

      PutPlaybackConfigurationRequest.Builder livePreRollConfiguration(LivePreRollConfiguration livePreRollConfiguration)

      The configuration for pre-roll ad insertion.

      Parameters:
      livePreRollConfiguration - The configuration for pre-roll ad insertion.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • livePreRollConfiguration

      default PutPlaybackConfigurationRequest.Builder livePreRollConfiguration(Consumer<LivePreRollConfiguration.Builder> livePreRollConfiguration)

      The configuration for pre-roll ad insertion.

      This is a convenience method that creates an instance of the LivePreRollConfiguration.Builder avoiding the need to create one manually via LivePreRollConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to livePreRollConfiguration(LivePreRollConfiguration).

      Parameters:
      livePreRollConfiguration - a consumer that will call methods on LivePreRollConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • manifestProcessingRules

      PutPlaybackConfigurationRequest.Builder manifestProcessingRules(ManifestProcessingRules manifestProcessingRules)

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

      Parameters:
      manifestProcessingRules - The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • manifestProcessingRules

      default PutPlaybackConfigurationRequest.Builder manifestProcessingRules(Consumer<ManifestProcessingRules.Builder> manifestProcessingRules)

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

      This is a convenience method that creates an instance of the ManifestProcessingRules.Builder avoiding the need to create one manually via ManifestProcessingRules.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to manifestProcessingRules(ManifestProcessingRules).

      Parameters:
      manifestProcessingRules - a consumer that will call methods on ManifestProcessingRules.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • name

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

    • personalizationThresholdSeconds

      PutPlaybackConfigurationRequest.Builder personalizationThresholdSeconds(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • slateAdUrl

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

      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 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      PutPlaybackConfigurationRequest.Builder tags(Map<String,String> 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • transcodeProfileName

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

    • videoContentSourceUrl

      PutPlaybackConfigurationRequest.Builder videoContentSourceUrl(String videoContentSourceUrl)

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

      Parameters:
      videoContentSourceUrl - The URL prefix for the parent manifest 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.

    • overrideConfiguration

      PutPlaybackConfigurationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      PutPlaybackConfigurationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.