Class: FMOD::Effects::ConvolutionReverb

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

Overview

This unit implements convolution reverb.

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

#dry ⇒ Float

Original sound volume in dB.

  • Minimum: -80.0

  • Maximum: 10.0

  • Default: 0.0

Returns:

  • (Float) —

    the current value of dry



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

def dry
  @dry
end

#ir=(value) ⇒ Pointer|String (writeonly)

Array of signed 16-bit (short) PCM data to be used as reverb IR. First member of the array should be a 16-bit value (short) which specifies the number of channels. Array looks like [index 0 = channel_count][index 1+ = raw 16-bit PCM data].

Data is copied internally so source can be freed.

Parameters:

  • value (Pointer|String) —

    the value to set the attribute ir to.

Returns:

  • (Pointer|String) —

    the newly set value



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

def ir=(value)
  @ir = value
end

#linked ⇒ Boolean

Indicates if channels are mixed together before processing through the reverb.

  • Default: true

Returns:

  • (Boolean) —

    the current value of linked



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

def linked
  @linked
end

#wet ⇒ 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



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

def wet
  @wet
end