audiere::SampleBuffer Class Reference

#include <audiere.h>

Inheritance diagram for audiere::SampleBuffer:

[legend]Collaboration diagram for audiere::SampleBuffer:

[legend]List of all members.

Public Member Functions
virtual void	getFormat (int &channel_count, int &sample_rate, SampleFormat &sample_format)=0
virtual int	getLength ()=0
virtual const void *	getSamples ()=0
virtual SampleSource *	openStream ()=0
Protected Member Functions
	~SampleBuffer ()

---

Detailed Description

A readonly sample container which can open sample streams as iterators through the buffer. This is commonly used in cases where a very large sound effect is loaded once into memory and then streamed several times to the audio device. This is more efficient memory-wise than loading the effect multiple times.

See also:

CreateSampleBuffer

Definition at line 786 of file audiere.h.

---

Constructor & Destructor Documentation

audiere::SampleBuffer::~SampleBuffer (   )  [inline, protected]

Definition at line 788 of file audiere.h.

---

Member Function Documentation

virtual void audiere::SampleBuffer::getFormat (  int &  channel_count, int &  sample_rate, SampleFormat &  sample_format )  [pure virtual]

Return the format of the sample data in the sample buffer. See also: SampleSource::getFormat

virtual int audiere::SampleBuffer::getLength (   )  [pure virtual]

Get the length of the sample buffer in frames.

virtual const void* audiere::SampleBuffer::getSamples (   )  [pure virtual]

Get a readonly pointer to the samples contained within the buffer. The buffer is |channel_count * frame_count * GetSampleSize(sample_format)| bytes long.

virtual SampleSource* audiere::SampleBuffer::openStream (   )  [pure virtual]

Open a seekable sample source using the samples contained in the buffer.

---

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

• audiere.h

---