class_audiostream.rst 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the AudioStream.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_AudioStream:
  5. AudioStream
  6. ===========
  7. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  8. **Inherited By:** :ref:`AudioStreamMicrophone<class_AudioStreamMicrophone>`, :ref:`AudioStreamSample<class_AudioStreamSample>`, :ref:`AudioStreamRandomPitch<class_AudioStreamRandomPitch>`, :ref:`AudioStreamOGGVorbis<class_AudioStreamOGGVorbis>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Base class for audio streams.
  13. Methods
  14. -------
  15. +----------------------------+-------------------------------------------------------------------+
  16. | :ref:`float<class_float>` | :ref:`get_length<class_AudioStream_get_length>` **(** **)** const |
  17. +----------------------------+-------------------------------------------------------------------+
  18. Description
  19. -----------
  20. 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.
  21. Tutorials
  22. ---------
  23. - :doc:`../tutorials/audio/audio_streams`
  24. Method Descriptions
  25. -------------------
  26. .. _class_AudioStream_get_length:
  27. - :ref:`float<class_float>` **get_length** **(** **)** const
  28. Returns the length of the audio stream in seconds.