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

Interface VideoBlackFailoverProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

VideoBlackFailoverProps.Jsii$Proxy

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

(experimental) Properties for a video-black failover condition.

Example:

 Stack stack;
 IInput primaryInput;
 IInput secondaryInput;
 AudioSelector audioSelector;
 EncodeConfiguration video;
 EncodeConfiguration audio;
 IBucket bucket;
 Channel.Builder.create(stack, "Channel")
         .inputs(List.of(InputAttachment.builder()
                 .input(primaryInput)
                 .automaticInputFailover(AutomaticInputFailover.builder()
                         .secondaryInput(secondaryInput)
                         .inputPreference(InputPreference.PRIMARY_INPUT_PREFERRED)
                         .errorClearTime(Duration.seconds(3))
                         .failoverConditions(List.of(FailoverCondition.inputLoss(InputLossFailoverProps.builder().threshold(Duration.millis(1500)).build()), FailoverCondition.audioSilence(AudioSilenceFailoverProps.builder().audioSelector(audioSelector).threshold(Duration.seconds(2)).build()), FailoverCondition.videoBlack(VideoBlackFailoverProps.builder().blackDetectThreshold(0.1).threshold(Duration.seconds(1)).build())))
                         .build())
                 .build(), InputAttachment.builder()
                 // The secondary input must also be attached to the channel as its own input.
                 .input(secondaryInput)
                 .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, audio)).outputName("hls_out").build()))
                 .build())))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VideoBlackFailoverProps.Builder	builder()
default Number	getBlackDetectThreshold()	(experimental) The fraction of white (0.0–1.0) below which a pixel is considered black.
default Duration	getThreshold()	(experimental) How long the content must be black before failover occurs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBlackDetectThreshold

@Stability(Experimental)
@Nullable
default Number getBlackDetectThreshold()

(experimental) The fraction of white (0.0–1.0) below which a pixel is considered black. Every pixel in a frame must be below this threshold for the frame to count as black. For example, 0.1 means 10% white (90% black).

Default: - MediaLive service default

getThreshold

@Stability(Experimental)
@Nullable
default Duration getThreshold()

(experimental) How long the content must be black before failover occurs.

Default: - MediaLive service default

builder

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

Returns:

a VideoBlackFailoverProps.Builder of VideoBlackFailoverProps