Index · Object → RefCounted → Resource → AudioStream → AudioStreamWAV

AudioStreamWAV

Stores audio data loaded from WAV files.

Class Description

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.

Properties

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: AudioStreamWAV.Format = 0

Audio format.

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: AudioStreamWAV.LoopMode = 0

The loop mode.

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.

var tags: Dictionary = {}

Contains user-defined tags if found in the WAV data.

Commonly used tags include title, artist, album, tracknumber, and date (date does not have a standard date format).

Note: No tag is guaranteed to be present in every file, so make sure to account for the keys not always existing.

Note: Only WAV files using a LIST chunk with an identifier of INFO to encode the tags are currently supported.

Inherited from Resource (4)

Methods

func load_from_buffer(stream_data: PackedByteArray, options: Dictionary = {}) -> AudioStreamWAV

Creates a new AudioStreamWAV instance from the given buffer. The buffer must contain WAV data.

The keys and values of options match the properties of ResourceImporterWAV. The usage of options is identical to load_from_file().

func load_from_file(path: String, options: Dictionary = {}) -> AudioStreamWAV

Creates a new AudioStreamWAV instance from the given file path. The file must be in WAV format.

The keys and values of options match the properties of ResourceImporterWAV.

Example: Load the first file dropped as a WAV and play it:

@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()
func save_to_wav(path: String) -> Error

Saves the AudioStreamWAV as a WAV file to path. Samples with IMA ADPCM or Quite OK Audio formats can't be saved.

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

Inherited from AudioStream (16)
func _get_bpm() -> float
func _get_length() -> float
func _get_parameter_list() -> Dictionary[]
func _has_loop() -> bool
func get_length() -> float
Inherited from Resource (18)
func _get_rid() -> RID
func _reset_state() -> void
func _set_path_cache(path: String) -> void
func _setup_local_to_scene() -> void
func copy_from_resource(resource: Resource) -> Error
func duplicate(deep: bool = false) -> Resource
func duplicate_deep(deep_subresources_mode: Resource.DeepDuplicateMode = 1) -> Resource
func emit_changed() -> void
func get_rid() -> RID
func is_built_in() -> bool
func reset_state() -> void
func set_id_for_path(path: String, id: String) -> void
func set_path_cache(path: String) -> void
func setup_local_to_scene() -> void
func take_over_path(path: String) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from AudioStream (1)
Inherited from Resource (2)
signal changed()
Inherited from Object (2)

Enums & Constants

enum Format
FORMAT_8_BITS = 0

8-bit PCM audio codec.

FORMAT_16_BITS = 1

16-bit PCM audio codec.

FORMAT_IMA_ADPCM = 2

Audio is lossily compressed as IMA ADPCM.

FORMAT_QOA = 3

Audio is lossily compressed as Quite OK Audio.

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_PINGPONG = 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.