Class: FMOD::Effects::Flange

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

Overview

This unit produces a flange effect on the sound.

Flange is an effect where the signal is played twice at the same time, and one copy slides back and forth creating a whooshing or flanging effect.

As there are 2 copies of the same signal, by default each signal is given 50% mix, so that the total is not louder than the original unaffected signal.

Flange depth is a percentage of a 10ms shift from the original signal. Anything above 10ms is not considered flange because to the ear it begins to “echo” so 10ms is the highest value possible.

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

#depth ⇒ Float

Flange depth (percentage of 40ms delay).

  • Minimum: 0.01

  • Maximum: 1.0

  • Default: 1.0

Returns:

  • (Float) —

    the current value of depth



31
32
33
 
# File 'lib/fmod/effects/flange.rb', line 31

def depth
  @depth
end

#mix ⇒ Float

Percentage of wet signal in mix.

  • Minimum: 0.0

  • Maximum: 100.0

  • Default: 50.0

Returns:

  • (Float) —

    the current value of mix



31
32
33
 
# File 'lib/fmod/effects/flange.rb', line 31

def mix
  @mix
end

#rate ⇒ Float

Flange speed in Hz.

  • Minimum: 0.0

  • Maximum: 20.0

  • Default: 0.1

Returns:

  • (Float) —

    the current value of rate



31
32
33
 
# File 'lib/fmod/effects/flange.rb', line 31

def rate
  @rate
end