Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  

audiere::SineWave Class Reference

Inheritance diagram for audiere::SineWave:

Inheritance graph
[legend]
Collaboration diagram for audiere::SineWave:

Collaboration graph
[legend]
List of all members.

Public Methods

 SineWave (double frequency)
void ADR_CALL getFormat (int &channel_count, int &sample_rate, SampleFormat &sample_format)
int ADR_CALL read (int frame_count, void *buffer)
void ADR_CALL reset ()

Constructor & Destructor Documentation

audiere::SineWave::SineWave double    frequency [inline]
 

Definition at line 12 of file tone.cpp.


Member Function Documentation

void ADR_CALL audiere::SineWave::getFormat int &    channel_count,
int &    sample_rate,
SampleFormat   sample_format
[inline, virtual]
 

Retrieve the number of channels, sample rate, and sample format of the sample source.

Implements audiere::SampleSource.

Definition at line 17 of file tone.cpp.

References ADR_CALL, audiere::hidden::sample_format, audiere::SampleFormat, and audiere::SF_S16.

int ADR_CALL audiere::SineWave::read int    frame_count,
void *    buffer
[inline, virtual]
 

Read frame_count samples into buffer. buffer must be at least |frame_count * GetSampleSize(format) * channel_count| bytes long.

Parameters:
frame_count  number of frames to read
buffer  buffer to store samples in
Returns :
number of frames actually read

Implements audiere::SampleSource.

Definition at line 27 of file tone.cpp.

References ADR_CALL, and audiere::s16.

void ADR_CALL audiere::SineWave::reset   [inline, virtual]
 

Reset the sample source. This has the same effect as setPosition(0) on a seekable source. On an unseekable source, it resets all internal state to the way it was when the source was first created.

Implements audiere::SampleSource.

Definition at line 42 of file tone.cpp.

References ADR_CALL.


The documentation for this class was generated from the following file:
Generated on Sat Oct 12 01:44:30 2002 for audiere by doxygen1.2.17