class

FSoundClasses

FSoundClasses — the sound-class tree, the sound mixes that adjust it, and the concurrency groups. Classes and groups come from the project config (audio.sound_classes = "Name:Parent:Volume:Pitch:LowPass", audio.concurrency = "Name:MaxCount:Rule") or from code; a source names one of each (AudioSource::SetSoundClass / SetConcurrencyGroup, or the AudioSourceComponent fields). AudioEngine::UpdateVoices folds the class into the source's modulation every tick; AudioSource::Play asks AudioEngine::AdmitVoice before it starts. Main thread only.

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

Public functions

ReturnsNameDescription
voidDefineClass
boolRemoveClass
boolHasClass
boolSetClassVolume
boolSetClassPitch
voidResolveEffective volume, pitch and cutoff for a class: its own values times every ancestor's and every active mix adjustment on the chain.
voidPushMixSound mixes: named sets of class adjustments, active until popped.
boolPopMix
boolIsMixActive
voidDefineConcurrency
boolFindConcurrency
boolParseClassEntry
boolParseConcurrencyEntry
EConcurrencyRuleParseRule
const char*RuleName
voidLoadFromConfig
voidReset
std::vector<std::string>GetClassNames
std::vector<std::string>GetConcurrencyNames

Function details

DefineClass

C++
static void DefineClass(const FSoundClassDesc& desc)

RemoveClass

C++
static bool RemoveClass(const std::string& name)

HasClass

C++
static bool HasClass(const std::string& name)

SetClassVolume

C++
static bool SetClassVolume(const std::string& name, float volume)

SetClassPitch

C++
static bool SetClassPitch(const std::string& name, float pitch)

Resolve

C++
static void Resolve(const std::string& name, float& outVolume, float& outPitch, float& outLowPassHz)

Effective volume, pitch and cutoff for a class: its own values times every ancestor's and every active mix adjustment on the chain. An unknown class resolves to unity. A cycle stops at 16 levels.

PushMix

C++
static void PushMix(const std::string& mixName, const std::vector<FSoundClassAdjuster>& adjusters)

Sound mixes: named sets of class adjustments, active until popped. Pushing a mix that is already active replaces its adjustments.

PopMix

C++
static bool PopMix(const std::string& mixName)

IsMixActive

C++
static bool IsMixActive(const std::string& mixName)

DefineConcurrency

C++
static void DefineConcurrency(const FSoundConcurrencyDesc& desc)

FindConcurrency

C++
static bool FindConcurrency(const std::string& name, FSoundConcurrencyDesc& out)

ParseClassEntry

C++
static bool ParseClassEntry(const std::string& entry, FSoundClassDesc& out)

ParseConcurrencyEntry

C++
static bool ParseConcurrencyEntry(const std::string& entry, FSoundConcurrencyDesc& out)

ParseRule

C++
static EConcurrencyRule ParseRule(const std::string& name)

RuleName

C++
static const char* RuleName(EConcurrencyRule rule)

LoadFromConfig

C++
static void LoadFromConfig()

Reset

C++
static void Reset()

GetClassNames

C++
static std::vector<std::string> GetClassNames()

GetConcurrencyNames

C++
static std::vector<std::string> GetConcurrencyNames()
Generated from Audio/SoundClass.h via audio.json · Oct 26, 2026Version 1.0.0