Class: FMOD::Effects::EnvelopeFollower Deprecated

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

Overview

Deprecated.

Deprecated and will be removed in a future release.

Note:

This unit does not affect the incoming signal.

This unit tracks the envelope of the input/side-chain signal.

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, #to_s

Constructor Details

This class inherits a constructor from FMOD::Handle

Instance Attribute Details

#attack ⇒ Float

Attack time (milliseconds).

  • Minimum: 0.1

  • Maximum: 1000.0

  • Default: 20.0

Returns:

  • (Float) —

    the current value of attack



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

def attack
  @attack
end

#envelope ⇒ Float (readonly)

Current value of the envelope.

  • Minimum: 0.0

  • Maximum: 1.0

Returns:

  • (Float) —

    the current value of envelope



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

def envelope
  @envelope
end

#release ⇒ Float

Release time (milliseconds).

  • Minimum: 10.0

  • Maximum: 5000.0

  • Default: 100.0

Returns:

  • (Float) —

    the current value of release



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

def release
  @release
end

#side_chain ⇒ Fiddle::Pointer|String

Whether to analyse the side-chain signal instead of the input signal.

Returns:

  • (Fiddle::Pointer|String) —

    the current value of side_chain



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

def side_chain
  @side_chain
end