:github_url: hide

.. Generated automatically by doc/tools/makerst.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:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

**Inherited By:** :ref:`AudioStreamGenerator<class_AudioStreamGenerator>`, :ref:`AudioStreamMicrophone<class_AudioStreamMicrophone>`, :ref:`AudioStreamOGGVorbis<class_AudioStreamOGGVorbis>`, :ref:`AudioStreamRandomPitch<class_AudioStreamRandomPitch>`, :ref:`AudioStreamSample<class_AudioStreamSample>`

**Category:** Core

Brief Description
-----------------

Base class for audio streams.

Methods
-------

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

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:`../tutorials/audio/audio_streams`

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

.. _class_AudioStream_method_get_length:

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

Returns the length of the audio stream in seconds.