software.amazon.awssdk.services.medialive.model

Interface BlackoutSlate.Builder

All Superinterfaces:

CopyableBuilder<BlackoutSlate.Builder,BlackoutSlate>, SdkBuilder<BlackoutSlate.Builder,BlackoutSlate>

Enclosing class:

BlackoutSlate

public static interface BlackoutSlate.Builder
extends CopyableBuilder<BlackoutSlate.Builder,BlackoutSlate>

Method Summary

Modifier and Type	Method and Description
default BlackoutSlate.Builder	blackoutSlateImage(Consumer<InputLocation.Builder> blackoutSlateImage) Blackout slate image to be used.
BlackoutSlate.Builder	blackoutSlateImage(InputLocation blackoutSlateImage) Blackout slate image to be used.
BlackoutSlate.Builder	networkEndBlackout(BlackoutSlateNetworkEndBlackout networkEndBlackout) Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered.
BlackoutSlate.Builder	networkEndBlackout(String networkEndBlackout) Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered.
default BlackoutSlate.Builder	networkEndBlackoutImage(Consumer<InputLocation.Builder> networkEndBlackoutImage) Path to local file to use as Network End Blackout image.
BlackoutSlate.Builder	networkEndBlackoutImage(InputLocation networkEndBlackoutImage) Path to local file to use as Network End Blackout image.
BlackoutSlate.Builder	networkId(String networkId) Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
BlackoutSlate.Builder	state(BlackoutSlateState state) When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.
BlackoutSlate.Builder	state(String state) When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.

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

copy

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

apply, build

Method Detail

blackoutSlateImage

BlackoutSlate.Builder blackoutSlateImage(InputLocation blackoutSlateImage)

Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.

Parameters:

blackoutSlateImage - Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.

Returns:

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

blackoutSlateImage

default BlackoutSlate.Builder blackoutSlateImage(Consumer<InputLocation.Builder> blackoutSlateImage)

Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported. This is a convenience that creates an instance of the InputLocation.Builder avoiding the need to create one manually via InputLocation.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to blackoutSlateImage(InputLocation).

Parameters:

blackoutSlateImage - a consumer that will call methods on InputLocation.Builder

Returns:

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

See Also:

blackoutSlateImage(InputLocation)

networkEndBlackout

BlackoutSlate.Builder networkEndBlackout(String networkEndBlackout)

Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID".

Parameters:

networkEndBlackout - Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID".

Returns:

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

See Also:

BlackoutSlateNetworkEndBlackout, BlackoutSlateNetworkEndBlackout

networkEndBlackout

BlackoutSlate.Builder networkEndBlackout(BlackoutSlateNetworkEndBlackout networkEndBlackout)

Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID".

Parameters:

networkEndBlackout - Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID".

Returns:

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

See Also:

BlackoutSlateNetworkEndBlackout, BlackoutSlateNetworkEndBlackout

networkEndBlackoutImage

BlackoutSlate.Builder networkEndBlackoutImage(InputLocation networkEndBlackoutImage)

Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.

Parameters:

networkEndBlackoutImage - Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.

Returns:

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

networkEndBlackoutImage

default BlackoutSlate.Builder networkEndBlackoutImage(Consumer<InputLocation.Builder> networkEndBlackoutImage)

Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster. This is a convenience that creates an instance of the InputLocation.Builder avoiding the need to create one manually via InputLocation.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to networkEndBlackoutImage(InputLocation).

Parameters:

networkEndBlackoutImage - a consumer that will call methods on InputLocation.Builder

Returns:

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

See Also:

networkEndBlackoutImage(InputLocation)

networkId

BlackoutSlate.Builder networkId(String networkId)

Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").

Parameters:

networkId - Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").

Returns:

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

state

BlackoutSlate.Builder state(String state)

When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.

Parameters:

state - When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.

Returns:

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

See Also:

BlackoutSlateState, BlackoutSlateState

state

BlackoutSlate.Builder state(BlackoutSlateState state)

When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.

Parameters:

state - When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.

Returns:

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

See Also:

BlackoutSlateState, BlackoutSlateState