audiere::OGGInputStream Class Reference

#include <input_ogg.h>

Inheritance diagram for audiere::OGGInputStream:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 OGGInputStream ()
 ~OGGInputStream ()
bool initialize (FilePtr file)
void getFormat (int &channel_count, int &sample_rate, SampleFormat &sample_format)
int doRead (int frame_count, void *buffer)
void reset ()
bool isSeekable ()
int getLength ()
void setPosition (int position)
int getPosition ()

Detailed Description

Definition at line 12 of file input_ogg.h.


Constructor & Destructor Documentation

audiere::OGGInputStream::OGGInputStream  ) 
 

Definition at line 13 of file input_ogg.cpp.

References audiere::SF_S16.

audiere::OGGInputStream::~OGGInputStream  ) 
 

Definition at line 22 of file input_ogg.cpp.


Member Function Documentation

int audiere::OGGInputStream::doRead int  frame_count,
void *  buffer
[virtual]
 

Implement this method in subclasses.

Implements audiere::BasicSource.

Definition at line 96 of file input_ogg.cpp.

References ENDIANNESS, and audiere::GetSampleSize().

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 84 of file input_ogg.cpp.

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

Returns:
number of frames in the stream, or 0 if the stream is not seekable

Reimplemented from audiere::BasicSource.

Definition at line 159 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

Reimplemented from audiere::BasicSource.

Definition at line 177 of file input_ogg.cpp.

References isSeekable().

bool audiere::OGGInputStream::initialize FilePtr  file  ) 
 

Definition at line 31 of file input_ogg.cpp.

References audiere::BasicSource::addTag(), and audiere::RefPtr< T >::get().

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

Returns:
true if the stream is seekable, false otherwise

Reimplemented from audiere::BasicSource.

Definition at line 153 of file input_ogg.cpp.

Referenced by getLength(), getPosition(), and setPosition().

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 147 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

Reimplemented from audiere::BasicSource.

Definition at line 169 of file input_ogg.cpp.

References isSeekable().


The documentation for this class was generated from the following files:
Generated on Mon Feb 13 23:09:21 2006 for audiere by  doxygen 1.4.6