mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-21 15:07:22 +01:00
53 lines
2.2 KiB
ReStructuredText
53 lines
2.2 KiB
ReStructuredText
|
: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:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||
|
|
|
||
|
|
**Inherited By:** :ref:`AudioStreamGenerator<class_AudioStreamGenerator>`, :ref:`AudioStreamMP3<class_AudioStreamMP3>`, :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`
|
||
|
|
|
||
|
|
- `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>` **(** **)** |const| |
|
||
|
|
+---------------------------+----------------------------------------------------------------------------+
|
||
|
|
|
||
|
|
Method Descriptions
|
||
|
|
-------------------
|
||
|
|
|
||
|
|
.. _class_AudioStream_method_get_length:
|
||
|
|
|
||
|
|
- :ref:`float<class_float>` **get_length** **(** **)** |const|
|
||
|
|
|
||
|
|
Returns the length of the audio stream in seconds.
|
||
|
|
|
||
|
|
.. |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.)`
|