Class: FMOD::Effects::Oscillator

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

Overview

This unit generates sine/square/saw/triangle or noise tones.

Constant Summary collapse

SINE =

Strongly-typed waveform shape for #waveform parameter.

0
SQUARE =

Strongly-typed waveform shape for #waveform parameter.

1
SAW_UP =

Strongly-typed waveform shape for #waveform parameter.

2
SAW_DOWN =

Strongly-typed waveform shape for #waveform parameter.

3
TRIANGLE =

Strongly-typed waveform shape for #waveform parameter.

4
NOISE =

Strongly-typed waveform shape for #waveform parameter.

5

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

#rate ⇒ Float

Frequency of the sine-wave in Hz.

  • Minimum: 1.0

  • Maximum: 22000.0

  • Default: 220.0

Returns:

  • (Float) —

    the current value of rate



22
23
24
 
# File 'lib/fmod/effects/oscillator.rb', line 22

def rate
  @rate
end

#waveform ⇒ Integer

Waveform type.

  • Minimum: 0

  • Maximum: 5

  • Default: 0 (sine)

Returns:

  • (Integer) —

    the current value of waveform

See Also:



22
23
24
 
# File 'lib/fmod/effects/oscillator.rb', line 22

def waveform
  @waveform
end