Engine::Audio #
Classes #
| Classes | Description |
|---|---|
| AudioBuffer | A simple audio buffer to hold PCM samples (class) |
| AudioManager | An audio manager that accepts multiple Audio::AudioBuffer instances. (class) |
Types #
| Member Types | Definition |
|---|---|
| Callback | Some callback function pointer type definition. (typedef) |
| Callback2 | Some callback function pointer type definition. (using) |
Functions #
| Member Functions | Description |
|---|---|
| doSomething | Do something with the buffer. (function) |
Types #
typedef Callback #
Defined in header <src/Audio/AudioBuffer.hpp>
typedef int(* Engine::Audio::Callback) (AudioBuffer &buffer, size_t offset);
Some callback function pointer type definition.
Parameters:
- buffer The buffer this callback is called from
- offset The offset of the buffer currently playing
Deprecated:
Use the Audio::Callback2 instead
using Callback2 #
Defined in header <src/Audio/AudioBuffer.hpp>
using Callback2 =
int(*)(AudioBuffer &buffer, size_t offset, void *user);
Some callback function pointer type definition.
Parameters:
- buffer The buffer this callback is called from
- offset The offset of the buffer currently playing
- user User specific data
Functions #
function doSomething #
Defined in header <src/Audio/AudioBuffer.hpp>
void
doSomething(AudioBuffer & buffer);
Do something with the buffer.
Exception Safety
Basic exception guarantee.
Updated on 2023-04-03