Class: AWSCDK::MediaLive::CfnChannel::GlobalConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
media_live/cfn_channel.rb

Overview

The configuration settings that apply to the entire channel.

The parent of this entity is EncoderSettings.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(initial_audio_gain: nil, input_end_action: nil, input_loss_behavior: nil, output_locking_mode: nil, output_locking_settings: nil, output_timing_source: nil, support_low_framerate_inputs: nil) ⇒ GlobalConfigurationProperty

Returns a new instance of GlobalConfigurationProperty.

Parameters:

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

    The value to set the initial audio gain for the channel.

  • input_end_action (String, nil) (defaults to: nil) —

    Indicates the action to take when the current input completes (for example, end-of-file).

  • input_loss_behavior (AWSCDK::IResolvable, AWSCDK::MediaLive::CfnChannel::InputLossBehaviorProperty, nil) (defaults to: nil) —

    The settings for system actions when the input is lost.

  • output_locking_mode (String, nil) (defaults to: nil) —

    Indicates how MediaLive pipelines are synchronized.

  • output_locking_settings (AWSCDK::IResolvable, AWSCDK::MediaLive::CfnChannel::OutputLockingSettingsProperty, nil) (defaults to: nil)
  • output_timing_source (String, nil) (defaults to: nil) —

    Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally might be locked to another source through NTP) or should be locked to the clock of the source that is providing the input stream.

  • support_low_framerate_inputs (String, nil) (defaults to: nil) —

    Adjusts the video input buffer for streams with very low video frame rates.



6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
 
# File 'media_live/cfn_channel.rb', line 6028

def initialize(initial_audio_gain: nil, input_end_action: nil, input_loss_behavior: nil, output_locking_mode: nil, output_locking_settings: nil, output_timing_source: nil, support_low_framerate_inputs: nil)
  @initial_audio_gain = initial_audio_gain
  Jsii::Type.check_type(@initial_audio_gain, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "initialAudioGain") unless @initial_audio_gain.nil?
  @input_end_action = input_end_action
  Jsii::Type.check_type(@input_end_action, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "inputEndAction") unless @input_end_action.nil?
  @input_loss_behavior = input_loss_behavior.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::InputLossBehaviorProperty.new(**input_loss_behavior.transform_keys(&:to_sym)) : input_loss_behavior
  Jsii::Type.check_type(@input_loss_behavior, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5JbnB1dExvc3NCZWhhdmlvclByb3BlcnR5In1dfX0=")), "inputLossBehavior") unless @input_loss_behavior.nil?
  @output_locking_mode = output_locking_mode
  Jsii::Type.check_type(@output_locking_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outputLockingMode") unless @output_locking_mode.nil?
  @output_locking_settings = output_locking_settings.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::OutputLockingSettingsProperty.new(**output_locking_settings.transform_keys(&:to_sym)) : output_locking_settings
  Jsii::Type.check_type(@output_locking_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5PdXRwdXRMb2NraW5nU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "outputLockingSettings") unless @output_locking_settings.nil?
  @output_timing_source = output_timing_source
  Jsii::Type.check_type(@output_timing_source, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outputTimingSource") unless @output_timing_source.nil?
  @support_low_framerate_inputs = support_low_framerate_inputs
  Jsii::Type.check_type(@support_low_framerate_inputs, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "supportLowFramerateInputs") unless @support_low_framerate_inputs.nil?
end

Instance Attribute Details

#initial_audio_gain ⇒ Numeric? (readonly)

The value to set the initial audio gain for the channel.

Returns:

  • (Numeric, nil)

See Also:



6049
6050
6051
 
# File 'media_live/cfn_channel.rb', line 6049

def initial_audio_gain
  @initial_audio_gain
end

#input_end_action ⇒ String? (readonly)

Indicates the action to take when the current input completes (for example, end-of-file).

When switchAndLoopInputs is configured, MediaLive restarts at the beginning of the first input. When "none" is configured, MediaLive transcodes either black, a solid color, or a user-specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API).

Returns:

  • (String, nil)

See Also:



6056
6057
6058
 
# File 'media_live/cfn_channel.rb', line 6056

def input_end_action
  @input_end_action
end

#input_loss_behavior ⇒ AWSCDK::IResolvable, ... (readonly)

The settings for system actions when the input is lost.

Returns:

See Also:



6061
6062
6063
 
# File 'media_live/cfn_channel.rb', line 6061

def input_loss_behavior
  @input_loss_behavior
end

#output_locking_mode ⇒ String? (readonly)

Indicates how MediaLive pipelines are synchronized.

PIPELINELOCKING - MediaLive attempts to synchronize the output of each pipeline to the other. EPOCHLOCKING - MediaLive attempts to synchronize the output of each pipeline to the Unix epoch.

Returns:

  • (String, nil)

See Also:



6068
6069
6070
 
# File 'media_live/cfn_channel.rb', line 6068

def output_locking_mode
  @output_locking_mode
end

#output_locking_settings ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



6071
6072
6073
 
# File 'media_live/cfn_channel.rb', line 6071

def output_locking_settings
  @output_locking_settings
end

#output_timing_source ⇒ String? (readonly)

Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally might be locked to another source through NTP) or should be locked to the clock of the source that is providing the input stream.

Returns:

  • (String, nil)

See Also:



6076
6077
6078
 
# File 'media_live/cfn_channel.rb', line 6076

def output_timing_source
  @output_timing_source
end

#support_low_framerate_inputs ⇒ String? (readonly)

Adjusts the video input buffer for streams with very low video frame rates.

This is commonly set to enabled for music channels with less than one video frame per second.

Returns:

  • (String, nil)

See Also:



6083
6084
6085
 
# File 'media_live/cfn_channel.rb', line 6083

def support_low_framerate_inputs
  @support_low_framerate_inputs
end

Class Method Details

.jsii_properties ⇒ Object 



6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
 
# File 'media_live/cfn_channel.rb', line 6085

def self.jsii_properties
  {
    :initial_audio_gain => "initialAudioGain",
    :input_end_action => "inputEndAction",
    :input_loss_behavior => "inputLossBehavior",
    :output_locking_mode => "outputLockingMode",
    :output_locking_settings => "outputLockingSettings",
    :output_timing_source => "outputTimingSource",
    :support_low_framerate_inputs => "supportLowFramerateInputs",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
 
# File 'media_live/cfn_channel.rb', line 6097

def to_jsii
  result = {}
  result.merge!({
    "initialAudioGain" => @initial_audio_gain,
    "inputEndAction" => @input_end_action,
    "inputLossBehavior" => @input_loss_behavior,
    "outputLockingMode" => @output_locking_mode,
    "outputLockingSettings" => @output_locking_settings,
    "outputTimingSource" => @output_timing_source,
    "supportLowFramerateInputs" => @support_low_framerate_inputs,
  })
  result.compact
end