Class: Aws::MediaLive::Types::AutomaticInputFailoverSettings

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb

Overview

Note:

When making an API call, you may pass AutomaticInputFailoverSettings data as a hash:

{
  error_clear_time_msec: 1,
  failover_conditions: [
    {
      failover_condition_settings: {
        audio_silence_settings: {
          audio_selector_name: "__string", # required
          audio_silence_threshold_msec: 1,
        },
        input_loss_settings: {
          input_loss_threshold_msec: 1,
        },
        video_black_settings: {
          black_detect_threshold: 1.0,
          video_black_threshold_msec: 1,
        },
      },
    },
  ],
  input_preference: "EQUAL_INPUT_PREFERENCE", # accepts EQUAL_INPUT_PREFERENCE, PRIMARY_INPUT_PREFERRED
  secondary_input_id: "__string", # required
}

The settings for Automatic Input Failover.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#error_clear_time_msecInteger

This clear time defines the requirement a recovered input must meet to be considered healthy. The input must have no failover conditions for this length of time. Enter a time in milliseconds. This value is particularly important if the input_preference for the failover pair is set to PRIMARY_INPUT_PREFERRED, because after this time, MediaLive will switch back to the primary input.

Returns:

  • (Integer)


1290
1291
1292
1293
1294
1295
1296
1297
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1290

class AutomaticInputFailoverSettings < Struct.new(
  :error_clear_time_msec,
  :failover_conditions,
  :input_preference,
  :secondary_input_id)
  SENSITIVE = []
  include Aws::Structure
end

#failover_conditionsArray<Types::FailoverCondition>

A list of failover conditions. If any of these conditions occur, MediaLive will perform a failover to the other input.

Returns:



1290
1291
1292
1293
1294
1295
1296
1297
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1290

class AutomaticInputFailoverSettings < Struct.new(
  :error_clear_time_msec,
  :failover_conditions,
  :input_preference,
  :secondary_input_id)
  SENSITIVE = []
  include Aws::Structure
end

#input_preferenceString

Input preference when deciding which input to make active when a previously failed input has recovered.

Returns:

  • (String)


1290
1291
1292
1293
1294
1295
1296
1297
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1290

class AutomaticInputFailoverSettings < Struct.new(
  :error_clear_time_msec,
  :failover_conditions,
  :input_preference,
  :secondary_input_id)
  SENSITIVE = []
  include Aws::Structure
end

#secondary_input_idString

The input ID of the secondary input in the automatic input failover pair.

Returns:

  • (String)


1290
1291
1292
1293
1294
1295
1296
1297
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1290

class AutomaticInputFailoverSettings < Struct.new(
  :error_clear_time_msec,
  :failover_conditions,
  :input_preference,
  :secondary_input_id)
  SENSITIVE = []
  include Aws::Structure
end