Class: FMOD::Effects::ParamEq Deprecated

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

Overview

Deprecated.

Will be removed in a future FMOD version. See MultibandEq for alternatives.

This unit attenuates or amplifies a selected frequency range.

Parametric EQ is a single band peaking EQ filter that attenuates or amplifies a selected frequency and its neighbouring frequencies.

When a frequency has its gain set to 1.0, the sound will be unaffected and represents the original signal exactly.

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

#bandwidth ⇒ Float

Octave range around the center frequency to filter.

  • Minimum: 0.2

  • Maximum: 5.0

  • Default: 1.0

Returns:

  • (Float) —

    the current value of bandwidth



30
31
32
 
# File 'lib/fmod/effects/param_eq.rb', line 30

def bandwidth
  @bandwidth
end

#center ⇒ Float

Frequency center.

  • Minimum: 20.0

  • Maximum: 22000.0

  • Default: 8000.0

Returns:

  • (Float) —

    the current value of center



30
31
32
 
# File 'lib/fmod/effects/param_eq.rb', line 30

def center
  @center
end

#gain ⇒ Float

Frequency gain in dB.

  • Minimum: -30.0

  • Maximum: 30.0

  • Default: 0.0

Returns:

  • (Float) —

    the current value of gain



30
31
32
 
# File 'lib/fmod/effects/param_eq.rb', line 30

def gain
  @gain
end