class_audiostreamoggvorbis.rst 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the AudioStreamOGGVorbis.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_AudioStreamOGGVorbis:
  6. AudioStreamOGGVorbis
  7. ====================
  8. **Inherits:** :ref:`AudioStream<class_AudioStream>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. OGG Vorbis audio stream driver.
  13. Properties
  14. ----------
  15. +-------------------------------------------+---------------------------------------------------------------------+
  16. | :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`data<class_AudioStreamOGGVorbis_property_data>` |
  17. +-------------------------------------------+---------------------------------------------------------------------+
  18. | :ref:`bool<class_bool>` | :ref:`loop<class_AudioStreamOGGVorbis_property_loop>` |
  19. +-------------------------------------------+---------------------------------------------------------------------+
  20. | :ref:`float<class_float>` | :ref:`loop_offset<class_AudioStreamOGGVorbis_property_loop_offset>` |
  21. +-------------------------------------------+---------------------------------------------------------------------+
  22. Description
  23. -----------
  24. OGG Vorbis audio stream driver.
  25. Property Descriptions
  26. ---------------------
  27. .. _class_AudioStreamOGGVorbis_property_data:
  28. - :ref:`PoolByteArray<class_PoolByteArray>` **data**
  29. +----------+-----------------+
  30. | *Setter* | set_data(value) |
  31. +----------+-----------------+
  32. | *Getter* | get_data() |
  33. +----------+-----------------+
  34. Contains the audio data in bytes.
  35. ----
  36. .. _class_AudioStreamOGGVorbis_property_loop:
  37. - :ref:`bool<class_bool>` **loop**
  38. +----------+-----------------+
  39. | *Setter* | set_loop(value) |
  40. +----------+-----------------+
  41. | *Getter* | has_loop() |
  42. +----------+-----------------+
  43. ----
  44. .. _class_AudioStreamOGGVorbis_property_loop_offset:
  45. - :ref:`float<class_float>` **loop_offset**
  46. +----------+------------------------+
  47. | *Setter* | set_loop_offset(value) |
  48. +----------+------------------------+
  49. | *Getter* | get_loop_offset() |
  50. +----------+------------------------+