Inherits: AudioStream < Resource < Reference < Object

Category: Core

Brief Description

Stores audio data loaded from .wav files.


Error save_to_wav ( String path )


enum Format:

  • FORMAT_8_BITS = 0 — Audio codec 8 bit.
  • FORMAT_16_BITS = 1 — Audio codec 16 bit.
  • FORMAT_IMA_ADPCM = 2 — Audio codec IMA ADPCM.

enum LoopMode:

  • LOOP_DISABLED = 0 — Audio does not loop.
  • LOOP_FORWARD = 1 — Audio loops the data between loop_begin and loop_end playing forward only.
  • LOOP_PING_PONG = 2 — Audio loops the data between loop_begin and loop_end playing back and forth.
  • LOOP_BACKWARD = 3 — Audio loops the data between loop_begin and loop_end playing backward only.


AudioStreamSample stores sound samples loaded from .wav files. To play the stored sound use an AudioStreamPlayer (for background music) or AudioStreamPlayer2D/AudioStreamPlayer3D (for positional audio). The sound can be looped.

This class can also be used to store dynamically generated PCM audio data.

Property Descriptions

Setter set_data(value)
Getter get_data()

Contains the audio data in bytes.

Setter set_format(value)
Getter get_format()

Audio format. See FORMAT_* constants for values.

  • int loop_begin
Setter set_loop_begin(value)
Getter get_loop_begin()

Loop start in bytes.

Setter set_loop_end(value)
Getter get_loop_end()

Loop end in bytes.

Setter set_loop_mode(value)
Getter get_loop_mode()

Loop mode. See LOOP_* constants for values.

Setter set_mix_rate(value)
Getter get_mix_rate()

The sample rate for mixing this audio.

Setter set_stereo(value)
Getter is_stereo()

If true, audio is stereo. Default value: false.

Method Descriptions

Saves the AudioStreamSample as a WAV file to path. Samples with IMA ADPCM format can’t be saved.

Note that a .wav extension is automatically appended to path if it is missing.