Inheritance #

AudioStreamWAV #

is_refcounted, is_instantiable, resource, core, not_builtin_classes

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.

Members #

var data: PackedByteArray = PackedByteArray()#

Contains the audio data in bytes.

Note: If format is set to FORMAT_8_BITS, this property expects signed 8-bit PCM data. To convert from unsigned 8-bit PCM, subtract 128 from each byte.

Note: If format is set to FORMAT_QOA, this property expects data from a full QOA file.

var format = FORMAT_8_BITS#

Audio format. See Format constants for values.

var loop_begin: int = 0#

The loop start point (in number of samples, relative to the beginning of the stream).

var loop_end: int = 0#

The loop end point (in number of samples, relative to the beginning of the stream).

var loop_mode = LOOP_DISABLED#

The loop mode. See LoopMode constants for values.

var mix_rate: int = 44100#

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 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 using lower-pitched sounds such as voices, lower sample rates such as 32000 or 22050 may be usable with no loss in quality.

var stereo: bool = false#

If true, audio is stereo.

Methods #

@onready var audio_player = $AudioStreamPlayer

func _ready():
    get_window().files_dropped.connect(_on_files_dropped)

func _on_files_dropped(files):
    if files[0].get_extension() == "wav":
        audio_player.stream = AudioStreamWAV.load_from_file(files[0], {
                "force/max_rate": true,
                "force/max_rate_hz": 11025
            })
        audio_player.play()

Annotations #

Constants #

const FORMAT_8_BITS = 0 enum Format#

8-bit PCM audio codec.

const FORMAT_16_BITS = 1 enum Format#

16-bit PCM audio codec.

const FORMAT_IMA_ADPCM = 2 enum Format#

Audio is lossily compressed as IMA ADPCM.

const FORMAT_QOA = 3 enum Format#

Audio is lossily compressed as Quite OK Audio.

const LOOP_DISABLED = 0 enum LoopMode#

Audio does not loop.

const LOOP_FORWARD = 1 enum LoopMode#

Audio loops the data between loop_begin and loop_end, playing forward only.

const LOOP_PINGPONG = 2 enum LoopMode#

Audio loops the data between loop_begin and loop_end, playing back and forth.

const LOOP_BACKWARD = 3 enum LoopMode#

Audio loops the data between loop_begin and loop_end, playing backward only.

Constructors #

Enums #

Format#

LoopMode#

Operators #

Signals #

Theme Items #

Tutorials #