Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Branch: 3.2
Branches Tags
godot-docs
/
classes
/
class_audiostream.rst

class_audiostream.rst 1.9 KB
Permalink History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the AudioStream.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_AudioStream:
    8. 

  8. 

  9. AudioStream
    10. 

  10. ===========
    11. 

  11. 

  12. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. **Inherited By:** :ref:`AudioStreamGenerator<class_AudioStreamGenerator>`, :ref:`AudioStreamMicrophone<class_AudioStreamMicrophone>`, :ref:`AudioStreamOGGVorbis<class_AudioStreamOGGVorbis>`, :ref:`AudioStreamRandomPitch<class_AudioStreamRandomPitch>`, :ref:`AudioStreamSample<class_AudioStreamSample>`
    15. 

  15. 

  16. Base class for audio streams.
    17. 

  17. 

  18. Description
    19. 

  19. -----------
    20. 

  20. 

  21. 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.
    22. 

  22. 

  23. Tutorials
    24. 

  24. ---------
    25. 

  25. 

  26. - :doc:`../tutorials/audio/audio_streams`
    27. 

  27. 

  28. Methods
    29. 

  29. -------
    30. 

  30. 

  31. +---------------------------+----------------------------------------------------------------------------+
    32. 

  32. | :ref:`float<class_float>` | :ref:`get_length<class_AudioStream_method_get_length>` **(** **)** |const| |
    33. 

  33. +---------------------------+----------------------------------------------------------------------------+
    34. 

  34. 

  35. Method Descriptions
    36. 

  36. -------------------
    37. 

  37. 

  38. .. _class_AudioStream_method_get_length:
    39. 

  39. 

  40. - :ref:`float<class_float>` **get_length** **(** **)** |const|
    41. 

  41. 

  42. Returns the length of the audio stream in seconds.
    43. 

  43. 

  44. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    45. 

  45. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    46. 

  46. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    47.