AudioStreamSample

Inherits: AudioStream < Resource < Reference < Object

Stores audio data loaded from WAV files.

Description

AudioStreamSample 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.

Methods

Errorsave_to_wav ( String path )

Enumerations

enum Format:

  • FORMAT_8_BITS = 0 — 8-bit audio codec.
  • FORMAT_16_BITS = 1 — 16-bit audio codec.
  • FORMAT_IMA_ADPCM = 2 — Audio is compressed using 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.

Property Descriptions

DefaultPoolByteArray(  )
Setterset_data(value)
Getterget_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.


Default0
Setterset_format(value)
Getterget_format()

Audio format. See Format constants for values.


Default0
Setterset_loop_begin(value)
Getterget_loop_begin()

Loop start in bytes.


Default0
Setterset_loop_end(value)
Getterget_loop_end()

Loop end in bytes.


Default0
Setterset_loop_mode(value)
Getterget_loop_mode()

Loop mode. See LoopMode constants for values.


Default44100
Setterset_mix_rate(value)
Getterget_mix_rate()

The sample rate for mixing this audio.


Defaultfalse
Setterset_stereo(value)
Getteris_stereo()

If true, audio is stereo.

Method Descriptions

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

Note: A .wav extension is automatically appended to path if it is missing.

Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. It’s the English Stable version because it’s what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.