:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamWAV.xml. .. _class_AudioStreamWAV: AudioStreamWAV ============== **Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` Stores audio data loaded from WAV files. .. rst-class:: classref-introduction-group Description ----------- AudioStreamWAV stores sound samples loaded from WAV files. To play the stored sound, use an :ref:`AudioStreamPlayer` (for non-positional audio) or :ref:`AudioStreamPlayer2D`/:ref:`AudioStreamPlayer3D` (for positional audio). The sound can be looped. This class can also be used to store dynamically-generated PCM audio data. See also :ref:`AudioStreamGenerator` for procedural audio generation. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------------------+-------------------------------------------------------------+-----------------------+ | :ref:`PackedByteArray` | :ref:`data` | ``PackedByteArray()`` | +-----------------------------------------------+-------------------------------------------------------------+-----------------------+ | :ref:`Format` | :ref:`format` | ``0`` | +-----------------------------------------------+-------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`loop_begin` | ``0`` | +-----------------------------------------------+-------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`loop_end` | ``0`` | +-----------------------------------------------+-------------------------------------------------------------+-----------------------+ | :ref:`LoopMode` | :ref:`loop_mode` | ``0`` | +-----------------------------------------------+-------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`mix_rate` | ``44100`` | +-----------------------------------------------+-------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`stereo` | ``false`` | +-----------------------------------------------+-------------------------------------------------------------+-----------------------+ | :ref:`Dictionary` | :ref:`tags` | ``{}`` | +-----------------------------------------------+-------------------------------------------------------------+-----------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AudioStreamWAV` | :ref:`load_from_buffer`\ (\ stream_data\: :ref:`PackedByteArray`, options\: :ref:`Dictionary` = {}\ ) |static| | +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AudioStreamWAV` | :ref:`load_from_file`\ (\ path\: :ref:`String`, options\: :ref:`Dictionary` = {}\ ) |static| | +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`save_to_wav`\ (\ path\: :ref:`String`\ ) | +---------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_AudioStreamWAV_Format: .. rst-class:: classref-enumeration enum **Format**: :ref:`🔗` .. _class_AudioStreamWAV_constant_FORMAT_8_BITS: .. rst-class:: classref-enumeration-constant :ref:`Format` **FORMAT_8_BITS** = ``0`` 8-bit PCM audio codec. .. _class_AudioStreamWAV_constant_FORMAT_16_BITS: .. rst-class:: classref-enumeration-constant :ref:`Format` **FORMAT_16_BITS** = ``1`` 16-bit PCM audio codec. .. _class_AudioStreamWAV_constant_FORMAT_IMA_ADPCM: .. rst-class:: classref-enumeration-constant :ref:`Format` **FORMAT_IMA_ADPCM** = ``2`` Audio is lossily compressed as IMA ADPCM. .. _class_AudioStreamWAV_constant_FORMAT_QOA: .. rst-class:: classref-enumeration-constant :ref:`Format` **FORMAT_QOA** = ``3`` Audio is lossily compressed as `Quite OK Audio `__. .. rst-class:: classref-item-separator ---- .. _enum_AudioStreamWAV_LoopMode: .. rst-class:: classref-enumeration enum **LoopMode**: :ref:`🔗` .. _class_AudioStreamWAV_constant_LOOP_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`LoopMode` **LOOP_DISABLED** = ``0`` Audio does not loop. .. _class_AudioStreamWAV_constant_LOOP_FORWARD: .. rst-class:: classref-enumeration-constant :ref:`LoopMode` **LOOP_FORWARD** = ``1`` Audio loops the data between :ref:`loop_begin` and :ref:`loop_end`, playing forward only. .. _class_AudioStreamWAV_constant_LOOP_PINGPONG: .. rst-class:: classref-enumeration-constant :ref:`LoopMode` **LOOP_PINGPONG** = ``2`` Audio loops the data between :ref:`loop_begin` and :ref:`loop_end`, playing back and forth. .. _class_AudioStreamWAV_constant_LOOP_BACKWARD: .. rst-class:: classref-enumeration-constant :ref:`LoopMode` **LOOP_BACKWARD** = ``3`` Audio loops the data between :ref:`loop_begin` and :ref:`loop_end`, playing backward only. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_AudioStreamWAV_property_data: .. rst-class:: classref-property :ref:`PackedByteArray` **data** = ``PackedByteArray()`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_data**\ (\ value\: :ref:`PackedByteArray`\ ) - :ref:`PackedByteArray` **get_data**\ (\ ) Contains the audio data in bytes. \ **Note:** If :ref:`format` is set to :ref:`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 :ref:`format` is set to :ref:`FORMAT_QOA`, this property expects data from a full QOA file. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedByteArray` for more details. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamWAV_property_format: .. rst-class:: classref-property :ref:`Format` **format** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_format**\ (\ value\: :ref:`Format`\ ) - :ref:`Format` **get_format**\ (\ ) Audio format. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamWAV_property_loop_begin: .. rst-class:: classref-property :ref:`int` **loop_begin** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_loop_begin**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_loop_begin**\ (\ ) The loop start point (in number of samples, relative to the beginning of the stream). .. rst-class:: classref-item-separator ---- .. _class_AudioStreamWAV_property_loop_end: .. rst-class:: classref-property :ref:`int` **loop_end** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_loop_end**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_loop_end**\ (\ ) The loop end point (in number of samples, relative to the beginning of the stream). .. rst-class:: classref-item-separator ---- .. _class_AudioStreamWAV_property_loop_mode: .. rst-class:: classref-property :ref:`LoopMode` **loop_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_loop_mode**\ (\ value\: :ref:`LoopMode`\ ) - :ref:`LoopMode` **get_loop_mode**\ (\ ) The loop mode. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamWAV_property_mix_rate: .. rst-class:: classref-property :ref:`int` **mix_rate** = ``44100`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_mix_rate**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_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 ``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. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamWAV_property_stereo: .. rst-class:: classref-property :ref:`bool` **stereo** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_stereo**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_stereo**\ (\ ) If ``true``, audio is stereo. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamWAV_property_tags: .. rst-class:: classref-property :ref:`Dictionary` **tags** = ``{}`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_tags**\ (\ value\: :ref:`Dictionary`\ ) - :ref:`Dictionary` **get_tags**\ (\ ) 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. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_AudioStreamWAV_method_load_from_buffer: .. rst-class:: classref-method :ref:`AudioStreamWAV` **load_from_buffer**\ (\ stream_data\: :ref:`PackedByteArray`, options\: :ref:`Dictionary` = {}\ ) |static| :ref:`🔗` 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 :ref:`ResourceImporterWAV`. The usage of ``options`` is identical to :ref:`load_from_file()`. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamWAV_method_load_from_file: .. rst-class:: classref-method :ref:`AudioStreamWAV` **load_from_file**\ (\ path\: :ref:`String`, options\: :ref:`Dictionary` = {}\ ) |static| :ref:`🔗` 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 :ref:`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() .. rst-class:: classref-item-separator ---- .. _class_AudioStreamWAV_method_save_to_wav: .. rst-class:: classref-method :ref:`Error` **save_to_wav**\ (\ path\: :ref:`String`\ ) :ref:`🔗` 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. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`