Skip to content
v2.275.0

VideoBlackFailoverSettingsProperty Struct ​

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

The parent of this entity is FailoverConditionSettings.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_medialive as medialive } from 'aws-cdk-lib';
const videoBlackFailoverSettingsProperty: medialive.CfnChannel.VideoBlackFailoverSettingsProperty = {
  blackDetectThreshold: 123,
  videoBlackThresholdMsec: 123,
};

Properties ​

blackDetectThresholdoptionalnumberblack_detect_thresholdoptionalint | floatblackDetectThresholdoptionalNumberBlackDetectThresholdoptionaldoubleBlackDetectThresholdoptional*float64#
A value used in calculating the threshold below which MediaLive considers a pixel to be 'black'.
notes

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.

videoBlackThresholdMsecoptionalnumbervideo_black_threshold_msecoptionalint | floatvideoBlackThresholdMsecoptionalNumberVideoBlackThresholdMsecoptionaldoubleVideoBlackThresholdMsecoptional*float64#
The amount of time (in milliseconds) that the active input must be black before automatic input failover occurs.