Skip to content
v2.274.0

Experimental

@aws-cdk/aws-medialive-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

BlackoutSlateState Class ​

Blackout slate state.

Example ​

ts
declare const stack: Stack;
declare const input: medialive.IInput;
declare const bucket: s3.IBucket;
declare const video: medialive.EncodeConfiguration;

new medialive.Channel(stack, 'Channel', {
  inputs: [{ input }],
  availBlanking: {
    state: medialive.AvailBlankingState.ENABLED,
    image: medialive.FileLocation.fromBucket(bucket, 'slates/avail.png'),
  },
  blackoutSlate: {
    state: medialive.BlackoutSlateState.ENABLED,
    image: medialive.FileLocation.fromBucket(bucket, 'slates/blackout.png'),
  },
  outputGroups: [
    medialive.OutputGroupConfiguration.hls({
      name: 'hls',
      destinations: [medialive.OutputDestination.toBucket(bucket, 'live/stream')],
      outputs: [{ encodes: [video], outputName: 'hls_out' }],
    }),
  ],
});

Properties ​

Disable blackout slate.
Enable blackout slate.
valuestringvaluestrvalueStringValuestringValue*stringrequired#
The underlying string value passed to CloudFormation.

Methods ​

of(value: string): BlackoutSlateState // chainable@staticmethod def of(value: str) -> BlackoutSlateStatepublic static BlackoutSlateState of(String value)public static BlackoutSlateState Of(string value)func Of(Value *string) BlackoutSlateStatestatic#
A value not yet modelled by AWS CDK.