Guiliani  Version 2.6 revision 7293 (documentation build 12)
Public Member Functions | List of all members
CSndWrapLinux::CSound Class Reference

This class represents a sound file with filepointer, WAVE header and Sound Resource ID. More...

#include <SndWrapLinux.h>

Public Member Functions

eC_UByte * GetData () const
 
eC_UInt GetDataSize () const
 
SoundResource_t GetSoundID () const
 
const FileLoader::WaveLoader::FormatChunk_t & GetWaveFormat () const
 
void ReleaseData ()
 
void SetData (eC_UByte *pubData, const eC_UInt &uiDataSize, const eC_Bool &bAllocated)
 
void SetSoundID (const SoundResource_t eSoundID)
 
void SetWaveFormat (const FileLoader::WaveLoader::FormatChunk_t &kWaveFormat)
 

Detailed Description

This class represents a sound file with filepointer, WAVE header and Sound Resource ID.

Member Function Documentation

◆ GetData()

eC_UByte * CSndWrapLinux::CSound::GetData ( ) const
inline

Getter for the internal filepointer.

Returns
Internal filepointer.

◆ GetDataSize()

eC_UInt CSndWrapLinux::CSound::GetDataSize ( ) const
inline

Getter for the data size of assigned data.

Returns
Size of assigned data.

◆ GetSoundID()

SoundResource_t CSndWrapLinux::CSound::GetSoundID ( ) const
inline

Getter for the internal sound ID.

Returns
Internal sound ID.

◆ GetWaveFormat()

const FileLoader::WaveLoader::FormatChunk_t & CSndWrapLinux::CSound::GetWaveFormat ( ) const
inline

Getter for the wave-file-format.

Returns
Internal Wave-format.

◆ ReleaseData()

void CSndWrapLinux::CSound::ReleaseData ( )
inline

Release previously set data.

◆ SetData()

void CSndWrapLinux::CSound::SetData ( eC_UByte *  pubData,
const eC_UInt &  uiDataSize,
const eC_Bool &  bAllocated 
)
inline

Setter to set the internal memory data.

Parameters
pubDataMemory block to set
uiDataSizeSize of memory block
bAllocatedtrue if memory was allocated

◆ SetSoundID()

void CSndWrapLinux::CSound::SetSoundID ( const SoundResource_t  eSoundID)
inline

Setter to set the internal sound ID.

Parameters
eSoundIDsound ID to set.

◆ SetWaveFormat()

void CSndWrapLinux::CSound::SetWaveFormat ( const FileLoader::WaveLoader::FormatChunk_t &  kWaveFormat)
inline

Setter for the wave-file-format.

Parameters
kWaveFormatWave-format to set.
The documentation for this class was generated from the following file: