ALAudioDevice class
OpenAL implementation of IAudioDevice.
Owns the OpenAL device and context, manages a fixed pool of sources and tracks the active players. On desktop Windows it also listens for default device changes and recreates the device when needed.
Base classes
- class AudioDeviceBase
- Backend-independent part of an audio device.
Constructors, destructors, conversion operators
- ALAudioDevice()
- ~ALAudioDevice() override
Public functions
- auto IsValid() const -> bool override
- Returns
trueif the device was initialized successfully. - auto GetName() const -> const char* override
- Returns the name of the underlying device.
- void SetGain(float gain) override
- Sets the listener gain (master volume).
- void UpdateListener(const Vector3f& position, const Vector3f& velocity) override
- Updates the position and velocity of the listener.
-
auto GetNativeFrequency() -> std::
int32_t override - Returns the native sample rate of the device.
-
auto CreateBuffer(BufferUsage usage) -> std::
uint32_t override - Creates an empty backend buffer, returning its id or
0on failure. -
void DeleteBuffer(std::
uint32_t bufferId) override - Destroys a buffer previously returned by CreateBuffer().
-
auto UploadBuffer(std::
uint32_t bufferId, BufferFormat format, const void* data, std:: int32_t size, std:: int32_t frequency) -> bool override - Replaces the contents of a buffer with the specified samples.
-
void SetSourceBuffer(std::
uint32_t sourceId, std:: uint32_t bufferId) override - Attaches a buffer to a source for non-streamed playback,
0detaches the current one. -
void SetSourceGain(std::
uint32_t sourceId, float gain) override - Sets the gain of a source.
-
void SetSourcePitch(std::
uint32_t sourceId, float pitch) override - Sets the pitch of a source, as a multiplier of its natural playback rate.
-
void SetSourceLooping(std::
uint32_t sourceId, bool looping) override - Sets whether a source repeats its attached buffer.
-
void SetSourceRelative(std::
uint32_t sourceId, bool relative) override - Sets whether the position of a source is relative to the listener.
-
void SetSourcePosition(std::
uint32_t sourceId, const Vector3f& position) override - Sets the position of a source, in physical units.
-
void SetSourceLowPass(std::
uint32_t sourceId, float value) override - Sets the low-pass amount of a source,
1.0fdisables the filter. -
auto GetSourceSampleOffset(std::
uint32_t sourceId) -> std:: int32_t override - Returns the playback position of a source in samples.
-
void SetSourceSampleOffset(std::
uint32_t sourceId, std:: int32_t offset) override - Sets the playback position of a source in samples.
-
void PlaySource(std::
uint32_t sourceId) override - Starts or resumes a source.
-
void PauseSource(std::
uint32_t sourceId) override - Pauses a source at its current position.
-
void StopSource(std::
uint32_t sourceId) override - Stops a source.
-
auto IsSourcePlaying(std::
uint32_t sourceId) -> bool override - Returns
trueif a source is still producing sound. -
void QueueBuffer(std::
uint32_t sourceId, std:: uint32_t bufferId) override - Appends a buffer to the streaming queue of a source.
-
auto GetProcessedBufferCount(std::
uint32_t sourceId) -> std:: int32_t override - Returns the number of queued buffers a source has finished playing.
-
void UnqueueBuffers(std::
uint32_t sourceId, std:: int32_t count, std:: uint32_t* bufferIds) override - Removes the specified number of played buffers from the front of the queue.
- void SuspendDevice() override
- Suspends the audio device.
- void ResumeDevice() override
- Resumes the audio device.
- void UpdatePlayers() override
- Updates the state of every registered player, including the buffer queue of stream players.
Function documentation
void nCine:: ALAudioDevice:: UnqueueBuffers(std:: uint32_t sourceId,
std:: int32_t count,
std:: uint32_t* bufferIds) override
Removes the specified number of played buffers from the front of the queue.
| Parameters | |
|---|---|
| sourceId | |
| count | |
| bufferIds | Receives the ids of the removed buffers, must hold count entries |