Up to date
This page is up to date for Godot
If you still find outdated information, please open an issue.
Stores audio data loaded from WAV files.
AudioStreamWAV stores sound samples loaded from WAV files. To play the stored sound, use an AudioStreamPlayer (for non-positional audio) or AudioStreamPlayer2D/AudioStreamPlayer3D (for positional audio). The sound can be looped.
This class can also be used to store dynamically-generated PCM audio data. See also AudioStreamGenerator for procedural audio generation.
Format FORMAT_8_BITS =
8-bit audio codec.
Format FORMAT_16_BITS =
16-bit audio codec.
Format FORMAT_IMA_ADPCM =
Audio is compressed using IMA ADPCM.
LoopMode LOOP_DISABLED =
Audio does not loop.
LoopMode LOOP_FORWARD =
LoopMode LOOP_PINGPONG =
LoopMode LOOP_BACKWARD =
PackedByteArray data =
Contains the audio data in bytes.
Note: This property expects signed PCM8 data. To convert unsigned PCM8 to signed PCM8, subtract 128 from each byte.
Format format =
Audio format. See Format constants for values.
int loop_begin =
The loop start point (in number of samples, relative to the beginning of the sample). This information will be imported automatically from the WAV file if present.
int loop_end =
The loop end point (in number of samples, relative to the beginning of the sample). This information will be imported automatically from the WAV file if present.
LoopMode loop_mode =
The loop mode. This information will be imported automatically from the WAV file if present. See LoopMode constants for values.
int mix_rate =
The sample rate for mixing this audio. Higher values require more storage space, but result in better quality.
In games, common sample rates in use are
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 using lower-pitched sounds such as voices, lower sample rates such as
22050 may be usable with no loss in quality.
bool stereo =
true, audio is stereo.
Saves the AudioStreamWAV as a WAV file to
path. Samples with IMA ADPCM format can't be saved.
.wav extension is automatically appended to
path if it is missing.