COggData Class Reference

#include <OggData.h>

Inheritance diagram for COggData:

Collaboration diagram for COggData:

Public Member Functions
	COggData ()
virtual	~COggData ()
virtual bool	InitOggFile (const VfsPath &itemPath)
virtual bool	IsFileFinished ()
virtual bool	IsOneShot ()
virtual bool	IsStereo ()
virtual int	FetchDataIntoBuffer (int count, ALuint *buffers)
virtual void	ResetFile ()
Public Member Functions inherited from CSoundData
	CSoundData ()
virtual	~CSoundData ()
CSoundData *	IncrementCount ()
bool	DecrementCount ()
virtual bool	IsOneShot ()
virtual bool	IsStereo ()
virtual unsigned int	GetBuffer ()
virtual int	GetBufferCount ()
virtual const Path &	GetFileName ()
virtual void	SetFileName (const Path &aName)
virtual unsigned int *	GetBufferPtr ()

Protected Member Functions
bool	AddDataBuffer (char *data, long length)
void	SetFormatAndFreq (int form, ALsizei freq)
int	GetBufferCount ()
unsigned int	GetBuffer ()
unsigned int *	GetBufferPtr ()

Protected Attributes
OggStreamPtr	ogg
bool	m_FileFinished
bool	m_OneShot
ALuint	m_Buffer [100]
int	m_BuffersUsed
Protected Attributes inherited from CSoundData
unsigned int	m_ALBuffer
int	m_RetentionCount
Path	m_FileName

Private Attributes
ALuint	m_Format
long	m_Frequency

Additional Inherited Members
Static Public Member Functions inherited from CSoundData
static CSoundData *	SoundDataFromFile (const VfsPath &itemPath)
static CSoundData *	SoundDataFromOgg (const VfsPath &itemPath)
static void	ReleaseSoundData (CSoundData *theData)
Static Protected Attributes inherited from CSoundData
static DataMap	sSoundData

Constructor & Destructor Documentation

COggData()

COggData::COggData

(

)

~COggData()

COggData::~COggData ( )

virtual

Member Function Documentation

AddDataBuffer()

bool COggData::AddDataBuffer ( char *  data, long  length  )

protected

FetchDataIntoBuffer()

int COggData::FetchDataIntoBuffer ( int  count, ALuint *  buffers  )

virtual

GetBuffer()

ALuint COggData::GetBuffer ( )

protectedvirtual

Reimplemented from CSoundData.

GetBufferCount()

ALsizei COggData::GetBufferCount ( )

protectedvirtual

Reimplemented from CSoundData.

GetBufferPtr()

ALuint * COggData::GetBufferPtr ( )

protectedvirtual

Reimplemented from CSoundData.

InitOggFile()

bool COggData::InitOggFile ( const VfsPath &  itemPath )

virtual

IsFileFinished()

bool COggData::IsFileFinished ( )

virtual

IsOneShot()

bool COggData::IsOneShot ( )

virtual

Reimplemented from CSoundData.

IsStereo()

bool COggData::IsStereo ( )

virtual

Reimplemented from CSoundData.

ResetFile()

void COggData::ResetFile ( )

virtual

SetFormatAndFreq()

void COggData::SetFormatAndFreq ( int  form, ALsizei  freq  )

protected

Member Data Documentation

m_Buffer

ALuint COggData::m_Buffer[100]

protected

m_BuffersUsed

int COggData::m_BuffersUsed

protected

m_FileFinished

bool COggData::m_FileFinished

protected

m_Format

ALuint COggData::m_Format

private

m_Frequency

long COggData::m_Frequency

private

m_OneShot

bool COggData::m_OneShot

protected

ogg

OggStreamPtr COggData::ogg

protected

---

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

• /home/docker/jenkins/workspace/technical-docs/source/soundmanager/data/OggData.h
• /home/docker/jenkins/workspace/technical-docs/source/soundmanager/data/OggData.cpp