Class: FMOD::Effects::ITEcho

Inherits:
Dsp
  • Object
show all
Defined in:
lib/fmod/effects/it_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.

As this is a stereo filter made mainly for IT playback, it is targeted for stereo signals. With mono signals only the #left_delay is used.

For multichannel signals (>2) there will be no echo on those channels.

This unit produces an echo on the sound and fades out at the desired rate as is used in Impulse Tracker.

This is effectively a software based echo filter that emulates the DirectX DMO echo effect. Impulse tracker files can support this, and FMOD will produce the effect on ANY platform, not just those that support DirectX effects!

Instance Attribute Summary collapse

Attributes inherited from Dsp

#active, #bypass, #channel_format, #input_count, #output_count, #parameter_count, #parent, #type

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

#feedback ⇒ Float

Percentage of output fed back into input.

  • Minimum: 0.0

  • Maximum: 100.0

  • Default: 50.0

Returns:

  • (Float) —

    the current value of feedback



48
49
50
 
# File 'lib/fmod/effects/it_echo.rb', line 48

def feedback
  @feedback
end

#left_delay ⇒ Float

Delay for left channel, in milliseconds.

  • Minimum: 1.0

  • Maximum: 2000.0

  • Default: 500.0

Returns:

  • (Float) —

    the current value of left_delay



48
49
50
 
# File 'lib/fmod/effects/it_echo.rb', line 48

def left_delay
  @left_delay
end

#pan_delay ⇒ Float

Note:

Currently not supported within the FMOD API.

Value that specifies whether to swap left and right delays with each successive echo. Ranges from 0.0 (equivalent to false) to 1.0 (equivalent to true), meaning no swap.

  • Minimum: 0.0

  • Maximum: 1.0

  • Default: 0.0

Returns:

  • (Float) —

    the current value of pan_delay



48
49
50
 
# File 'lib/fmod/effects/it_echo.rb', line 48

def pan_delay
  @pan_delay
end

#right_delay ⇒ Float

Delay for right channel, in milliseconds.

  • Minimum: 1.0

  • Maximum: 2000.0

  • Default: 500.0

Returns:

  • (Float) —

    the current value of right_delay



48
49
50
 
# File 'lib/fmod/effects/it_echo.rb', line 48

def right_delay
  @right_delay
end

#wet_dry_mix ⇒ Float

Ratio of wet (processed) signal to dry (unprocessed) signal.

  • Minimum: 0.0 (all dry)

  • Maximum: 100.0 (all wet)

  • Default: 50.0

Returns:

  • (Float) —

    the current value of wet_dry_mix



48
49
50
 
# File 'lib/fmod/effects/it_echo.rb', line 48

def wet_dry_mix
  @wet_dry_mix
end