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

Interface PutPlaybackConfigurationRequest.Builder

    • Method Detail

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

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

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

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

      • 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, InsertionMode

      • 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:
        InsertionMode, InsertionMode

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

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

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

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

      • adConditioningConfiguration

        PutPlaybackConfigurationRequest.Builder adConditioningConfiguration​(AdConditioningConfiguration adConditioningConfiguration)

        The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads.

        Parameters:
        adConditioningConfiguration - The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads.
        Returns:
        Returns a reference to this object so that method calls can be chained together.