AWS CDK Reference

Appearance

v2.274.0

BlackoutSlateProperty Struct ​

The settings for a blackout slate.

The parent of this entity is EncoderSettings.

Source
Generated code
Type last changed
v2.93.0 · 23 Aug 2023

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_medialive as medialive } from 'aws-cdk-lib';
const blackoutSlateProperty: medialive.CfnChannel.BlackoutSlateProperty = {
  blackoutSlateImage: {
    passwordParam: 'passwordParam',
    uri: 'uri',
    username: 'username',
  },
  networkEndBlackout: 'networkEndBlackout',
  networkEndBlackoutImage: {
    passwordParam: 'passwordParam',
    uri: 'uri',
    username: 'username',
  },
  networkId: 'networkId',
  state: 'state',
};

Properties ​

blackoutSlateImageoptionalIResolvable | CfnChannel.InputLocationPropertyblackout_slate_imageoptionaltyping.Union[IResolvable, InputLocationProperty]blackoutSlateImageoptionalIResolvableBlackoutSlateImageoptionalIResolvableBlackoutSlateImageoptionalinterface{}#
The blackout slate image to be used.

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

networkEndBlackoutoptionalstringnetwork_end_blackoutoptionalstrnetworkEndBlackoutoptionalStringNetworkEndBlackoutoptionalstringNetworkEndBlackoutoptional*string#
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.

networkEndBlackoutImageoptionalIResolvable | CfnChannel.InputLocationPropertynetwork_end_blackout_imageoptionaltyping.Union[IResolvable, InputLocationProperty]networkEndBlackoutImageoptionalIResolvableNetworkEndBlackoutImageoptionalIResolvableNetworkEndBlackoutImageoptionalinterface{}#
The path to the local file to use as the Network End Blackout image.

The image is scaled to fill the entire output raster.

networkIdoptionalstringnetwork_idoptionalstrnetworkIdoptionalStringNetworkIdoptionalstringNetworkIdoptional*string#
Provides a Network ID that matches EIDR ID format (for example, "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
stateoptionalstringstateoptionalstrstateoptionalStringStateoptionalstringStateoptional*string#
When set to enabled, this causes video, audio, and captions to be blanked when indicated by program metadata.