Files
godot-docs/classes/class_audiostream.rst
T

47 lines
1.4 KiB
ReStructuredText

.. 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:`AudioStreamMicrophone<class_AudioStreamMicrophone>`, :ref:`AudioStreamSample<class_AudioStreamSample>`, :ref:`AudioStreamRandomPitch<class_AudioStreamRandomPitch>`, :ref:`AudioStreamOGGVorbis<class_AudioStreamOGGVorbis>`
**Category:** Core
Brief Description
-----------------
Base class for audio streams.
Methods
-------
+----------------------------+-------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_length<class_AudioStream_get_length>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------+
Description
-----------
Base class for audio streams. Audio streams are used for music playback, or other types of streamed sounds that don't fit or require more flexibility than a Sample.
Tutorials
---------
- :doc:`../tutorials/audio/audio_streams`
Method Descriptions
-------------------
.. _class_AudioStream_get_length:
- :ref:`float<class_float>` **get_length** **(** **)** const
Returns the length of the audio stream in seconds.