Documentation
Docs/en/reference/audio/delivery.md
Audio Resource Delivery
Generated reference. Do not edit directly. Update
BuildTools/AudioInterface.json, then runpython BuildTools/docs_audio.py --write.
| Index | Formats | Delivery | Decoding | Playback | Validation | Canonical JSON | Guide |
| Stable ID | Rule | Requirement | Why | Source |
|---|---|---|---|---|
audio.delivery.raw-copy |
AudioBaker delivery | Include the Audio baker in each resource pack that owns runtime audio; it accepts the configured wav and ogg inputs and writes a verified Ogg Vorbis payload. | Audio resources no longer use RawCopy: WAV is normalized and encoded while an already-native Ogg is verified and copied without another lossy pass. | Source/Tools/AudioBaker.h, Source/Tools/AudioBaker.cpp |
audio.delivery.client-index |
Client sound index | Call AudioManager.IndexFiles after client resources are available; it records every path whose suffix occurs in Audio.SoundFileExtensions. | The manager exposes this source-backed path catalog, while Game.PlaySound itself receives the exact selected resource path and performs no concept or variant resolution. | Source/Client/AudioManager.cpp |
audio.delivery.effect-identity |
Exact authored path identity | Pass the exact baked resource path, including its authored extension, to Game.PlaySound and Game.PlayMusic. | AudioBaker preserves the authored path while replacing WAV bytes with Vorbis, and AudioManager reads that path directly without lowercasing or replacing the extension. | Source/Tools/AudioBaker.cpp, Source/Client/AudioManager.cpp |
audio.delivery.extension-precedence |
Source extension and payload separation | Treat a .wav suffix in baked resources as source identity, not runtime codec identity; all runtime bytes are Ogg Vorbis and .ogg sources remain .ogg. | Preserving authored paths avoids rewriting project references while one runtime decoder and one package payload format remove platform-dependent format behavior. | Source/Tools/AudioBaker.h |
audio.delivery.music-path |
Music path ownership | Pass music as an exact resource path; unlike effects, music is not resolved through the normalized sound-name index. | PlayMusic forwards the supplied filename directly to AudioManager.Load. | Source/Client/AudioManager.cpp |