---

syn::SampleBufferIStream Class Reference

#include <SampleBufferIStream.h>

Inheritance diagram for syn::SampleBufferIStream:

[legend]Collaboration diagram for syn::SampleBufferIStream:

[legend]List of all members.

Public Methods
	SampleBufferIStream ()
virtual	~SampleBufferIStream ()
void	setSampleBuf (const void *buf, unsigned int size, const syn::AudioFormat &fmt)
	set the data ptr that this stream will read from. More...
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...
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 const AudioFormat&	format () const

---

Constructor & Destructor Documentation

syn::SampleBufferIStream::SampleBufferIStream ( ) [inline]

Definition at line 43 of file SampleBufferIStream.h.

syn::SampleBufferIStream::~SampleBufferIStream ( ) [inline, virtual]

Definition at line 47 of file SampleBufferIStream.h.

---

Member Function Documentation

void syn::SampleBufferIStream::setSampleBuf ( const void * buf, unsigned int size, const syn::AudioFormat & fmt ) [inline]

set the data ptr that this stream will read from. be careful to not delete it before you use this stream this stream will not own, or delete this memory for you. Definition at line 53 of file SampleBufferIStream.h.

bool syn::SampleBufferIStream::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 65 of file SampleBufferIStream.h.

void syn::SampleBufferIStream::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 77 of file SampleBufferIStream.h.

bool syn::SampleBufferIStream::close ( ) [inline, virtual]

close the stream... Reimplemented from syn::AudioIStream. Definition at line 116 of file SampleBufferIStream.h.

bool syn::SampleBufferIStream::isOpen ( ) const [inline, virtual]

Reimplemented from syn::AudioIStream. Definition at line 122 of file SampleBufferIStream.h.

bool syn::SampleBufferIStream::eof ( ) const [inline, virtual]

Reimplemented from syn::AudioIStream. Definition at line 123 of file SampleBufferIStream.h.

bool syn::SampleBufferIStream::good ( ) const [inline, virtual]

Reimplemented from syn::AudioIStream. Definition at line 124 of file SampleBufferIStream.h.

bool syn::SampleBufferIStream::bad ( ) const [inline, virtual]

Reimplemented from syn::AudioIStream. Definition at line 125 of file SampleBufferIStream.h.

int syn::SampleBufferIStream::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 130 of file SampleBufferIStream.h.

const AudioFormat & syn::SampleBufferIStream::format ( ) const [inline, virtual]

Reimplemented from syn::AudioIStream. Definition at line 135 of file SampleBufferIStream.h.

---

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

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

---