Class: FMOD::Effects::SfxReverb

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

Overview

This unit implements SFX reverb.

This is a high quality I3DL2 based reverb.

On top of the I3DL2 property set, “Dry Level” is also included to allow the dry mix to be changed.

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

#decay_time ⇒ Float

Reverberation decay time at low-frequencies in milliseconds.

  • Minimum: 100.0

  • Maximum: 20000.0

  • Default: 1500

Returns:

  • (Float) —

    the current value of decay_time



71
72
73
 
# File 'lib/fmod/effects/sfx_reverb.rb', line 71

def decay_time
  @decay_time
end

#density ⇒ Float

Reverberation density (modal density) in percent.

  • Minimum: 0.0

  • Maximum: 100.0

  • Default: 100.0

Returns:

  • (Float) —

    the current value of density



71
72
73
 
# File 'lib/fmod/effects/sfx_reverb.rb', line 71

def density
  @density
end

#diffusion ⇒ Float

Reverberation diffusion (echo density) in percent.

  • Minimum: 0.0

  • Maximum: 100.0

  • Default: 100.0

Returns:

  • (Float) —

    the current value of diffusion



71
72
73
 
# File 'lib/fmod/effects/sfx_reverb.rb', line 71

def diffusion
  @diffusion
end

#dry_level ⇒ Float

Dry signal level in dB.

  • Minimum: -80.0

  • Maximum: 20.0

  • Default: 0.0

Returns:

  • (Float) —

    the current value of dry_level



71
72
73
 
# File 'lib/fmod/effects/sfx_reverb.rb', line 71

def dry_level
  @dry_level
end

#early_delay ⇒ Float

Delay time of first reflection in milliseconds.

  • Minimum: 0.0

  • Maximum: 300.0

  • Default: 20.0

Returns:

  • (Float) —

    the current value of early_delay



71
72
73
 
# File 'lib/fmod/effects/sfx_reverb.rb', line 71

def early_delay
  @early_delay
end

#early_late_mix ⇒ Float

Blend ratio of late reverb to early reflections in percent.

  • Minimum: 0.0

  • Maximum: 100.0

  • Default: 50.0

Returns:

  • (Float) —

    the current value of early_late_mix



71
72
73
 
# File 'lib/fmod/effects/sfx_reverb.rb', line 71

def early_late_mix
  @early_late_mix
end

#hf_decay_ratio ⇒ Float

High-frequency decay time relative to decay time in percent.

  • Minimum: 10.0

  • Maximum: 100.0

  • Default: 50.0

Returns:

  • (Float) —

    the current value of hf_decay_ratio



71
72
73
 
# File 'lib/fmod/effects/sfx_reverb.rb', line 71

def hf_decay_ratio
  @hf_decay_ratio
end

#hf_reference ⇒ Float

Reference frequency for high-frequency decay in Hz.

  • Minimum: 20.0

  • Maximum: 20000.0

  • Default: 5000.0

Returns:

  • (Float) —

    the current value of hf_reference



71
72
73
 
# File 'lib/fmod/effects/sfx_reverb.rb', line 71

def hf_reference
  @hf_reference
end

#high_cut ⇒ Float

Cutoff frequency of low-pass filter in Hz.

  • Minimum: 20.0

  • Maximum: 20000.0

  • Default: 20000.0

Returns:

  • (Float) —

    the current value of high_cut



71
72
73
 
# File 'lib/fmod/effects/sfx_reverb.rb', line 71

def high_cut
  @high_cut
end

#late_delay ⇒ Float

Late reverberation delay time relative to first reflection in milliseconds.

  • Minimum: 0.0

  • Maximum: 100.0

  • Default: 40.0

Returns:

  • (Float) —

    the current value of late_delay



71
72
73
 
# File 'lib/fmod/effects/sfx_reverb.rb', line 71

def late_delay
  @late_delay
end

#low_shelf_frequency ⇒ Float

Transition frequency of low-shelf filter in Hz.

  • Minimum: 20.0

  • Maximum: 1000.0

  • Default: 250.0

Returns:

  • (Float) —

    the current value of low_shelf_frequency



71
72
73
 
# File 'lib/fmod/effects/sfx_reverb.rb', line 71

def low_shelf_frequency
  @low_shelf_frequency
end

#low_shelf_gain ⇒ Float

Gain of low-shelf filter in dB.

  • Minimum: -36.0

  • Maximum: 12.0

  • Default: 0.0

Returns:

  • (Float) —

    the current value of low_shelf_gain



71
72
73
 
# File 'lib/fmod/effects/sfx_reverb.rb', line 71

def low_shelf_gain
  @low_shelf_gain
end

#wet_level ⇒ Float

Reverb signal level in dB.

  • Minimum: -80.0

  • Maximum: 20.0

  • Default: -6.0

Returns:

  • (Float) —

    the current value of wet_level



71
72
73
 
# File 'lib/fmod/effects/sfx_reverb.rb', line 71

def wet_level
  @wet_level
end