Class: FMOD::Effects::Limiter

Inherits:
Dsp
  • Object
show all
Defined in:
lib/fmod/effects/limiter.rb

Overview

This unit limits the sound to a certain level.

Instance Attribute Summary collapse

Attributes inherited from Dsp

#active, #bypass, #channel_format, #input_count, #output_count, #parameter_count, #parent, #type, #wet_dry_mix

Attributes inherited from Handle

#user_data

Method Summary

Methods inherited from Dsp

#[], #[]=, #add_input, bool_param, data_param, #disconnect, #disconnect_from, #enable_metering, float_param, from_handle, #get_bool, #get_data, #get_float, #get_integer, #idle?, #info, #input, #input_connection, #input_metering?, integer_param, #name, #output, #output_connection, #output_format, #output_metering?, #param_info, #play, #reset, #set_bool, #set_data, #set_float, #set_integer, #set_wet_dry_mix, #show_dialog, #to_s, type_map, #version

Methods inherited from Handle

#initialize, #int_ptr, #release, #to_s

Constructor Details

This class inherits a constructor from FMOD::Handle

Instance Attribute Details

#ceiling ⇒ Float

Maximum level of the output signal in dB.

  • Minimum: -12.0

  • Maximum: 0.0

  • Default: 0.0

Returns:

  • (Float) —

    the current value of ceiling



25
26
27
 
# File 'lib/fmod/effects/limiter.rb', line 25

def ceiling
  @ceiling
end

#max_gain ⇒ Float

Maximum amplification allowed in dB. Higher values allow more boost.

  • Minimum: 0.0 (no amplification)

  • Maximum: 12.0

  • Default: 0.0

Returns:

  • (Float) —

    the current value of max_gain



25
26
27
 
# File 'lib/fmod/effects/limiter.rb', line 25

def max_gain
  @max_gain
end

#mode ⇒ Float

Channel processing mode. 0 or 1.

  • Minimum: 0.0 (independent, limiter per channel)

  • Maximum: 1.0 (linked)

  • Default: 0.0

Returns:

  • (Float) —

    the current value of mode



25
26
27
 
# File 'lib/fmod/effects/limiter.rb', line 25

def mode
  @mode
end

#release_time ⇒ Float

Time to ramp the silence to full in ms.

  • Minimum: 1.0

  • Maximum: 1000.0

  • Default: 10.0

Returns:

  • (Float) —

    the current value of release_time



25
26
27
 
# File 'lib/fmod/effects/limiter.rb', line 25

def release_time
  @release_time
end