software.amazon.awssdk.services.medialive.model

Class BlackoutSlate

java.lang.Object

software.amazon.awssdk.services.medialive.model.BlackoutSlate

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<BlackoutSlate.Builder,BlackoutSlate>

@Generated(value="software.amazon.awssdk:codegen")
public class BlackoutSlate
extends Object
implements StructuredPojo, ToCopyableBuilder<BlackoutSlate.Builder,BlackoutSlate>

Placeholder documentation for BlackoutSlate

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BlackoutSlate.Builder

Method Summary

Modifier and Type	Method and Description
InputLocation	blackoutSlateImage() Blackout slate image to be used.
static BlackoutSlate.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
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.
String	networkEndBlackoutAsString() 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.
InputLocation	networkEndBlackoutImage() Path to local file to use as Network End Blackout image.
String	networkId() Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
static Class<? extends BlackoutSlate.Builder>	serializableBuilderClass()
BlackoutSlateState	state() When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.
String	stateAsString() When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.
BlackoutSlate.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

blackoutSlateImage

public InputLocation blackoutSlateImage()

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

Returns:

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

networkEndBlackout

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

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

Returns:

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

See Also:

BlackoutSlateNetworkEndBlackout

networkEndBlackoutAsString

public String networkEndBlackoutAsString()

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

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

Returns:

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

See Also:

BlackoutSlateNetworkEndBlackout

networkEndBlackoutImage

public InputLocation networkEndBlackoutImage()

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

Returns:

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

networkId

public String networkId()

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

Returns:

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

state

public BlackoutSlateState state()

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

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

Returns:

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

See Also:

BlackoutSlateState

stateAsString

public String stateAsString()

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

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

Returns:

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

See Also:

BlackoutSlateState

toBuilder

public BlackoutSlate.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<BlackoutSlate.Builder,BlackoutSlate>

Returns:

a builder for type T

builder

public static BlackoutSlate.Builder builder()

serializableBuilderClass

public static Class<? extends BlackoutSlate.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.