# Engine::Audio

# Classes

Name
class Engine::Audio::AudioBuffer
A simple audio buffer to hold PCM samples
class Engine::Audio::AudioManager
An audio manager that accepts multiple Audio::AudioBuffer instances.

# Types

Name
typedef int(*)(AudioBuffer &buffer, size_t offset) Callback
Some callback function pointer type definition.
using int(*)(AudioBuffer &buffer, size_t offset, void *user) Callback2
Some callback function pointer type definition.

# Functions

Name
void doSomething(AudioBuffer & buffer)
Do something with the buffer.

# Types Documentation

# typedef Callback

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

using Engine::Audio::Callback2 = typedef 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 Documentation

# function doSomething

void doSomething(
    AudioBuffer & buffer
)

Do something with the buffer.


Updated on 2021-10-12 at 20:06:46 +0000