sound library

Playing and generating sounds.

Sounds are provided by way of a SoundBackend instance. By default, two backends are implemented:

If you wish to implement your own sound backend, you must implement the SoundBackend class, and all required machinery.

Classes

Ambiance
A constantly playing sound on a map.
BackendEcho
Echo for a SoundChannel instance.
BackendReverb
A reverb bus.
BufferCache
A class to get and hold buffers.
EchoTap
A tap for an echo.
ListenerOrientation
The orientation of the listener.
ListenerPosition
The position of the listener.
RandomSound
A random sound.
ReverbPreset
A reverb preset.
SilentBackendEcho
A silent echo.
SilentBackendReverb
A silent reverb.
SilentSound
A silent sound.
SilentSoundBackend
A silent sound backend.
SilentSoundChannel
A silent sound channel.
SilentWave
A silent wave.
Sound
A sound that has been played by a SoundBackend instance.
SoundBackend
A backend for playing sound.
SoundChannel
A channel for playing sounds through.
SoundPlayback
This class represents a playing sound.
SoundPosition
The default sound position.
SoundPosition3d
A sound which should be positioned in 3d space.
SoundPositionAngular
A sound which should be panned.
SoundPositionScalar
A sound which should be panned.
SynthizerBackendEcho
A synthizer echo.
SynthizerBackendReverb
A synthizer reverb.
SynthizerSound
A sound that has been played by a SynthizerSoundBackend instance.
SynthizerSoundBackend
A sound backend which uses Synthizer.
SynthizerSoundChannel
A synthizer sound channel.
SynthizerWave
A synthizer wave.
Wave
A wave that has been created by a SoundBackend instance.

Enums

DefaultPannerStrategy
Possible default panner strategies.

Constants

unpanned → const SoundPosition
An unpanned sound.