Class: FMOD::Effects::Chorus

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

Overview

This unit produces a chorus effect on the sound.

Chorus is an effect where the sound is more “spacious” due to 1 to 3 versions of the sound being played along side the original signal but with the pitch of each copy modulating on a sine wave.

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

Chorus modulation depth.

  • Minimum: 0.0

  • Maximum: 100.0

  • Default: 3.0

Returns:

  • (Float) —

    the current value of depth



24
25
26
 
# File 'lib/fmod/effects/chorus.rb', line 24

def depth
  @depth
end

#mix ⇒ Float

Volume of original signal to pass to output.

  • Minimum: 0.0

  • Maximum: 100.0

  • Default: 50.0

Returns:

  • (Float) —

    the current value of mix



24
25
26
 
# File 'lib/fmod/effects/chorus.rb', line 24

def mix
  @mix
end

#rate ⇒ Float

Chorus modulation rate in Hz.

  • Minimum: 0.0

  • Maximum: 20.0

  • Default: 0.8

Returns:

  • (Float) —

    the current value of rate



24
25
26
 
# File 'lib/fmod/effects/chorus.rb', line 24

def rate
  @rate
end