class_audiostreamoggvorbis.rst 2.2 KB

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