AudioFile Class Reference
[Framework Module]

#include <audiofile.h>

Inheritance diagram for AudioFile:

List of all members.

---

Detailed Description

Provides read / write access to audio file.

This class is the base for all audio files.

Public Member Functions
	AudioFile ()
virtual	~AudioFile ()
virtual ulong_t	LoadBlock (ulong_t size, bool looping)=0
virtual ulong_t	LoadTimeBlock (double time, bool looping)=0
virtual void	Rewind ()=0
Format &	GetFormat ()
char *	GetData (bool close=false)
void	SetFormat (Format &format)
void	SetData (char *data, long size)
Protected Member Functions
virtual void	DeleteData ()
Protected Attributes
Format	format
	Format of audio data.
char *	data
	Memory buffer with data.
ulong_t	buff_size
	Size of loaded buffer. This size can be smaller than data_size when one block is loaded.
Classes
struct	Format

---

Constructor & Destructor Documentation

AudioFile::AudioFile

(

)

Constructor. Sets file mode to binary.

AudioFile::~AudioFile

(

)

[virtual]

Destructor.

---

Member Function Documentation

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

Implemented in OggAudioFile.

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

Implemented in OggAudioFile.

virtual void AudioFile::Rewind

(

)

[pure virtual]

Implemented in OggAudioFile.

AudioFile::Format & AudioFile::GetFormat

(

)

[inline]

Returns format of audio data.

Returns:

Format of audio data.

char * AudioFile::GetData

(

bool

close = false

)

Returns loaded audio data.

Parameters:

close

Whether file will be closed after returning the data.

Returns:

Format of audio data.

void AudioFile::SetFormat

(

Format &

format

)

[inline]

Sets format of audio data.

Parameters:

format

Format of audio data.

void AudioFile::SetData	(	char *	data,
		long	size
	)

Sets new audio data. Old data will be deleted.

Parameters:

	data	Buffer with new data.
	size	Size of buffer.

void AudioFile::DeleteData

(

)

[protected, virtual]

Deletes loaded data.

Implements DataFile.

---

Member Data Documentation

Format AudioFile::format [protected]

Format of audio data.

char* AudioFile::data [protected]

Memory buffer with data.

ulong_t AudioFile::buff_size [protected]

Size of loaded buffer. This size can be smaller than data_size when one block is loaded.

---

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

• D:/Projects/dark-oberon.svn/game/sources/framework/audiofile.h
• D:/Projects/dark-oberon.svn/game/sources/framework/audiofile.cpp

---