Class: AWSCDK::MediaLive::CfnChannel::VideoBlackFailoverSettingsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::MediaLive::CfnChannel::VideoBlackFailoverSettingsProperty

Defined in:

media_live/cfn_channel.rb

Overview

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

The parent of this entity is FailoverConditionSettings.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoblackfailoversettings.html

Instance Attribute Summary

• #black_detect_threshold ⇒ Numeric^? readonly

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

• #video_black_threshold_msec ⇒ Numeric^? readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(black_detect_threshold: nil, video_black_threshold_msec: nil) ⇒ VideoBlackFailoverSettingsProperty constructor

  A new instance of VideoBlackFailoverSettingsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(black_detect_threshold: nil, video_black_threshold_msec: nil) ⇒ VideoBlackFailoverSettingsProperty

Returns a new instance of VideoBlackFailoverSettingsProperty.

Parameters:

• black_detect_threshold (Numeric, nil) (defaults to: nil) —

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

• video_black_threshold_msec (Numeric, nil) (defaults to: nil) —

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

# File 'media_live/cfn_channel.rb', line 13819

def initialize(black_detect_threshold: nil, video_black_threshold_msec: nil)
  @black_detect_threshold = black_detect_threshold
  Jsii::Type.check_type(@black_detect_threshold, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "blackDetectThreshold") unless @black_detect_threshold.nil?
  @video_black_threshold_msec = video_black_threshold_msec
  Jsii::Type.check_type(@video_black_threshold_msec, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "videoBlackThresholdMsec") unless @video_black_threshold_msec.nil?
end

Instance Attribute Details

#black_detect_threshold ⇒ Numeric^? (readonly)

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: (1023*0.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: (255*0.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.

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoblackfailoversettings.html#cfn-medialive-channel-videoblackfailoversettings-blackdetectthreshold

# File 'media_live/cfn_channel.rb', line 13832

def black_detect_threshold
  @black_detect_threshold
end

#video_black_threshold_msec ⇒ Numeric^? (readonly)

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

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoblackfailoversettings.html#cfn-medialive-channel-videoblackfailoversettings-videoblackthresholdmsec

# File 'media_live/cfn_channel.rb', line 13837

def video_black_threshold_msec
  @video_black_threshold_msec
end

Class Method Details

.jsii_properties ⇒ Object

# File 'media_live/cfn_channel.rb', line 13839

def self.jsii_properties
  {
    :black_detect_threshold => "blackDetectThreshold",
    :video_black_threshold_msec => "videoBlackThresholdMsec",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'media_live/cfn_channel.rb', line 13846

def to_jsii
  result = {}
  result.merge!({
    "blackDetectThreshold" => @black_detect_threshold,
    "videoBlackThresholdMsec" => @video_black_threshold_msec,
  })
  result.compact
end