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

Interface AdBreak.Builder

    • Method Detail

      • adBreakMetadata

        AdBreak.Builder adBreakMetadata​(Collection<KeyValuePair> adBreakMetadata)

        Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for SCTE35_ENHANCED output.

        Parameters:
        adBreakMetadata - Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for SCTE35_ENHANCED output.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • adBreakMetadata

        AdBreak.Builder adBreakMetadata​(KeyValuePair... adBreakMetadata)

        Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for SCTE35_ENHANCED output.

        Parameters:
        adBreakMetadata - Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for SCTE35_ENHANCED output.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • adBreakMetadata

        AdBreak.Builder adBreakMetadata​(Consumer<KeyValuePair.Builder>... adBreakMetadata)

        Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for SCTE35_ENHANCED output.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #adBreakMetadata(List).

        Parameters:
        adBreakMetadata - a consumer that will call methods on KeyValuePair.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #adBreakMetadata(java.util.Collection)

      • messageType

        AdBreak.Builder messageType​(String messageType)

        The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.

        Parameters:
        messageType - The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        MessageType, MessageType

      • messageType

        AdBreak.Builder messageType​(MessageType messageType)

        The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.

        Parameters:
        messageType - The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        MessageType, MessageType

      • offsetMillis

        AdBreak.Builder offsetMillis​(Long offsetMillis)

        How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.

        Parameters:
        offsetMillis - How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • slate

        AdBreak.Builder slate​(SlateSource slate)

        Ad break slate configuration.

        Parameters:
        slate - Ad break slate configuration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • spliceInsertMessage

        AdBreak.Builder spliceInsertMessage​(SpliceInsertMessage spliceInsertMessage)

        This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.

        Parameters:
        spliceInsertMessage - This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • timeSignalMessage

        AdBreak.Builder timeSignalMessage​(TimeSignalMessage timeSignalMessage)

        Defines the SCTE-35 time_signal message inserted around the ad.

        Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.

        See section 9.7.4 of the 2022 SCTE-35 specification for more information.

        Parameters:
        timeSignalMessage - Defines the SCTE-35 time_signal message inserted around the ad.

        Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.

        See section 9.7.4 of the 2022 SCTE-35 specification for more information.

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