Class: FMOD::Effects::Tremolo

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

Overview

This unit produces a tremolo / chopper effect on the sound.

The tremolo effect varies the amplitude of a sound. Depending on the settings, this unit can produce a tremolo, chopper or auto-pan effect.

The shape of the LFO (low freq. oscillator) can morphed between sine, triangle and sawtooth waves using the #shape and #skew parameters.

#duty and #square are useful for a chopper-type effect where the first controls the on-time duration and second controls the flatness of the envelope.

#spread varies the LFO phase between channels to get an auto-pan effect. This works best with a sine shape LFO.

The LFO can be synchronized using the #phase parameter which sets its instantaneous phase.

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

Tremolo depth.

  • Minimum: 0.0

  • Maximum: 1.0

  • Default: 1.0

Returns:

  • (Float) —

    the current value of depth



56
57
58
 
# File 'lib/fmod/effects/tremolo.rb', line 56

def depth
  @depth
end

#duty ⇒ Float

LFO on-time. 0 to 1.

  • Minimum: 0.0

  • Maximum: 1.0

  • Default: 0.5

Returns:

  • (Float) —

    the current value of duty



56
57
58
 
# File 'lib/fmod/effects/tremolo.rb', line 56

def duty
  @duty
end

#frequency ⇒ Float

LFO frequency in Hz.

  • Minimum: 0.1

  • Maximum: 20.0

  • Default: 5.0

Returns:

  • (Float) —

    the current value of frequency



56
57
58
 
# File 'lib/fmod/effects/tremolo.rb', line 56

def frequency
  @frequency
end

#phase ⇒ Float

Instantaneous LFO phase.

  • Minimum: 0.0

  • Maximum: 1.0

  • Default: 0.0

Returns:

  • (Float) —

    the current value of phase



56
57
58
 
# File 'lib/fmod/effects/tremolo.rb', line 56

def phase
  @phase
end

#shape ⇒ Float

LFO shape morph between triangle and sine.

  • Minimum: 0.0

  • Maximum: 1.0

  • Default: 0.0

Returns:

  • (Float) —

    the current value of shape



56
57
58
 
# File 'lib/fmod/effects/tremolo.rb', line 56

def shape
  @shape
end

#skew ⇒ Float

Time-skewing of LFO cycle.

  • Minimum: -1.0

  • Maximum: 1.0

  • Default: 0.0

Returns:

  • (Float) —

    the current value of skew



56
57
58
 
# File 'lib/fmod/effects/tremolo.rb', line 56

def skew
  @skew
end

#spread ⇒ Float

Rotation / auto-pan effect.

  • Minimum: -1.0

  • Maximum: 1.0

  • Default: 0.0

Returns:

  • (Float) —

    the current value of spread



56
57
58
 
# File 'lib/fmod/effects/tremolo.rb', line 56

def spread
  @spread
end

#square ⇒ Float

Flatness of the LFO shape.

  • Minimum: 0.0

  • Maximum: 1.0

  • Default: 0.0

Returns:

  • (Float) —

    the current value of square



56
57
58
 
# File 'lib/fmod/effects/tremolo.rb', line 56

def square
  @square
end