@aws-cdk/aws-medialive-alpha.AvailBlanking

Experimental

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

AvailBlanking Struct

Settings for blanking video, audio, and captions during ad avails.

Stability

Experimental

Source

lib/avail-settings.ts

Example

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

imageFileLocationimageFileLocationimageFileLocationImageFileLocationImageFileLocation= solid black#

A blanking image to display during ad avails.

Provide a FileLocation referencing an S3 bucket (FileLocation.fromBucket, which auto-grants read access) or a URL (FileLocation.url). Only .bmp and .png images are supported. If not set, solid black is used.

stateAvailBlankingStatestateAvailBlankingStatestateAvailBlankingStateStateAvailBlankingStateStateAvailBlankingState= ENABLED if image is provided, DI…#

Whether to blank the output during ad avails.

default

Default: ENABLED if image is provided, DISABLED otherwise