---

syn::OscModule Class Template Reference

Source Module for Osc concepts (see syn/Utils/Generator.h for osc) this is basically an Osc -> Module adapter ports available in this module: freq (input) mono audio (output). More...

#include <OscModule.h>

Inheritance diagram for syn::OscModule:

[legend]Collaboration diagram for syn::OscModule:

[legend]List of all members.

Public Methods
	OscModule ()
	default constructor. More...
virtual	~OscModule ()
	destructor. More...
virtual Module*	clone () const
	get an exact copy of me. More...
virtual float	freq () const
virtual float	freqControl () const
virtual float	freqControlSensitivity () const
virtual void	update ()
	defines this module's task (or frame) function. More...
virtual bool	open ()
	modules need to be opened before they are used. More...
virtual bool	isOpen ()
	check to see if the module is open. More...
virtual void	close ()
	close the module when done with it. More...
virtual void	setFreq (float freq)
	set frequency of emitted waveform in HZ. More...
virtual void	setFreqControl (float param)
	Set the sampling rate of the osc (alters frequency, aka. More...
virtual void	setFreqControlSensitivity (float octaves=1.0f)
	Set how sensative setFreq() is. More...
OSC_TYPE&	osc ()

---

Detailed Description

template<typename OSC_TYPE> class syn::OscModule

Source Module for Osc concepts (see syn/Utils/Generator.h for osc) this is basically an Osc -> Module adapter ports available in this module: freq (input) mono audio (output).

• * -

Definition at line 119 of file OscModule.h.

---

Constructor & Destructor Documentation

template<typename OSC_TYPE> syn::OscModule<OSC_TYPE>::OscModule<OSC_TYPE> ( ) [inline]

default constructor. Definition at line 123 of file OscModule.h.

template<typename OSC_TYPE> syn::OscModule<OSC_TYPE>::~OscModule<OSC_TYPE> ( ) [inline, virtual]

destructor. Definition at line 136 of file OscModule.h.

---

Member Function Documentation

template<typename OSC_TYPE> Module * syn::OscModule<OSC_TYPE>::clone ( ) const [inline, virtual]

get an exact copy of me. Reimplemented from syn::Module. Definition at line 141 of file OscModule.h.

template<typename OSC_TYPE> float syn::OscModule<OSC_TYPE>::freq ( ) const [inline, virtual]

Reimplemented from syn::OscModuleBase. Definition at line 150 of file OscModule.h.

template<typename OSC_TYPE> float syn::OscModule<OSC_TYPE>::freqControl ( ) const [inline, virtual]

Reimplemented from syn::OscModuleBase. Definition at line 151 of file OscModule.h.

template<typename OSC_TYPE> float syn::OscModule<OSC_TYPE>::freqControlSensitivity ( ) const [inline, virtual]

Reimplemented from syn::OscModuleBase. Definition at line 152 of file OscModule.h.

template<typename OSC_TYPE> void syn::OscModule<OSC_TYPE>::update ( ) [inline, virtual]

defines this module's task (or frame) function. Reimplemented from syn::Module. Definition at line 155 of file OscModule.h.

template<typename OSC_TYPE> bool syn::OscModule<OSC_TYPE>::open ( ) [inline, virtual]

modules need to be opened before they are used. Reimplemented from syn::Module. Definition at line 243 of file OscModule.h.

template<typename OSC_TYPE> bool syn::OscModule<OSC_TYPE>::isOpen ( ) [inline, virtual]

check to see if the module is open. Definition at line 253 of file OscModule.h.

template<typename OSC_TYPE> void syn::OscModule<OSC_TYPE>::close ( ) [inline, virtual]

close the module when done with it. Reimplemented from syn::Module. Definition at line 256 of file OscModule.h.

template<typename OSC_TYPE> void syn::OscModule<OSC_TYPE>::setFreq ( float freq ) [inline, virtual]

set frequency of emitted waveform in HZ. Parameters: freq   is a value between 20 and 22050 (typically) Reimplemented from syn::OscModuleBase. Definition at line 263 of file OscModule.h.

template<typename OSC_TYPE> void syn::OscModule<OSC_TYPE>::setFreqControl ( float param ) [inline, virtual]

Set the sampling rate of the osc (alters frequency, aka. pitch bend) Parameters: param   ranges from -1 to 1. param == 0 plays wavetable as is. param < 0 samples wavetable slower (lower pitch) param > 0 samples wavetable faster (raises pitch) The equation used for sample rate is == 2 ^ (freqSensitivity() * param). Musically, setFreq() changes the pitch by freqSensitivity() octaves. For example, when freqSensitivity() == 1 and when param == 1, the pitch is raised by one octave. For example, when freqSensitivity() == 1 and when param == -1, the pitch is lowered by one octave. Use setfreqSensitivity() to adjust the pitch bend sensitivity. See also: setfreqSensitivity Reimplemented from syn::OscModuleBase. Definition at line 280 of file OscModule.h.

template<typename OSC_TYPE> void syn::OscModule<OSC_TYPE>::setFreqControlSensitivity ( float octaves = 1.0f ) [inline, virtual]

Set how sensative setFreq() is. Musically, this affects by how many octaves setFreq() will affect the sound. Reimplemented from syn::OscModuleBase. Definition at line 288 of file OscModule.h.

template<typename OSC_TYPE> OSC_TYPE & syn::OscModule<OSC_TYPE>::osc ( ) [inline]

Definition at line 293 of file OscModule.h. Referenced by syn::AdsrEnvModule::getAttackTime(), syn::AdsrEnvModule::getDecayTime(), syn::AdsrEnvModule::getReleaseTime(), syn::AdsrEnvModule::getSustainLevel(), syn::AdsrEnvModule::release(), syn::AdsrEnvModule::setAttackTime(), syn::AdsrEnvModule::setDecayTime(), syn::AdsrEnvModule::setReleaseTime(), syn::AdsrEnvModule::setSustainLevel(), and syn::AdsrEnvModule::trigger().

---

The documentation for this class was generated from the following file:

• /root/src/subsynth/syn/Module/OscModule.h

---