---

audiere::OGGInputStream Class Reference

#include <input_ogg.h>

Inheritance diagram for audiere::OGGInputStream:

[legend]Collaboration diagram for audiere::OGGInputStream:

[legend]List of all members.

Public Methods
	OGGInputStream ()
	~OGGInputStream ()
bool	initialize (File *file)
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 ()
bool ADR_CALL	isSeekable ()
int ADR_CALL	getLength ()
void ADR_CALL	setPosition (int position)
int ADR_CALL	getPosition ()

---

Constructor & Destructor Documentation

audiere::OGGInputStream::OGGInputStream (    )

Definition at line 12 of file input_ogg.cpp. References audiere::SF_S16.

audiere::OGGInputStream::~OGGInputStream (    )

Definition at line 21 of file input_ogg.cpp.

---

Member Function Documentation

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

Retrieve the number of channels, sample rate, and sample format of the sample source. Implements audiere::SampleSource. Definition at line 64 of file input_ogg.cpp. References audiere::hidden::sample_format, and audiere::SampleFormat.

int audiere::OGGInputStream::getLength (    )  [virtual]

Returns : number of frames in the stream, or 0 if the stream is not seekable Implements audiere::SampleSource. Definition at line 139 of file input_ogg.cpp. References isSeekable().

int audiere::OGGInputStream::getPosition (    )  [virtual]

Returns the current position within the sample source. Returns : current position in frames Implements audiere::SampleSource. Definition at line 157 of file input_ogg.cpp. References isSeekable().

bool audiere::OGGInputStream::initialize (  File *    file )

Definition at line 30 of file input_ogg.cpp. References audiere::SF_S16.

bool audiere::OGGInputStream::isSeekable (    )  [virtual]

Returns : true if the stream is seekable, false otherwise Implements audiere::SampleSource. Definition at line 133 of file input_ogg.cpp. Referenced by getLength(), getPosition(), and setPosition().

int audiere::OGGInputStream::read (  int    frame_count, void *    buffer )  [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 76 of file input_ogg.cpp. References audiere::GetSampleSize(), audiere::u32, and audiere::u8.

void audiere::OGGInputStream::reset (    )  [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 127 of file input_ogg.cpp.

void audiere::OGGInputStream::setPosition (  int    position )  [virtual]

Sets the current position within the sample source. If the stream is not seekable, this method does nothing. Parameters: position  current position in frames Implements audiere::SampleSource. Definition at line 149 of file input_ogg.cpp. References isSeekable().

---

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

• input_ogg.h
• input_ogg.cpp

---