Skip to content

Namespace Apogee.Audio

Classes

AudioBus

A bus of the mix: a group of sounds with a volume, a mute and a pause of its own (Music, Vehicles, Environment, UI). See .

AudioOptions

How an is made.

AudioSound

A sound file loaded by : play it any number of times, on any bus.

AudioSystem

The game's audio, on OpenAL Soft: sounds (WAV, FLAC, MP3, Ogg Vorbis) played in 3D around the entity that has an , on buses, with reverb zones and occlusion. OpenAL Soft is a separate shared library that ships beside the program (see Legal/THIRD_PARTY_NOTICES.md): without it is false, every call does nothing and returns something inert, and the game runs in silence.

AudioVoice

Something that is playing, or about to: a sound on a source (). Attach it to an entity to make it positional: it then follows that entity's world transform, with the velocity for Doppler, and is set relative to the nearest listener in double precision. A voice from an inactive audio system (no OpenAL) is inert: it never plays.

Structs

AudioListener

Marks the entity the player hears from (the camera, or the character's head): the audio system hears from its , looking along its -Z with +Y up, as a camera does. Several give split-screen listeners (the lowest first, up to 8); each voice is placed relative to the nearest one, in double precision, so sound stays exact far from the origin.

ReverbZone

A box (centered on the entity, in its own space, scaled by its world scale) in which the listener hears 's reverb: a garage, a barn, a cave. Where zones overlap, the one with the highest wins, then the smallest. Only the zone the listener is in applies; there is no crossfade.

Enums

AudioOutput

Where the mixed sound goes.

ReverbPreset

The reverbs knows. They are our own approximations of the usual spaces, as OpenAL Soft's EAX reverb parameters.