API reference Download Markdown

Audio

Playback

Scroll to see all columns.

API	Playback
`PlaySound`	Decoded one-shot with no source position
`PlayMusic`, `StopMusic`	Streaming soundtrack
`PlayAmbience`, `StopAmbience`	Streaming ambience on an environment lane
`PlaySoundFrom`	One-shot following an entity, with XY spatialization
`NewSoundEmitter`	Positioned source with XYZ distance and optional collision occlusion
`NewAttachedSoundEmitter`	Persistent emitter following an entity

Spatial emitters

Spatial emitters require SoundEmitterOptions. Create them after level readiness. This example uses a generated project sound ID:

func reactor(game *engine.Game, level engine.LevelHandle) *engine.SoundEmitter {
    return game.NewSoundEmitter(level, assets.SoundReactorHum,
        engine.NewVec3(6, 6, 1.5), engine.SoundEmitterOptions{
            Volume: 0.6, NearDistance: 2, FarDistance: 16,
            Loop: true, Occlusion: true,
        })
}

SetAudioListener selects the listening entity. Receiver and emitter must belong to the same mounted level. Its Right vector sets stereo direction; for camera yaw, use (cos(yaw), -sin(yaw)) and update it when turning.

Near distance is the full-volume range. Far distance must be greater than near and marks silence. Occlusion uses loaded collision geometry. Spatial clips should be mono.

Start loops once. Stop screen-owned streams when leaving the screen. Keep emitter handles to update settings or call Stop; level release stops them. Fading voices can continue occupying capacity. Browsers may require player input before audio becomes audible.

Asset setup and playback examples · Hangar emitters

Exact voice and clip bounds are in .karty/docs/assets.md and .karty/docs/audio-emitters.md.