java.lang.Object
- software.amazon.awssdk.services.medialive.model.BlackoutSlate

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<BlackoutSlate.Builder,BlackoutSlate>

@Generated("software.amazon.awssdk:codegen")
public final class BlackoutSlate
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BlackoutSlate.Builder,BlackoutSlate>

Blackout Slate

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface BlackoutSlate.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`InputLocation`	`blackoutSlateImage()`	Blackout slate image to be used.
`static BlackoutSlate.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`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").
`List<SdkField<?>>`	`sdkFields()`
`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()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - blackoutSlateImage
```
public final 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 final 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 final 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 final 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 final 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 final 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 final 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<BlackoutSlate.Builder,BlackoutSlate>
  - builder
```
public static BlackoutSlate.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends BlackoutSlate.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class BlackoutSlate

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

blackoutSlateImage

networkEndBlackout

networkEndBlackoutAsString

networkEndBlackoutImage

networkId

state

stateAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields