AudioStreamOGGVorbis.xml 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="AudioStreamOGGVorbis" inherits="AudioStream" category="Core" version="3.0.alpha.custom_build">
  3. <brief_description>
  4. OGG Vorbis audio stream driver.
  5. </brief_description>
  6. <description>
  7. OGG Vorbis audio stream driver.
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <demos>
  12. </demos>
  13. <methods>
  14. <method name="get_data" qualifiers="const">
  15. <return type="PoolByteArray">
  16. </return>
  17. <description>
  18. </description>
  19. </method>
  20. <method name="get_loop_offset" qualifiers="const">
  21. <return type="float">
  22. </return>
  23. <description>
  24. </description>
  25. </method>
  26. <method name="has_loop" qualifiers="const">
  27. <return type="bool">
  28. </return>
  29. <description>
  30. </description>
  31. </method>
  32. <method name="set_data">
  33. <return type="void">
  34. </return>
  35. <argument index="0" name="data" type="PoolByteArray">
  36. </argument>
  37. <description>
  38. </description>
  39. </method>
  40. <method name="set_loop">
  41. <return type="void">
  42. </return>
  43. <argument index="0" name="enable" type="bool">
  44. </argument>
  45. <description>
  46. </description>
  47. </method>
  48. <method name="set_loop_offset">
  49. <return type="void">
  50. </return>
  51. <argument index="0" name="seconds" type="float">
  52. </argument>
  53. <description>
  54. </description>
  55. </method>
  56. </methods>
  57. <members>
  58. <member name="data" type="PoolByteArray" setter="set_data" getter="get_data">
  59. Raw audio data.
  60. </member>
  61. <member name="loop" type="bool" setter="set_loop" getter="has_loop">
  62. If [code]true[/code], audio will loop continuously. Default value: [code]false[/code].
  63. </member>
  64. <member name="loop_offset" type="float" setter="set_loop_offset" getter="get_loop_offset">
  65. If loop is [code]true[/code], loop starts from this position, in seconds.
  66. </member>
  67. </members>
  68. <constants>
  69. </constants>
  70. </class>