OggAudioFile Class Reference
[Formats Module]

#include <oggaudiofile.h>

Inheritance diagram for OggAudioFile:

List of all members.

---

Detailed Description

Provides read access to vorbis OGG image file.

Saving is not supported. External OGGVorbis library is used for decoding OGG files.

Public Member Functions
	OggAudioFile ()
virtual	~OggAudioFile ()
virtual bool	Open (bool write=false)
virtual void	Close ()
virtual ulong_t	LoadData ()
virtual ulong_t	LoadBlock (ulong_t size, bool looping)
virtual ulong_t	LoadTimeBlock (double time, bool looping)
virtual void	Rewind ()
Protected Member Functions
bool	CheckOVError (const long &)
Protected Attributes
OggVorbis_File	ogg_file
	Structure used for decoding OGG files.

---

Constructor & Destructor Documentation

OggAudioFile::OggAudioFile

(

)

Constructor.

OggAudioFile::~OggAudioFile

(

)

[virtual]

Destructor. Closes opened file.

---

Member Function Documentation

bool OggAudioFile::Open

(

bool

write = false

)

[virtual]

Opens OGG audio file.

Creates File object for access to file in filesystem. Then opens file using Vorbis codec and read its header.

Parameters:

write

Whether file will be opened for writing.

Returns:

True if successful.

Reimplemented from DataFile.

void OggAudioFile::Close

(

)

[virtual]

Closes OGG audio file. Terminates Vorbis codec, deletes data and File object. File has to be opened before.

Reimplemented from DataFile.

ulong_t OggAudioFile::LoadData

(

)

[virtual]

Loads audio data from opened OGG file.

Custom callback functions are used for accessing the file.

Returns:

Size of loaded data.

Reimplemented from DataFile.

ulong_t OggAudioFile::LoadBlock	(	ulong_t	size,
		bool	looping
	)			[virtual]

Loads one block of audio file. Length of this block is set in bytes.

Parameters:

	size	Length of audio block in bytes.
	looping	Whether looping is enabled.

Returns:

Size of loaded data in bytes.

Implements AudioFile.

ulong_t OggAudioFile::LoadTimeBlock	(	double	time,
		bool	looping
	)			[virtual]

Loads one block of audio file. Length of this block is set by time in seconds.

Parameters:

	time	Time length of audio block in seconds.
	looping	Whether looping is enabled.

Returns:

Size of loaded data in bytes.

Implements AudioFile.

void OggAudioFile::Rewind

(

)

[virtual]

Rewinds current position to the file beginning.

Implements AudioFile.

bool OggAudioFile::CheckOVError

(

const long &

read_count

)

[protected]

Checks and reports error code returned by Vorbis codec.

Parameters:

read_count

Value returned by various OV functions.

Returns:

True if error occures.

---

Member Data Documentation

OggVorbis_File OggAudioFile::ogg_file [protected]

Structure used for decoding OGG files.

---

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

• D:/Projects/dark-oberon.svn/game/sources/formats/oggaudiofile.h
• D:/Projects/dark-oberon.svn/game/sources/formats/oggaudiofile.cpp

---