:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the AudioStream.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_AudioStream:

AudioStream
===========

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

**Inherited By:** :ref:`AudioStreamGenerator<class_AudioStreamGenerator>`, :ref:`AudioStreamMP3<class_AudioStreamMP3>`, :ref:`AudioStreamMicrophone<class_AudioStreamMicrophone>`, :ref:`AudioStreamOGGVorbis<class_AudioStreamOGGVorbis>`, :ref:`AudioStreamRandomizer<class_AudioStreamRandomizer>`, :ref:`AudioStreamSample<class_AudioStreamSample>`

Base class for audio streams.

Description
-----------

Base class for audio streams. Audio streams are used for sound effects and music playback, and support WAV (via :ref:`AudioStreamSample<class_AudioStreamSample>`) and OGG (via :ref:`AudioStreamOGGVorbis<class_AudioStreamOGGVorbis>`) file formats.

Tutorials
---------

- :doc:`Audio streams <../tutorials/audio/audio_streams>`

- `Audio Generator Demo <https://godotengine.org/asset-library/asset/526>`__

- `Audio Mic Record Demo <https://godotengine.org/asset-library/asset/527>`__

- `Audio Spectrum Demo <https://godotengine.org/asset-library/asset/528>`__

Methods
-------

+-------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`_get_length<class_AudioStream_method__get_length>` **(** **)** |virtual| |const|               |
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                           | :ref:`_get_stream_name<class_AudioStream_method__get_stream_name>` **(** **)** |virtual| |const|     |
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` | :ref:`_instance_playback<class_AudioStream_method__instance_playback>` **(** **)** |virtual| |const| |
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                               | :ref:`_is_monophonic<class_AudioStream_method__is_monophonic>` **(** **)** |virtual| |const|         |
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                             | :ref:`get_length<class_AudioStream_method_get_length>` **(** **)** |const|                           |
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` | :ref:`instance_playback<class_AudioStream_method_instance_playback>` **(** **)**                     |
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                               | :ref:`is_monophonic<class_AudioStream_method_is_monophonic>` **(** **)** |const|                     |
+-------------------------------------------------------+------------------------------------------------------------------------------------------------------+

Method Descriptions
-------------------

.. _class_AudioStream_method__get_length:

- :ref:`float<class_float>` **_get_length** **(** **)** |virtual| |const|

----

.. _class_AudioStream_method__get_stream_name:

- :ref:`String<class_String>` **_get_stream_name** **(** **)** |virtual| |const|

----

.. _class_AudioStream_method__instance_playback:

- :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` **_instance_playback** **(** **)** |virtual| |const|

----

.. _class_AudioStream_method__is_monophonic:

- :ref:`bool<class_bool>` **_is_monophonic** **(** **)** |virtual| |const|

----

.. _class_AudioStream_method_get_length:

- :ref:`float<class_float>` **get_length** **(** **)** |const|

Returns the length of the audio stream in seconds.

----

.. _class_AudioStream_method_instance_playback:

- :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` **instance_playback** **(** **)**

Returns an AudioStreamPlayback. Useful for when you want to extend `_instance_playback` but call `instance_playback` from an internally held AudioStream subresource. An example of this can be found in the source files for `AudioStreamRandomPitch::instance_playback`.

----

.. _class_AudioStream_method_is_monophonic:

- :ref:`bool<class_bool>` **is_monophonic** **(** **)** |const|

Returns true if this audio stream only supports monophonic playback, or false if the audio stream supports polyphony.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |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.)`