Class: FMOD::Effects::HighPassSimple Deprecated

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

Overview

Deprecated.

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

This unit filters sound using a simple high-pass with no resonance, but has flexible cutoff and is fast.

This is a very simple single-order high pass filter.

The emphasis is on speed rather than accuracy, so this should not be used for task requiring critical filtering.

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

#cutoff ⇒ Float

High-pass cutoff frequency in Hz.

  • Minimum: 10.0

  • Maximum: 22000.0

  • Default: 1000.0

Returns:

  • (Float) —

    the current value of cutoff



21
22
23
 
# File 'lib/fmod/effects/high_pass_simple.rb', line 21

def cutoff
  @cutoff
end