AudioStreamGenerator

Inherits: AudioStream < Resource < Reference < Object

Audio stream that generates sounds procedurally.

Description

This audio stream does not play back sounds, but expects a script to generate audio data for it instead. See also AudioStreamGeneratorPlayback.

See also AudioEffectSpectrumAnalyzer for performing real-time audio spectrum analysis.

Note: Due to performance constraints, this class is best used from C# or from a compiled language via GDNative. If you still want to use this class from GDScript, consider using a lower mix_rate such as 11,025 Hz or 22,050 Hz.

Tutorials

Properties

float

buffer_length

0.5

float

mix_rate

44100.0

Property Descriptions

Default

0.5

Setter

set_buffer_length(value)

Getter

get_buffer_length()

The length of the buffer to generate (in seconds). Lower values result in less latency, but require the script to generate audio data faster, resulting in increased CPU usage and more risk for audio cracking if the CPU can’t keep up.

Default

44100.0

Setter

set_mix_rate(value)

Getter

get_mix_rate()

The sample rate to use (in Hz). Higher values are more demanding for the CPU to generate, but result in better quality.

In games, common sample rates in use are 11025, 16000, 22050, 32000, 44100, and 48000.

According to the Nyquist-Shannon sampling theorem, there is no quality difference to human hearing when going past 40,000 Hz (since most humans can only hear up to ~20,000 Hz, often less). If you are generating lower-pitched sounds such as voices, lower sample rates such as 32000 or 22050 may be usable with no loss in quality.