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

Interface BlackoutSlate

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BlackoutSlate.Jsii$Proxy

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

(experimental) Blackout slate configuration for the channel.

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	BlackoutSlate.Builder	A builder for BlackoutSlate
static final class	BlackoutSlate.Jsii$Proxy	An implementation for BlackoutSlate

Method Summary

Modifier and Type	Method	Description
static BlackoutSlate.Builder	builder()
default FileLocation	getImage()	(experimental) The blackout slate image.
default NetworkEndBlackout	getNetworkEndBlackout()	(experimental) Whether to enable network end blackout (triggered by SCTE-35 Network End Segmentation Descriptor).
default FileLocation	getNetworkEndBlackoutImage()	(experimental) The network end blackout image.
default String	getNetworkId()	(experimental) The EIDR network ID (e.g.
default BlackoutSlateState	getState()	(experimental) Whether to enable the blackout slate.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getImage

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

(experimental) The blackout slate image.

Provide a FileLocation referencing an S3 bucket (FileLocation.fromBucket, which auto-grants read access) or a URL (FileLocation.url). Only .bmp and .png supported.

Default: - solid black

getNetworkEndBlackout

@Stability(Experimental)
@Nullable
default NetworkEndBlackout getNetworkEndBlackout()

(experimental) Whether to enable network end blackout (triggered by SCTE-35 Network End Segmentation Descriptor).

Default: - ENABLED if networkEndBlackoutImage is provided, DISABLED otherwise

getNetworkEndBlackoutImage

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

(experimental) The network end blackout image.

Provide a FileLocation referencing an S3 bucket (FileLocation.fromBucket, which auto-grants read access) or a URL (FileLocation.url).

Default: - solid black

getNetworkId

@Stability(Experimental)
@Nullable
default String getNetworkId()

(experimental) The EIDR network ID (e.g. '10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C').

Default: - no network ID

getState

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

(experimental) Whether to enable the blackout slate.

Default: - ENABLED if image is provided, DISABLED otherwise

builder

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

Returns:

a BlackoutSlate.Builder of BlackoutSlate