Package software.amazon.awscdk.services.medialive

Interface CfnChannel.VideoBlackFailoverSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannel.VideoBlackFailoverSettingsProperty.Jsii$Proxy

Enclosing class:

CfnChannel

@Stability(Stable)
public static interface CfnChannel.VideoBlackFailoverSettingsProperty
extends software.amazon.jsii.JsiiSerializable

MediaLive will perform a failover if content is considered black for the specified period.

The parent of this entity is FailoverConditionSettings.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.medialive.*;
 VideoBlackFailoverSettingsProperty videoBlackFailoverSettingsProperty = VideoBlackFailoverSettingsProperty.builder()
         .blackDetectThreshold(123)
         .videoBlackThresholdMsec(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnChannel.VideoBlackFailoverSettingsProperty.Builder	builder()
default Number	getBlackDetectThreshold()	A value used in calculating the threshold below which MediaLive considers a pixel to be 'black'.
default Number	getVideoBlackThresholdMsec()	The amount of time (in milliseconds) that the active input must be black before automatic input failover occurs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBlackDetectThreshold

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

A value used in calculating the threshold below which MediaLive considers a pixel to be 'black'.

For the input to be considered black, every pixel in a frame must be below this threshold. The threshold is calculated as a percentage (expressed as a decimal) of white. Therefore .1 means 10% white (or 90% black). Note how the formula works for any color depth. For example, if you set this field to 0.1 in 10-bit color depth: (10230.1=102.3), which means a pixel value of 102 or less is 'black'. If you set this field to .1 in an 8-bit color depth: (2550.1=25.5), which means a pixel value of 25 or less is 'black'. The range is 0.0 to 1.0, with any number of decimal places.

getVideoBlackThresholdMsec

@Stability(Stable)
@Nullable
default Number getVideoBlackThresholdMsec()

The amount of time (in milliseconds) that the active input must be black before automatic input failover occurs.

builder

@Stability(Stable)
static CfnChannel.VideoBlackFailoverSettingsProperty.Builder builder()

Returns:

a CfnChannel.VideoBlackFailoverSettingsProperty.Builder of CfnChannel.VideoBlackFailoverSettingsProperty