AAudioMixer Class Reference

Manages audio players and mixes them into one sound stream. More...

#include <AUI/Audio/AAudioMixer.h>

Public Member Functions#
void	addSoundSource (_< IAudioPlayer > s)
	Add new sound source for mixing.
void	removeSoundSource (const _< IAudioPlayer > &s)
	Remove sound source if it is represented in list of added sound sources, otherwise do nothing.
std::size_t	readSoundData (std::span< std::byte > destination)
	Write mixed audio data into buffer.

Detailed Description#

Warning

This API is experimental. Experimental APIs are likely to contain bugs, might be changed or removed in the future.

Member Function Documentation#

addSoundSource()#

void AAudioMixer::addSoundSource

(

_< IAudioPlayer >

s

)

Parameters

s	New sound source

readSoundData()#

std::size_t AAudioMixer::readSoundData

(

std::span< std::byte >

destination

)

Parameters

destination

Pre-allocated buffer to write into

Returns

Number of bytes written

removeSoundSource()#

void AAudioMixer::removeSoundSource

(

const _< IAudioPlayer > &

s

)

Parameters

s	Sound source to remove

© 2025 AUI Framework Contributors. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. All trademarks are property of their respective owners.

Contents

Public Member Functions

Detailed Description

View Page SourceEdit Page Source