Files
godot-docs/classes/class_audiostream.rst
2018-02-19 10:48:33 +01:00

41 lines
1.3 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:`AudioStreamSample<class_audiostreamsample>`, :ref:`AudioStreamRandomPitch<class_audiostreamrandompitch>`, :ref:`AudioStreamOGGVorbis<class_audiostreamoggvorbis>`
**Category:** Core
Brief Description
-----------------
Base class for audio streams.
Member Functions
----------------
+----------------------------+-------------------------------------------------------------------+
| :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.
Member Function Description
---------------------------
.. _class_AudioStream_get_length:
- :ref:`float<class_float>` **get_length** **(** **)** const