Class: FMOD::Effects::Echo

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

Overview

Note:

Every time the delay is changed, the plugin re-allocates the echo buffer. This means the echo will disappear at that time while it refills its new buffer.

Larger echo delays result in larger amounts of memory allocated.

This unit produces an echo on the sound and fades out at the desired rate.

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

#delay ⇒ Float

Echo delay in ms.

  • Minimum: 10.0

  • Maximum: 5000.0

  • Default: 500.0

Returns:

  • (Float) —

    the current value of delay



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

def delay
  @delay
end

#dry_level ⇒ Float

Original sound volume in dB.

  • Minimum: -80.0

  • Maximum: 10.0

  • Default: 0.0

Returns:

  • (Float) —

    the current value of dry_level



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

def dry_level
  @dry_level
end

#feedback ⇒ Float

Echo decay per delay.

  • Minimum: 0.0 (total decay)

  • Maximum: 100.0 (no decay)

  • Default: 50.0

Returns:

  • (Float) —

    the current value of feedback



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

def feedback
  @feedback
end

#wet_level ⇒ Float

Volume of echo signal to pass to output in dB.

  • Minimum: -80.0

  • Maximum: 10.0

  • Default: 0.0

Returns:

  • (Float) —

    the current value of wet_level



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

def wet_level
  @wet_level
end