interface BlackoutSlateProperty

Language	Type name
.NET	`Amazon.CDK.AWS.MediaLive.CfnChannel.BlackoutSlateProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsmedialive#CfnChannel_BlackoutSlateProperty`
Java	`software.amazon.awscdk.services.medialive.CfnChannel.BlackoutSlateProperty`
Python	`aws_cdk.aws_medialive.CfnChannel.BlackoutSlateProperty`
TypeScript	`aws-cdk-lib` » `aws_medialive` » `CfnChannel` » `BlackoutSlateProperty`

The settings for a blackout slate.

The parent of this entity is EncoderSettings.

Example

// 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

Name	Type	Description
blackoutSlateImage?	`IResolvable` `\|` `InputLocationProperty`	The blackout slate image to be used.
networkEndBlackout?	`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.
networkEndBlackoutImage?	`IResolvable` `\|` `InputLocationProperty`	The path to the local file to use as the Network End Blackout image.
networkId?	`string`	Provides a Network ID that matches EIDR ID format (for example, "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
state?	`string`	When set to enabled, this causes video, audio, and captions to be blanked when indicated by program metadata.

blackoutSlateImage?

Type: IResolvable | InputLocationProperty (optional)

The blackout slate image to be used.

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

networkEndBlackout?

Type: string (optional)

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.

networkEndBlackoutImage?

Type: IResolvable | InputLocationProperty (optional)

The path to the local file to use as the Network End Blackout image.

The image is scaled to fill the entire output raster.

networkId?

Type: string (optional)

Provides a Network ID that matches EIDR ID format (for example, "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").

state?

Type: string (optional)

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