Package software.amazon.awscdk.services.medialive.alpha

Interface AvailBlanking

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AvailBlanking.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:40.934Z")
@Stability(Experimental)
public interface AvailBlanking
extends software.amazon.jsii.JsiiSerializable

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

Example:

 Stack stack;
 IInput input;
 IBucket bucket;
 EncodeConfiguration video;
 Channel.Builder.create(stack, "Channel")
         .inputs(List.of(InputAttachment.builder().input(input).build()))
         .availBlanking(AvailBlanking.builder()
                 .state(AvailBlankingState.ENABLED)
                 .image(FileLocation.fromBucket(bucket, "slates/avail.png"))
                 .build())
         .blackoutSlate(BlackoutSlate.builder()
                 .state(BlackoutSlateState.ENABLED)
                 .image(FileLocation.fromBucket(bucket, "slates/blackout.png"))
                 .build())
         .outputGroups(List.of(OutputGroupConfiguration.hls(HlsOutputGroupProps.builder()
                 .name("hls")
                 .destinations(List.of(OutputDestination.toBucket(bucket, "live/stream")))
                 .outputs(List.of(HlsOutputDefinition.builder().encodes(List.of(video)).outputName("hls_out").build()))
                 .build())))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AvailBlanking.Builder	A builder for AvailBlanking
static final class	AvailBlanking.Jsii$Proxy	An implementation for AvailBlanking

Method Summary

Modifier and Type	Method	Description
static AvailBlanking.Builder	builder()
default FileLocation	getImage()	(experimental) A blanking image to display during ad avails.
default AvailBlankingState	getState()	(experimental) Whether to blank the output during ad avails.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getImage

@Stability(Experimental)
@Nullable
default FileLocation getImage()

(experimental) 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.

Default: - solid black

getState

@Stability(Experimental)
@Nullable
default AvailBlankingState getState()

(experimental) Whether to blank the output during ad avails.

Default: - ENABLED if image is provided, DISABLED otherwise

builder

@Stability(Experimental)
static AvailBlanking.Builder builder()

Returns:

a AvailBlanking.Builder of AvailBlanking