GS_Audio

1 - Audio Manager

The Audio Manager is the master audio controller for every GS_Play project. It extends GS_ManagerComponent and participates in the standard two-stage initialization managed by the Game Manager. On startup it initializes the MiniAudio engine, creates the named mixing bus graph, loads audio event libraries, and coordinates score track playback.

Like all GS_Play managers, the Audio Manager responds to standby mode automatically – muting or pausing audio output when the game enters a blocking operation such as a stage change.

For usage guides and setup examples, see The Basics: GS_Audio.

Contents

• How It Works
• Inspector Properties
• API Reference
• See Also

How It Works

Engine Lifecycle

When the Audio Manager activates, it initializes a MiniAudio engine instance and builds the mixing bus graph from its configured bus list. During Stage 2 startup it loads all referenced Audio Event Library assets so that events can be triggered immediately once startup completes.

Mixing Bus Routing

All audio output flows through named mixing buses. Each bus is a GS_MixingBus node in the MiniAudio graph with its own volume level and optional effects chain. The Audio Manager owns the top-level routing and exposes volume control per bus through the request bus.

Score Playback

The Audio Manager coordinates playback of ScoreArrangementTrack assets – multi-layer musical scores with configurable tempo, time signature, and layer selection. Score tracks are loaded and managed through the request bus.

Inspector Properties

API Reference

GS_AudioManagerComponent

Request Bus: AudioManagerRequestBus

Commands sent to the Audio Manager. Singleton bus – Single address, single handler.

Notification Bus: AudioManagerNotificationBus

Events broadcast by the Audio Manager. Multiple handler bus – any number of components can subscribe.

See Also

For conceptual overviews and usage guides:

• GS_Audio Overview – Top-level audio gem documentation
• The Basics: GS_Audio – Scripting-level usage guide

For component references:

• Manager Base Class – The base class pattern for all managers

For related resources:

• Audio Events – Event-based sound playback and event libraries
• Mixing & Effects – Mixing buses and audio effects
• Score Arrangement – Multi-layer music scoring

Get GS_Audio

GS_Audio — Explore this gem on the product page and add it to your project.

2 - Audio Events

Audio Events are the primary mechanism for playing sounds in GS_Play. A GS_AudioEvent defines a single sound event with a pool of audio clips, selection rules (random or sequential), 2D/3D spatialization mode, concurrent playback limits, and repeat-hold behavior. Events are grouped into AudioEventLibrary assets that the Audio Manager loads at startup or on demand.

When an event is triggered, the system selects a clip from the pool according to the configured selection type, checks concurrent limits, and routes the output through the appropriate mixing bus.

For usage guides and setup examples, see The Basics: GS_Audio.

Contents

• Data Model
• See Also

Data Model

GS_AudioEvent

A single audio event definition containing all playback configuration.

AudioEventLibrary

An asset containing a collection of GS_AudioEvent definitions. Libraries are loaded by the Audio Manager at startup or at runtime via LoadEventLibrary.

PoolSelectionType (Enum)

Determines how audio clips are selected from an event’s clip pool.

GS_AudioEventComponent

Per-entity component that provides audio event playback with optional 3D positioning. Attach this component to any entity that needs to emit sounds.

See Also

For conceptual overviews and usage guides:

• GS_Audio Overview – Top-level audio gem documentation
• The Basics: GS_Audio – Scripting-level usage guide

For component references:

• Audio Manager – Engine initialization and event library loading

For related resources:

• Mixing & Effects – Mixing buses that events route through

Get GS_Audio

GS_Audio — Explore this gem on the product page and add it to your project.

3 - Mixing & Effects

GS_Audio provides a named mixing bus system built on custom MiniAudio nodes. Each GS_MixingBus is a node in the audio graph with its own volume level and an optional chain of audio filters. Buses are configured in the Audio Manager Inspector and can be controlled at runtime through the mixing request bus.

The effects system includes 9 built-in filter types covering frequency shaping, equalization, delay, and reverb. Environmental influence effects allow game world volumes (rooms, weather zones) to push effects onto buses with priority-based stacking.

For usage guides and setup examples, see The Basics: GS_Audio.

Contents

• GS_MixingBus
• API Reference
• Audio Filters
• Data Structures
• See Also

GS_MixingBus

Custom MiniAudio node for mixing and effects processing.

API Reference

Request Bus: GS_MixingRequestBus

Mixer control commands. Singleton bus – Single address, single handler.

Audio Filters

All 9 built-in filter types. Each filter is configured as part of an effects chain applied to a mixing bus.

Data Structures

BusEffectsPair

Maps a bus name to an effects chain configuration. Used in the Audio Manager’s Inspector to define per-bus effects at design time.

AudioBusEffects

A collection of audio filter configurations that form an effects chain on a mixing bus.

AudioBusInfluenceEffects

Environmental effects with priority-based stacking. Game world volumes (rooms, weather zones, underwater areas) push influence effects onto mixing buses. Higher priority influences override lower ones.

See Also

For conceptual overviews and usage guides:

• GS_Audio Overview – Top-level audio gem documentation
• The Basics: GS_Audio – Scripting-level usage guide

For component references:

• Audio Manager – Master controller that owns the mixing bus graph

For related resources:

• Audio Events – Events route their output through mixing buses

Get GS_Audio

GS_Audio — Explore this gem on the product page and add it to your project.

4 - Score Arrangement

The Score Arrangement system provides multi-layer dynamic music for GS_Play projects. A ScoreArrangementTrack asset defines a musical score with configurable tempo, time signature, fade behavior, and multiple layers that can be enabled or disabled at runtime. This allows game music to adapt to gameplay state – adding or removing instrumental layers, changing intensity, or crossfading between sections.

