---

syn::OscIStream Class Template Reference

stream for any oscillator (see generator.h for oscillators). More...

#include <OscIStream.h>

Inheritance diagram for syn::OscIStream:

[legend]Collaboration diagram for syn::OscIStream:

[legend]List of all members.

Public Methods
	OscIStream ()
virtual	~OscIStream ()
virtual bool	open (const syn::AudioFormat &fmt, Operation op=COPY)
	open the stream specify the audio format you would like returned (independant of file attributes). More...
virtual void	read (void *data, unsigned int samples)
	read data out of the stream in the format you specified. More...
int	numsamps ()
virtual bool	close ()
	close the stream... More...
virtual bool	isOpen () const
virtual bool	eof () const
virtual bool	good () const
virtual bool	bad () const
virtual int	gcount () const
	returns num samples actually read by the last read() samples are in terms of [channels * bytes_per_samp]. More...
virtual void	setFreq (float freq)
virtual void	setAmp (float amplitude)
virtual void	setPhase (float phase)
virtual void	setDcOffset (float off)
virtual const AudioFormat&	format () const
Protected Attributes
bool	mIsOpen
int	mSampsRead
AudioFormat	mSourceFormat
	@clientCardinality 2. More...
AudioFormat	mDestFormat
	@clientCardinality 2. More...
std::vector<float>	mBuffer
float	mAmplitude
float	mDcOffset
float	mPhase
float	mFreq
float	p
float	dp
OSC_TYPE	mOsc

---

Detailed Description

template<typename OSC_TYPE> class syn::OscIStream

stream for any oscillator (see generator.h for oscillators).

think of this as a function generator stream (sine,tri,saw,noise,etc...)

Definition at line 46 of file OscIStream.h.

---

Constructor & Destructor Documentation

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

Definition at line 49 of file OscIStream.h.

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

Definition at line 53 of file OscIStream.h.

---

Member Function Documentation

template<typename OSC_TYPE> bool syn::OscIStream<OSC_TYPE>::open ( const syn::AudioFormat & fmt, Operation op = COPY ) [inline, virtual]

open the stream specify the audio format you would like returned (independant of file attributes). Reimplemented from syn::AudioIStream. Definition at line 59 of file OscIStream.h.

template<typename OSC_TYPE> void syn::OscIStream<OSC_TYPE>::read ( void * data, unsigned int samples ) [inline, virtual]

read data out of the stream in the format you specified. returns this->gcount(); samples are in terms of [channels * bytes_per_samp] Reimplemented from syn::AudioIStream. Definition at line 73 of file OscIStream.h.

template<typename OSC_TYPE> int syn::OscIStream<OSC_TYPE>::numsamps ( ) [inline]

Definition at line 96 of file OscIStream.h.

template<typename OSC_TYPE> bool syn::OscIStream<OSC_TYPE>::close ( ) [inline, virtual]

close the stream... Reimplemented from syn::AudioIStream. Definition at line 104 of file OscIStream.h.

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

Reimplemented from syn::AudioIStream. Definition at line 112 of file OscIStream.h.

template<typename OSC_TYPE> bool syn::OscIStream<OSC_TYPE>::eof ( ) const [inline, virtual]

Reimplemented from syn::AudioIStream. Definition at line 113 of file OscIStream.h.

template<typename OSC_TYPE> bool syn::OscIStream<OSC_TYPE>::good ( ) const [inline, virtual]

Reimplemented from syn::AudioIStream. Definition at line 114 of file OscIStream.h.

template<typename OSC_TYPE> bool syn::OscIStream<OSC_TYPE>::bad ( ) const [inline, virtual]

Reimplemented from syn::AudioIStream. Definition at line 115 of file OscIStream.h.

template<typename OSC_TYPE> int syn::OscIStream<OSC_TYPE>::gcount ( ) const [inline, virtual]

returns num samples actually read by the last read() samples are in terms of [channels * bytes_per_samp]. Reimplemented from syn::AudioIStream. Definition at line 120 of file OscIStream.h.

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

Definition at line 126 of file OscIStream.h.

template<typename OSC_TYPE> void syn::OscIStream<OSC_TYPE>::setAmp ( float amplitude ) [inline, virtual]

Definition at line 131 of file OscIStream.h.

template<typename OSC_TYPE> void syn::OscIStream<OSC_TYPE>::setPhase ( float phase ) [inline, virtual]

Definition at line 132 of file OscIStream.h.

template<typename OSC_TYPE> void syn::OscIStream<OSC_TYPE>::setDcOffset ( float off ) [inline, virtual]

Definition at line 133 of file OscIStream.h.

template<typename OSC_TYPE> const AudioFormat & syn::OscIStream<OSC_TYPE>::format ( ) const [inline, virtual]

Reimplemented from syn::AudioIStream. Definition at line 134 of file OscIStream.h.

---

Member Data Documentation

template<typename OSC_TYPE> bool syn::OscIStream<OSC_TYPE>::mIsOpen [protected]

Definition at line 136 of file OscIStream.h.

template<typename OSC_TYPE> int syn::OscIStream<OSC_TYPE>::mSampsRead [protected]

Definition at line 137 of file OscIStream.h.

template<typename OSC_TYPE> AudioFormat syn::OscIStream<OSC_TYPE>::mSourceFormat [protected]

@clientCardinality 2. Definition at line 142 of file OscIStream.h.

template<typename OSC_TYPE> AudioFormat syn::OscIStream<OSC_TYPE>::mDestFormat [protected]

@clientCardinality 2. Definition at line 142 of file OscIStream.h.

template<typename OSC_TYPE> std::vector< float > syn::OscIStream<OSC_TYPE>::mBuffer<float> [protected]

Definition at line 143 of file OscIStream.h.

template<typename OSC_TYPE> float syn::OscIStream<OSC_TYPE>::mAmplitude [protected]

Definition at line 146 of file OscIStream.h.

template<typename OSC_TYPE> float syn::OscIStream<OSC_TYPE>::mDcOffset [protected]

Definition at line 146 of file OscIStream.h.

template<typename OSC_TYPE> float syn::OscIStream<OSC_TYPE>::mPhase [protected]

Definition at line 147 of file OscIStream.h.

template<typename OSC_TYPE> float syn::OscIStream<OSC_TYPE>::mFreq [protected]

Definition at line 148 of file OscIStream.h.

template<typename OSC_TYPE> float syn::OscIStream<OSC_TYPE>::p [protected]

Definition at line 149 of file OscIStream.h.

template<typename OSC_TYPE> float syn::OscIStream<OSC_TYPE>::dp [protected]

Definition at line 149 of file OscIStream.h.

template<typename OSC_TYPE> OSC_TYPE syn::OscIStream<OSC_TYPE>::mOsc [protected]

Definition at line 150 of file OscIStream.h.

---

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

• /root/src/subsynth/syn/Stream/OscIStream.h

---