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

Interface AdBreak.Builder

All Superinterfaces:

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

Enclosing class:

AdBreak

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

Method Summary

Modifier and Type	Method	Description
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.
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.
AdBreak.Builder	adBreakMetadata(KeyValuePair... adBreakMetadata)	Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for SCTE35_ENHANCED output.
AdBreak.Builder	messageType(String messageType)	The SCTE-35 ad insertion type.
AdBreak.Builder	messageType(MessageType messageType)	The SCTE-35 ad insertion type.
AdBreak.Builder	offsetMillis(Long offsetMillis)	How long (in milliseconds) after the beginning of the program that an ad starts.
default AdBreak.Builder	slate(Consumer<SlateSource.Builder> slate)	Ad break slate configuration.
AdBreak.Builder	slate(SlateSource slate)	Ad break slate configuration.
default AdBreak.Builder	spliceInsertMessage(Consumer<SpliceInsertMessage.Builder> spliceInsertMessage)	This defines the SCTE-35 splice_insert() message inserted around the ad.
AdBreak.Builder	spliceInsertMessage(SpliceInsertMessage spliceInsertMessage)	This defines the SCTE-35 splice_insert() message inserted around the ad.
default AdBreak.Builder	timeSignalMessage(Consumer<TimeSignalMessage.Builder> timeSignalMessage)	Defines the SCTE-35 time_signal message inserted around the ad.
AdBreak.Builder	timeSignalMessage(TimeSignalMessage timeSignalMessage)	Defines the SCTE-35 time_signal message inserted around the ad.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

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.

slate

default AdBreak.Builder slate(Consumer<SlateSource.Builder> slate)

Ad break slate configuration.

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

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

Parameters:

slate - a consumer that will call methods on SlateSource.Builder

Returns:

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

See Also:

slate(SlateSource)

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.

spliceInsertMessage

default AdBreak.Builder spliceInsertMessage(Consumer<SpliceInsertMessage.Builder> 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.

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

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

Parameters:

spliceInsertMessage - a consumer that will call methods on SpliceInsertMessage.Builder

Returns:

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

See Also:

spliceInsertMessage(SpliceInsertMessage)

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.

timeSignalMessage

default AdBreak.Builder timeSignalMessage(Consumer<TimeSignalMessage.Builder> 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.

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

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

Parameters:

timeSignalMessage - a consumer that will call methods on TimeSignalMessage.Builder

Returns:

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

See Also:

timeSignalMessage(TimeSignalMessage)

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)