OggVorbis Class Reference

#include <oggvorbis.h>

Inheritance diagram for OggVorbis:

List of all members.

Public Member Functions
	OggVorbis ()
int	setFilename (const char *filename)
int	open ()
int	close ()
int	fillBuffer (char *audioBuffer, int numBytes)
char *	getSoundPath ()

---

Detailed Description

Class for decoding of oggvorbis data to raw PCM data.

Author:

Bjoern Erik Nilsen & Fredrik B. Kjoelstad

---

Constructor & Destructor Documentation

OggVorbis::OggVorbis (   )

Initializes the member pointers to NULL.

---

Member Function Documentation

int OggVorbis::close (   )  [virtual]

Function for closing the file registered with setFilename. Returns: 0 on success, -1 on failure Implements AudioFormat.

int OggVorbis::fillBuffer (  char *  audioBuffer, int  numBytes )  [virtual]

Function to fill the buffer with PCM data. It fills the buffer with up to 'numBytes' bytes. Parameters: audioBuffer  the buffer to be filled numBytes  number of bytes available in the buffer Returns: number of bytes written to buffer Implements AudioFormat.

char * OggVorbis::getSoundPath (   )  [virtual]

Function for retrieving the sound path. Returns: the sound path Implements AudioFormat.

int OggVorbis::open (   )  [virtual]

Function for opening the file registered with setFilename. Returns: 0 on success, -1 on failure Implements AudioFormat.

int OggVorbis::setFilename (  const char *  filename  )  [virtual]

Function for registering the given filename to be an ogg file. This function checks that the file can be opened and that it is a valid ogg file. Parameters: filename  the filename to register Returns: zero on success, less than zero on failure. -1 = cannot open file for reading -2 = not a valid oggVorbis file Implements AudioFormat.

---

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

• skole/stopmotion/implementation/stopmotion/src/technical/audio/oggvorbis.h
• skole/stopmotion/implementation/stopmotion/src/technical/audio/oggvorbis.cpp

---