mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 17:28:58 +00:00
Rémi Verschelde
2b4319bc29
Changes order of brief/long descriptions and removes category as per godotengine/godot#35132.
44 lines
1.6 KiB
ReStructuredText
44 lines
1.6 KiB
ReStructuredText
: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>`
|
|
|
|
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:`../tutorials/audio/audio_streams`
|
|
|
|
Methods
|
|
-------
|
|
|
|
+---------------------------+--------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`get_length<class_AudioStream_method_get_length>` **(** **)** const |
|
|
+---------------------------+--------------------------------------------------------------------------+
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_AudioStream_method_get_length:
|
|
|
|
- :ref:`float<class_float>` **get_length** **(** **)** const
|
|
|
|
Returns the length of the audio stream in seconds.
|
|
|