Score tracks are loaded and controlled through the Audio Manager request bus.

For usage guides and setup examples, see The Basics: GS_Audio.

Contents

• Data Model
• See Also

Data Model

ScoreArrangementTrack

A multi-layer musical score asset. Each track defines the musical structure and contains one or more layers that play simultaneously.

ScoreLayer

A single musical layer within a score arrangement. Each layer represents one track of audio (e.g. drums, bass, melody) that can be independently enabled or disabled.

TimeSignatures (Enum)

Supported musical time signatures for score arrangement tracks.

See Also

For conceptual overviews and usage guides:

• GS_Audio Overview – Top-level audio gem documentation
• The Basics: GS_Audio – Scripting-level usage guide

For component references:

• Audio Manager – Controls score playback via the request bus

Get GS_Audio

GS_Audio — Explore this gem on the product page and add it to your project.

5 - Klatt Voice Synthesis

The Klatt Voice Synthesis system provides custom text-to-speech for GS_Play projects using Klatt formant synthesis with full 3D spatial audio. It uses SoLoud internally for speech generation and MiniAudio for spatial positioning.

The system has two layers:

• KlattVoiceSystemComponent – A singleton that manages the shared SoLoud engine instance and tracks the 3D audio listener position.
• KlattVoiceComponent – A per-entity component that generates speech, queues segments, applies voice profiles, and emits spatialized audio from the entity’s position.

Voice characteristics are defined through KlattVoiceProfile assets containing frequency, speed, waveform, formant, and phoneme mapping configuration. Phoneme maps convert input text to ARPABET phonemes for the Klatt synthesizer, with support for custom pronunciation overrides.

For usage guides and setup examples, see The Basics: GS_Audio.

Contents

• Components
• API Reference
• Data Types
• Enumerations
• KTT Voice Tags
• Combined Example
• See Also

Components

KlattVoiceSystemComponent

Singleton component that manages the shared SoLoud engine and 3D listener tracking.

KlattVoiceComponent

Per-entity voice component with spatial audio, phoneme mapping, and segment queue.

API Reference

Request Bus: KlattVoiceSystemRequestBus

System-level voice management. Singleton bus – Single address, single handler.

Request Bus: KlattVoiceRequestBus

Per-entity voice synthesis controls. Entity-addressed bus – Single handler per entity ID.

Notification Bus: KlattVoiceNotificationBus

Events broadcast by voice components. Multiple handler bus – any number of components can subscribe.

Data Types

KlattVoiceParams

Core voice synthesis parameters controlling the Klatt formant synthesizer output.

KlattVoiceProfile

A voice profile asset combining synthesis parameters with a phoneme mapping.

KlattVoicePreset

A preset configuration for quick voice setup.

KlattSpatialConfig

3D spatial audio configuration for voice positioning.

KlattPhonemeMap

Phoneme mapping asset for text-to-ARPABET conversion with custom overrides.

PhonemeOverride

A custom pronunciation rule that overrides the base phoneme map for a specific word or pattern.

Enumerations

KlattWaveform

Glottal waveform types available for the Klatt synthesizer.

BasePhonemeMap

Available base phoneme dictionaries for text-to-ARPABET conversion.

KTT Voice Tags

KTT (Klatt Text Tags) are inline commands embedded in strings passed to KlattVoiceComponent::SpeakText. They are parsed by KlattCommandParser::Parse and stripped from the spoken text before synthesis begins — they are never heard.

Format: <ktt attr1=value1 attr2=value2>

Multiple attributes can be combined in a single tag. Attribute names are case-insensitive. String values may optionally be wrapped in quotes. An empty value (e.g. speed=) resets that parameter to the voice profile default.

speed=X

Override the speech speed multiplier from this point forward.

Normal speech <ktt speed=2.0> fast bit <ktt speed=> back to default.

decl=X / declination=X

Pitch declination — how much pitch falls over the course of the utterance. Both decl and declination are accepted.

Rising <ktt decl=0.0> steady <ktt decl=0.8> falling voice.

waveform="TYPE"

Change the glottal waveform used by the synthesizer, setting the overall character of the voice.

<ktt waveform="noise"> whispered section <ktt waveform="saw"> normal voice.

vowel=X

First formant (F1) frequency multiplier. Shifts the quality of synthesised vowel sounds.

<ktt vowel=1.4> different vowel colour here.

accent=X

Second formant (F2) frequency multiplier. Shifts accent or dialect colouration.

<ktt accent=0.8> shifted accent here.

pitch=X

F0 pitch variance amount. Controls how much pitch varies during synthesis.

<ktt pitch=2.0> very expressive speech <ktt pitch=0.1> flat monotone.

pause=X

Insert a pause of X seconds at this position in the voice playback. Value is required — there is no default.

Hello.<ktt pause=0.8> How are you?

Combined Example

Dialogue string using typewriter text commands and KTT voice tags together:

[b]Warning:[/b] [color=#FF0000]do not[/color] proceed.[pause=1]
<ktt waveform="square" pitch=1.8>This is a mechanical override.<ktt pause=0.5><ktt waveform="saw" pitch=1.0>
[speed=3]Resuming normal protocol.[/speed]

See Also

For conceptual overviews and usage guides:

• GS_Audio Overview – Top-level audio gem documentation
• The Basics: GS_Audio – Scripting-level usage guide

For component references:

• Audio Manager – Manager lifecycle that the voice system participates in

Get GS_Audio

GS_Audio — Explore this gem on the product page and add it to your project.

6 - Third Party Implementations

This section will contain integration guides for connecting third-party audio middleware and tools with the GS_Audio system.

For usage guides and setup examples, see The Basics: GS_Audio.

Get GS_Audio

GS_Audio — Explore this gem on the product page and add it to your project.