class

AudioSubmix

One node of the submix tree: a mixer group with its own fader, pitch and ordered effect chain, feeding its parent. Sources attach to a submix by name, so the five default buses (Master, Music, SFX, Voice, Ambient) are just the submixes the engine creates first, and a project adds its own under any of them (audio.submixes in Config/Engine.ini, or CreateSubmix at runtime). The engine owns every instance; a pointer stays valid until RemoveSubmix or Shutdown.

Module
Audio
Header
#include "Audio/AudioSubmix.h"
Namespace
Mowo

Signal flow: children and sources → group (fader, pitch) → effects in order → parent's group (the endpoint for the root).

Constructors

SignatureNameDescription
AudioSubmix()AudioSubmixEngine-only: the engine creates and destroys every submix.
~AudioSubmix()~AudioSubmix
AudioSubmix(const AudioSubmix&) = deleteAudioSubmix

Public functions

ReturnsNameDescription
const std::string&GetName
AudioSubmix*GetParent
const std::vector<AudioSubmix*>&GetChildren
boolIsRoot
boolIsUnderTrue when ancestor is this submix or any submix above it.
voidSetVolume
floatGetVolume
voidSetPitch
floatGetPitch
voidSetMutedMute keeps the fader value: unmuting restores it.
boolIsMuted
voidSetModulationParameter modulation (FAudioParameters::BindSubmix), multiplied onto the fader and the pitch.
floatGetModulationVolume
floatGetModulationPitch
boolAddEffectOrdered DSP chain between this group and the parent.
boolRemoveEffect
voidClearEffects
size_tGetEffectCount
AudioEffect*GetEffect
ma_sound_group*GetGroupWhere sources and child groups attach.
ma_node*GetInputNode
uint32_tGetAttachedSourceCount
voidAttachSource
voidDetachSource
AudioSubmix&operator=

Function details

AudioSubmix

C++
AudioSubmix()

Engine-only: the engine creates and destroys every submix. Public so the engine's Scope<> can construct and delete it.

~AudioSubmix

C++
~AudioSubmix()

AudioSubmix

C++
AudioSubmix(const AudioSubmix&) = delete

GetName

C++
const std::string& GetName() const

GetParent

C++
AudioSubmix* GetParent() const

GetChildren

C++
const std::vector<AudioSubmix*>& GetChildren() const

IsRoot

C++
bool IsRoot() const

IsUnder

C++
bool IsUnder(const AudioSubmix* ancestor) const

True when ancestor is this submix or any submix above it.

SetVolume

C++
void SetVolume(float volume)

GetVolume

C++
float GetVolume() const

SetPitch

C++
void SetPitch(float pitch)

GetPitch

C++
float GetPitch() const

SetMuted

C++
void SetMuted(bool muted)

Mute keeps the fader value: unmuting restores it.

IsMuted

C++
bool IsMuted() const

SetModulation

C++
void SetModulation(float volumeScale, float pitchScale)

Parameter modulation (FAudioParameters::BindSubmix), multiplied onto the fader and the pitch. Kept apart from both so a snapshot or the player's slider moving the fader never erases it, and it never erases them.

GetModulationVolume

C++
float GetModulationVolume() const

GetModulationPitch

C++
float GetModulationPitch() const

AddEffect

C++
bool AddEffect(Ref<AudioEffect> effect)

Ordered DSP chain between this group and the parent. Index 0 is closest to the group. An effect lives in exactly one chain.

RemoveEffect

C++
bool RemoveEffect(AudioEffect* effect)

ClearEffects

C++
void ClearEffects()

GetEffectCount

C++
size_t GetEffectCount() const

GetEffect

C++
AudioEffect* GetEffect(size_t index) const

GetGroup

C++
ma_sound_group* GetGroup()

Where sources and child groups attach. Sources count themselves in and out so removal can refuse while anything still plays through here.

GetInputNode

C++
ma_node* GetInputNode()

GetAttachedSourceCount

C++
uint32_t GetAttachedSourceCount() const

AttachSource

C++
void AttachSource()

DetachSource

C++
void DetachSource()

operator=

C++
AudioSubmix& operator=(const AudioSubmix&) = delete
Generated from Audio/AudioSubmix.h via audio.json · Oct 26, 2026Version 1.0.0