Audio

Audio module API reference: 37 headers · 110 types · 1259 symbols.

Generated from audio.json · Oct 26, 2026Version 1.0.0
Build name
MowoEngine.Audio
Source
Engine/Source/Runtime/Audio/Public
Category
Runtime
Contents
37 headers · 110 types · 1259 symbols

Audio/AudioAttenuation.h

KindTypeSummary
enumEAudioAttenuationShape
structFAudioAttenuationSettingsFAudioAttenuationSettings — one shared attenuation description (UE's Attenuation Settings asset), referenced by many sources instead of every source carrying its own curves. Distances are measured from the shape's surfac
structFAudioAttenuationResult
classFAudioAttenuation

Audio/AudioBus.h

KindTypeSummary
enumAudioBus

Audio/AudioCurve.h

KindTypeSummary
classFAudioCurveSampler for the author-editable attenuation curves carried on AudioSourceComponent. A curve is a small sorted set of {distance, value} keys; the engine evaluates gain-over-distance and cutoff-over-distance from these eac

Audio/AudioDebug.h

KindTypeSummary
structFAudioDebugSubmix
structFAudioDebugGroup
structFAudioDebugParameter
structFAudioDebugStatsOne snapshot of everything the mixer is doing (UE's au.Debug / Audio Insights): voice counts by state, per-submix meters, concurrency groups, the memory budget, the parameters and the active spatializer.
classFAudioDebugFAudioDebug — the debug surface. Capture() takes the snapshot; Format() turns it into the text the au.Debug console command prints and the editor's Audio panel shows; DrawAttenuation() draws every playing spatial voice

Audio/AudioEffect.h

KindTypeSummary
enumAudioEffectTypeBuilt-in DSP effect types. Filters (LowPass..HighShelf) + Delay wrap miniaudio nodes directly. Reverb (simplified Freeverb) and Compressor (feedforward peak detector) are custom ma_node subclasses living in AudioEffect.c
classAudioEffectBase for every DSP node we put on a bus. Owns one ma_node*-shaped object — derived classes pick which ma_*_node they wrap and how to interpret their config. Lifetime: created via the AudioEngine::CreateXxxEffect factor
structAudioEffect::FEffectParamsOne shape for every filter's parameters — the three floats and the order cover cutoff/gain/Q/slope/frequency across all six, so publishing and draining stay in the base class and each subclass only says what its fields m
classFAudioEffectRegistryWhere the audio thread finds the effects with parameters waiting. Slots are claimed for the effect's whole life so the drain never allocates or locks.
classLowPassEffect
classHighPassEffect
classBandPassEffect
classPeakEqEffectPeak / shelf EQs share the same surface: gain + frequency + Q.
classLowShelfEffect
classHighShelfEffect
classDelayEffectDelay effect. miniaudio's ma_delay_node implements a feedback delay line (echo / slap-back) — delay length is fixed at init time, decay + dry/wet can be changed live.
classReverbEffectReverb — simplified Freeverb topology (4 comb filters + 2 allpass per channel). Custom ma_node — not part of miniaudio's built-ins.
classConvolutionReverbEffectConvolution reverb — the impulse response of a real (or designed) space convolved onto the signal via FConvolutionEngine (uniform partitioned FFT convolution, one engine per channel). Fixed latency of one engine block (2
classCompressorEffectCompressor — feedforward peak compressor with soft knee. Per-channel envelope detection is linked (envelope = max across channels) so stereo signals don't drift across the centre image.
classEnvelopeFollowerEffectEnvelope follower — a passthrough tap that publishes the level of what runs through it: the RMS of the last block and a peak envelope with an attack/release, both read from any thread. What lip-sync and a meter read; the

Audio/AudioEngine.h

KindTypeSummary
structFAudioPlaybackDeviceInfo
structFAudibleSoundOne entry of the acoustic compass: a voice the listener can hear now, where it is relative to them and how loud it reaches them.
classAudioEngine

Free functions

SignatureDescription
using VoiceHandle = uint32_tHandle into the AudioEngine voice registry. 0 is never handed out.
static constexpr VoiceHandle kInvalidVoiceHandle = 0

Audio/AudioFileDecoder.h

KindTypeSummary
classFAudioFileDecoderFAudioFileDecoder — a whole clip to interleaved float PCM at a rate and channel count the caller picks, outside the live mixer. For offline work (the Sequencer's movie render mixes its audio tracks with it): a source fil

Audio/AudioImpulseMemory.h

KindTypeSummary
structFAudioImpulse
classFAudioImpulseMemoryFAudioImpulseMemory — the ambience's short memory of loud things: where the recent impulses (a scan, a door slam, a gunshot) happened and how much of each is still "in the air". Two things read it:

Audio/AudioParameters.h

KindTypeSummary
enumEAudioParameterTargetWhat a parameter binding moves.
structFAudioParameterBindingOne binding: a named parameter read through a curve onto a target. The curve keys are {parameter value, target value} — FAudioCurveKey's distance field carries the parameter value. EAudioCurveInterp::Step turns the cur
classFAudioParametersFAudioParameters — the RTPC layer: named, game-set values ("Attention", "Heat", "ScanRange") that sounds read instead of being driven one by one. A value set here glides to its target over the parameter's smoothing time,

Audio/AudioSource.h

KindTypeSummary
classAudioSource
classAudioSource::AudioSubmix

Audio/AudioSpatialization.h

KindTypeSummary
structFSpatializeInput
structFSpatializeOutputWhat a spatializer decides for one voice this tick. Gain multiplies the voice's own volume; Pan is -1 (left) .. +1 (right); the low-pass joins the voice's occlusion and modulation cutoffs, the darkest winning.
classIAudioSpatializerThe seam a spatialization plugin lives behind (UE's IAudioSpatialization): given where a voice and the listener are, say how loud, where, and how dark it is. A plugin (Steam Audio, an HRTF library) registers a factory un
classFAudioSpatializationFAudioSpatialization — the registry and the switch. "Native" (always present) is miniaudio's own spatializer; "Panner", registered by the engine, is an equal-power panner with inverse-distance gain — the reference implem

Audio/AudioSubmix.h

KindTypeSummary
classAudioSubmixOne 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 ju

Audio/AudioSystem.h

KindTypeSummary
classAudioSystem

Audio/Components/AudioListenerComponent.h

KindTypeSummary
structAudioListenerComponent

Audio/Components/AudioReverbZoneComponent.h

Audio/Components/AudioSourceComponent.h

KindTypeSummary
enumEAudioAttenuationModel
enumEAudioCurveInterp
structFAudioCurveKeyOne authored point of an attenuation curve: the value the curve holds at a given distance from the listener. Keys need not be authored in order — the evaluator sorts by distance before sampling. Reused for both the gain
enumEAudioSourceEffectKindThe effects a source chain can hold, in the order authored.
structFAudioSourceEffectDescOne link of a source effect chain. What A/B/C mean depends on the kind (see EAudioSourceEffectKind).
structAudioSourceComponent

Audio/Components/MetaSoundComponent.h

KindTypeSummary
structFMetaSoundInputDefaultOne authored default for a MetaSound control input: the value the graph's named input holds when the voice starts. Applied once at voice creation, so a designer can tune a synth's cutoff or an ambience bed's density per
structFMetaSoundParameterLinkA control input that follows an audio parameter (FAudioParameters) every tick: input = offset + scale * parameter. How a game value reaches a graph without code — an infrasound rumble whose amplitude is "Threat", an ambi
structMetaSoundComponentMetaSoundComponent — a placeable MetaSound voice on an entity. Mirrors AudioSourceComponent's lifecycle contract: the AudioSystem resolves the .metasound graph on the first tick that sees the path, spins up a MetaSound

Audio/Components/PortalComponent.h

KindTypeSummary
structPortalComponentAn opening between two rooms that sound travels through: a doorway, a hatch, a vent, a door with how far it stands open. The opening lies in the entity's local XY plane (Width along X, Height along Y) and the rooms it jo

Audio/Components/RoomVolumeComponent.h

KindTypeSummary
structRoomVolumeComponentA room the sound graph knows about: an oriented box around the entity (rotation and scale follow its transform). Two points in different rooms hear each other only through the portals that join them, or through the walls

Audio/ConvolutionEngine.h

KindTypeSummary
classFConvolutionEngineUniform partitioned convolution (overlap-save), the engine behind convolution reverb. The impulse response is split into blockSize partitions, each FFT'd once at Init; per input block one FFT + P complex multiply-accumul

Audio/EchoTail.h

KindTypeSummary
structFEchoTailEstimateWhat the space sounds like, read off real ray hits.
structFEchoTapOne early reflection the geometry worked out exactly: when it arrives after the sound leaves the listener, and how loud it is relative to 1 m.
classFEchoTailFEchoTail — the echo a space gives back, built from where the scanner's rays actually landed instead of a reverb preset per room. Every shot contributes its hit distances to a decaying histogram (0.5 m bins out to 64 m)

Audio/FAudioCapture.h

KindTypeSummary
structFAudioCaptureDeviceInfo
classFAudioCapture

Audio/FAudioModule.h

KindTypeSummary
classFAudioModule

Audio/FAudioSampleRing.h

KindTypeSummary
classFAudioSampleRing

Audio/GeometricAcoustics.h

KindTypeSummary
structFAcousticHitOne ray against whatever the level's acoustic geometry is. Distance is from the ray origin; the normal faces back toward it.
classIAcousticGeometryWhat sound bounces off and is stopped by. The scan hierarchy is the one the LiDAR game wants — the same triangles the scanner paints, castable from any thread, no Jolt query on the game thread — and the physics scene is
classFPhysicsAcousticGeometryThe physics scene as acoustic geometry. Resolves the world's physics system on every cast, so it never outlives the scene it reads.
structFAcousticMaterialHow a surface treats the energy that lands on it: the share it absorbs (Sabine coefficient, mid band) and the share it scatters diffusely instead of mirroring.
structFAcousticReverbThe space around a listener, traced rather than authored.
structFAcousticReflectionOne specular path from a source to a listener off order surfaces.
structFAcousticEcho
structFEcholocationResult
structFAcousticsSettings
classFGeometricAcousticsFGeometricAcoustics — sound worked out from the level's geometry. Three answers, all deterministic for a given seed so two machines agree:

Audio/MAudioPlayer.h

KindTypeSummary
classMAudioPlayerObject-oriented audio handle exposed to Visual Scripting. Every MFUNCTION below becomes a node in the Visual Script catalog (built from MClass function tables), so a graph can load a clip and drive its playback the same

Audio/MAudioStatics.h

KindTypeSummary
classMAudioStaticsReflected façade over the AudioEngine singleton, so the bus mixer and fire-and-forget playback show up as Visual Script nodes without annotating the whole miniaudio-laden engine. Every method forwards to AudioEngine::Get

Audio/MetaSoundGraph.h

KindTypeSummary
enumEMetaSoundNodeType
enumEMetaSoundPortKind
structFMetaSoundPort
structFMetaSoundNode
structFMetaSoundConnection
classFMetaSoundGraphA DSP synthesis graph: oscillators, envelopes, filters and math nodes wired by typed (audio-rate buffer / control-rate scalar) connections. Prepare() topo- sorts the graph and allocates per-node block buffers; Process(bl

Audio/MetaSoundVoice.h

KindTypeSummary
classMetaSoundVoiceA live instance of a MetaSound DSP graph, wired into the AudioEngine as a custom data source so its synthesized blocks flow through the normal bus / spatialization path. Own a copy of the compiled graph; drive it live wi

Audio/MusicSystem.h

KindTypeSummary
classMusicSystem

Audio/ReverbZones.h

Audio/SoundClass.h

KindTypeSummary
enumEConcurrencyRuleWhat a full concurrency group does with one more voice.
structFSoundClassDescA node of the sound-class tree (UE's Sound Class): volume and pitch multiply down the chain, the low-pass takes the darkest. Independent of routing — a footstep class can live on the SFX submix and still be turned down w
structFSoundClassAdjusterOne adjustment a sound mix makes to a class (and so to its children).
structFSoundConcurrencyDesc
classFSoundClassesFSoundClasses — 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.concur

Audio/SoundCue.h

KindTypeSummary
classSoundCue
structSoundCue::Entry
structSoundCue::LayeredVoiceOne layered voice inside a multi-voice cue (a Mixer branch): its own weighted clip pool plus the gain/pitch/attenuation resolved for that branch. The voices of a cue start together on Play and stop together on StopAll —

Audio/SoundCueAsset.h

KindTypeSummary
enumECueNodeKind
structFCueNode
structFCueLink
structFCueSettings
structFCueGraph
classFSoundCueAssetThe .cuegraph document — an MDF node graph written by the editor's cue authoring panel and compiled into a playable SoundCue at runtime.

Audio/SoundOcclusion.h

KindTypeSummary
structFSoundOcclusionMaterialFSoundOcclusion — the one occlusion law every sound in the engine obeys: world sources, proximity voice, radio speakers and AI hearing all ask it. Before it there were three, with their own constants, and a comment in th
structFSoundOcclusionResult
structFSoundOcclusionStateWhat a playing voice carries from frame to frame, so a wall arriving or leaving is a glide rather than a click.
classFSoundOcclusion

Audio/SoundPropagation.h

KindTypeSummary
structFSoundRoomFSoundPropagation — rooms joined by portals, and the one answer to "how does a sound get from here to there". World sources, proximity voice, radio speakers and AI hearing all ask Evaluate; that the creature and the play
structFSoundPortal
structFSoundPath
classFSoundPropagation
classFSoundPropagationSystem

Audio/FAudioImportSidecar.h

Free functions

SignatureDescription
using FAudioImportSidecar = FMaudioImportSidecarThe reader moved down into AssetFormats so the packaging cook can use it without linking the audio engine; this name stays because it is what the runtime, the importer and the tests already spell.

Page feedback

Was this page helpful?