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

Class PutPlaybackConfigurationRequest

    • Method Detail

      • adDecisionServerUrl

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

      • availSuppression

        public final AvailSuppression 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

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

        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

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

      • 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 the isEmpty() 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

        public final Map<String,​Map<String,​String>> 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

        public final DashConfigurationForPut dashConfiguration()

        The configuration for DASH content.

        Returns:
        The configuration for DASH content.

      • insertionMode

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

        If the service returns an enum value that is not available in the current SDK version, insertionMode will return InsertionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from insertionModeAsString().

        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. 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.
        See Also:
        InsertionMode

      • insertionModeAsString

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

        If the service returns an enum value that is not available in the current SDK version, insertionMode will return InsertionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from insertionModeAsString().

        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. 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.
        See Also:
        InsertionMode

      • livePreRollConfiguration

        public final LivePreRollConfiguration livePreRollConfiguration()

        The configuration for pre-roll ad insertion.

        Returns:
        The configuration for pre-roll ad insertion.

      • manifestProcessingRules

        public final ManifestProcessingRules 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

        public final String name()

        The identifier for the playback configuration.

        Returns:
        The identifier for the playback configuration.

      • personalizationThresholdSeconds

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

        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.

      • slateAdUrl

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

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

      • 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 the isEmpty() 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

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

        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

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

      • toString

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