---

syn::IStreamModule Class Reference

implements a Source Module concept for AudioIStreams this is basically an IStream -> Module adapter ports available in this module: amplitude (input) mono output (output). More...

#include <IStreamModule.h>

Inheritance diagram for syn::IStreamModule:

[legend]Collaboration diagram for syn::IStreamModule:

[legend]List of all members.

Public Methods
	IStreamModule ()
	default constructor. More...
virtual	~IStreamModule ()
	destructor. More...
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 Module*	clone () const
	get an exact copy of me. More...
void	setStream (AudioIStreamPtr &istream)
	set the arbitrary IStream. More...
void	trigger (float t=-1)
	trigger the sound (turn it on) specify amount of time to play before auto release() default: play infinitly when t == -1.0f. More...
void	release ()
	release the sound (turn it off). More...
parameter access
virtual void	getParam (const std::string &key, MultivariateType &value)
	a way to get module params without knowing the real funcs. More...
virtual void	setParam (const std::string &key, const MultivariateType &value)
	a way to set module params without knowing the real funcs. More...

---

Detailed Description

implements a Source Module concept for AudioIStreams this is basically an IStream -> Module adapter ports available in this module: amplitude (input) mono output (output).

• * -

Definition at line 52 of file IStreamModule.h.

---

Constructor & Destructor Documentation

syn::IStreamModule::IStreamModule ( )

default constructor. Definition at line 38 of file IStreamModule.cpp.

syn::IStreamModule::~IStreamModule ( ) [virtual]

destructor. Definition at line 47 of file IStreamModule.cpp.

---

Member Function Documentation

void syn::IStreamModule::update ( ) [virtual]

defines this module's task (or frame) function. Reimplemented from syn::Module. Definition at line 92 of file IStreamModule.cpp.

bool syn::IStreamModule::open ( ) [virtual]

modules need to be opened before they are used. Reimplemented from syn::Module. Definition at line 52 of file IStreamModule.cpp.

bool syn::IStreamModule::isOpen ( ) [virtual]

check to see if the module is open. Definition at line 51 of file IStreamModule.cpp. Referenced by update().

void syn::IStreamModule::close ( ) [virtual]

close the module when done with it. Reimplemented from syn::Module. Definition at line 66 of file IStreamModule.cpp.

Module * syn::IStreamModule::clone ( ) const [inline, virtual]

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

void syn::IStreamModule::getParam ( const std::string & key, MultivariateType & value ) [inline, virtual]

a way to get module params without knowing the real funcs. Reimplemented from syn::Module. Definition at line 86 of file IStreamModule.h.

void syn::IStreamModule::setParam ( const std::string & key, const MultivariateType & value ) [inline, virtual]

a way to set module params without knowing the real funcs. Reimplemented from syn::Module. Definition at line 91 of file IStreamModule.h.

void syn::IStreamModule::setStream ( AudioIStreamPtr & istream )

set the arbitrary IStream. Definition at line 74 of file IStreamModule.cpp.

void syn::IStreamModule::trigger ( float t = -1 )

trigger the sound (turn it on) specify amount of time to play before auto release() default: play infinitly when t == -1.0f. Definition at line 79 of file IStreamModule.cpp.

void syn::IStreamModule::release ( )

release the sound (turn it off). Definition at line 87 of file IStreamModule.cpp.

---

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

• /root/src/subsynth/syn/Module/IStreamModule.h
• /root/src/subsynth/syn/Module/IStreamModule.cpp

---