Interface CfnChannel.BlackoutSlateProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnChannel.BlackoutSlateProperty extends
The settings for a blackout slate.

The parent of this entity is EncoderSettings.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 BlackoutSlateProperty blackoutSlateProperty = BlackoutSlateProperty.builder()
  • Method Details

    • getBlackoutSlateImage

      @Stability(Stable) @Nullable default Object getBlackoutSlateImage()
      The blackout slate image to be used.

      Keep empty for solid black. Only .bmp and .png images are supported.

    • getNetworkEndBlackout

      @Stability(Stable) @Nullable default String getNetworkEndBlackout()
      Setting to enabled causes MediaLive 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 is 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.

    • getNetworkEndBlackoutImage

      @Stability(Stable) @Nullable default Object getNetworkEndBlackoutImage()
      The path to the local file to use as the Network End Blackout image.

      The image is scaled to fill the entire output raster.

    • getNetworkId

      @Stability(Stable) @Nullable default String getNetworkId()
      Provides a Network ID that matches EIDR ID format (for example, "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
    • getState

      @Stability(Stable) @Nullable default String getState()
      When set to enabled, this causes video, audio, and captions to be blanked when indicated by program metadata.
    • builder

      @Stability(Stable) static CfnChannel.BlackoutSlateProperty.Builder builder()
      a CfnChannel.BlackoutSlateProperty.Builder of CfnChannel.BlackoutSlateProperty