class_audiostream.rst 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  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:`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. Member Functions
  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. Member Function Description
  22. ---------------------------
  23. .. _class_AudioStream_get_length:
  24. - :ref:`float<class_float>` **get_length** **(** **)** const