Class BlackoutSlate

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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.