Emergency 2017 Dokumentation  v3.0.1
qsf::openal Namespace Reference

Namespaces

 detail
 

Classes

class  OpenALAudioBuffer
 OpenAL audio buffer resource class. More...
 
class  OpenALAudioManager
 OpenAL audio backend class. More...
 
class  OpenALAudioSource
 OpenAL audio source resource class. More...
 
class  OpenALStream
 Abstract OpenAL audio stream base class. More...
 
class  OpenALStreamMemory
 OpenAL memory stream class. More...
 
class  OpenALStreamOgg
 OpenAL Ogg stream. More...
 
class  OpenALStreamWav
 OpenAL Wav stream class. More...
 

Functions

bool loadOgg (File &file, std::vector< uint8 > &buffer, ALenum &format, ALsizei &frequency)
 This function loads a OGG-file stream into a memory buffer and returns the format and frequency. More...
 
bool loadOgg (const uint8 *data, uint32 numberOfBytes, std::vector< uint8 > &buffer, ALenum &format, ALsizei &frequency)
 This function loads a OGG-buffer into a memory buffer and returns the format and frequency. More...
 
bool peekOgg (File &file, uint64 &bufferSize, ALenum &format, ALsizei &frequency)
 This function loads a OGG-file stream into a memory buffer and returns the format and frequency. More...
 
bool peekOgg (const uint8 *data, uint32 numberOfBytes, uint64 &bufferSize, ALenum &format, ALsizei &frequency)
 This function loads a OGG-file stream into a memory buffer and returns the format and frequency. More...
 
bool loadWav (File &file, std::vector< uint8 > &buffer, ALenum &format, ALsizei &frequency)
 This function loads a WAV-file stream into a memory buffer and returns the format and frequency. More...
 
bool loadWav (const uint8 *data, uint32 numberOfBytes, std::vector< uint8 > &buffer, ALenum &format, ALsizei &frequency)
 This function loads a WAV-buffer into a memory buffer and returns the format and frequency. More...
 
bool peekWav (File &file, uint64 &bufferSize, ALenum &format, ALsizei &frequency)
 This function loads a WAV-file stream into a memory buffer and returns the format and frequency. More...
 
bool peekWav (const uint8 *data, uint32 numberOfBytes, uint64 &bufferSize, ALenum &format, ALsizei &frequency)
 This function loads a WAV-file stream into a memory buffer and returns the format and frequency. More...
 

Function Documentation

bool qsf::openal::loadOgg ( File file,
std::vector< uint8 > &  buffer,
ALenum &  format,
ALsizei &  frequency 
)

This function loads a OGG-file stream into a memory buffer and returns the format and frequency.

Parameters
[in]fileAudio file, must be valid
[out]bufferWill receive the read buffer data, buffer is not cleared before adding new elements
[out]formatWill receive the format
[out]frequencyWill receive the frequency
Returns
"true" if all went fine and the file stream object was also destroyed automatically, else "false"
bool qsf::openal::loadOgg ( const uint8 data,
uint32  numberOfBytes,
std::vector< uint8 > &  buffer,
ALenum &  format,
ALsizei &  frequency 
)

This function loads a OGG-buffer into a memory buffer and returns the format and frequency.

Parameters
[in]dataData to read, must be valid
[in]numberOfBytesData size in bytes
[out]bufferWill receive the read buffer data, buffer is not cleared before adding new elements
[out]formatWill receive the format
[out]frequencyWill receive the frequency
Returns
"true" if all went fine, else "false"
bool qsf::openal::loadWav ( File file,
std::vector< uint8 > &  buffer,
ALenum &  format,
ALsizei &  frequency 
)

This function loads a WAV-file stream into a memory buffer and returns the format and frequency.

Parameters
[in]fileAudio file, must be valid
[out]bufferWill receive the read buffer data, buffer is not cleared before adding new elements
[out]formatWill receive the format
[out]frequencyWill receive the frequency
Returns
"true" if all went fine and the file stream object was also destroyed automatically, else "false"
bool qsf::openal::loadWav ( const uint8 data,
uint32  numberOfBytes,
std::vector< uint8 > &  buffer,
ALenum &  format,
ALsizei &  frequency 
)

This function loads a WAV-buffer into a memory buffer and returns the format and frequency.

Parameters
[in]dataData to read, must be valid
[in]numberOfBytesData size in bytes
[out]bufferWill receive the read buffer data, buffer is not cleared before adding new elements
[out]formatWill receive the format
[out]frequencyWill receive the frequency
Returns
"true" if all went fine, else "false"
bool qsf::openal::peekOgg ( File file,
uint64 bufferSize,
ALenum &  format,
ALsizei &  frequency 
)

This function loads a OGG-file stream into a memory buffer and returns the format and frequency.

Parameters
[in]fileAudio file, must be valid
[out]bufferWill receive the read buffer data, buffer is not cleared before adding new elements
[out]formatWill receive the format
[out]frequencyWill receive the frequency
Returns
"true" if all went fine and the file stream object was also destroyed automatically, else "false"

Does read metadata from the OGG header, but does not read sample data

bool qsf::openal::peekOgg ( const uint8 data,
uint32  numberOfBytes,
uint64 bufferSize,
ALenum &  format,
ALsizei &  frequency 
)

This function loads a OGG-file stream into a memory buffer and returns the format and frequency.

Parameters
[in]fileAudio file, must be valid
[out]bufferWill receive the read buffer data, buffer is not cleared before adding new elements
[out]formatWill receive the format
[out]frequencyWill receive the frequency
Returns
"true" if all went fine and the file stream object was also destroyed automatically, else "false"

Does read metadata from the OGG header, but does not read sample data

bool qsf::openal::peekWav ( File file,
uint64 bufferSize,
ALenum &  format,
ALsizei &  frequency 
)

This function loads a WAV-file stream into a memory buffer and returns the format and frequency.

Parameters
[in]fileAudio file, must be valid
[out]bufferWill receive the read buffer data, buffer is not cleared before adding new elements
[out]formatWill receive the format
[out]frequencyWill receive the frequency
Returns
"true" if all went fine and the file stream object was also destroyed automatically, else "false"

Does read metadata from the WAV header, but does not read sample data

bool qsf::openal::peekWav ( const uint8 data,
uint32  numberOfBytes,
uint64 bufferSize,
ALenum &  format,
ALsizei &  frequency 
)

This function loads a WAV-file stream into a memory buffer and returns the format and frequency.

Parameters
[in]fileAudio file, must be valid
[out]bufferWill receive the read buffer data, buffer is not cleared before adding new elements
[out]formatWill receive the format
[out]frequencyWill receive the frequency
Returns
"true" if all went fine and the file stream object was also destroyed automatically, else "false"

Does read metadata from the WAV header, but does not read sample data