AudioStream.xml 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="AudioStream" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
  3. <brief_description>
  4. Base class for audio streams.
  5. </brief_description>
  6. <description>
  7. Base class for audio streams. Audio streams are used for sound effects and music playback, and support WAV (via [AudioStreamWAV]) and Ogg (via [AudioStreamOggVorbis]) file formats.
  8. </description>
  9. <tutorials>
  10. <link title="Audio streams">$DOCS_URL/tutorials/audio/audio_streams.html</link>
  11. <link title="Audio Generator Demo">https://godotengine.org/asset-library/asset/526</link>
  12. <link title="Audio Mic Record Demo">https://godotengine.org/asset-library/asset/527</link>
  13. <link title="Audio Spectrum Demo">https://godotengine.org/asset-library/asset/528</link>
  14. </tutorials>
  15. <methods>
  16. <method name="_get_beat_count" qualifiers="virtual const">
  17. <return type="int" />
  18. <description>
  19. </description>
  20. </method>
  21. <method name="_get_bpm" qualifiers="virtual const">
  22. <return type="float" />
  23. <description>
  24. </description>
  25. </method>
  26. <method name="_get_length" qualifiers="virtual const">
  27. <return type="float" />
  28. <description>
  29. </description>
  30. </method>
  31. <method name="_get_stream_name" qualifiers="virtual const">
  32. <return type="String" />
  33. <description>
  34. </description>
  35. </method>
  36. <method name="_instantiate_playback" qualifiers="virtual const">
  37. <return type="AudioStreamPlayback" />
  38. <description>
  39. </description>
  40. </method>
  41. <method name="_is_monophonic" qualifiers="virtual const">
  42. <return type="bool" />
  43. <description>
  44. </description>
  45. </method>
  46. <method name="get_length" qualifiers="const">
  47. <return type="float" />
  48. <description>
  49. Returns the length of the audio stream in seconds.
  50. </description>
  51. </method>
  52. <method name="instantiate_playback">
  53. <return type="AudioStreamPlayback" />
  54. <description>
  55. Returns an AudioStreamPlayback. Useful for when you want to extend [method _instantiate_playback] but call [method instantiate_playback] from an internally held AudioStream subresource. An example of this can be found in the source files for [code]AudioStreamRandomPitch::instantiate_playback[/code].
  56. </description>
  57. </method>
  58. <method name="is_monophonic" qualifiers="const">
  59. <return type="bool" />
  60. <description>
  61. Returns true if this audio stream only supports monophonic playback, or false if the audio stream supports polyphony.
  62. </description>
  63. </method>
  64. </methods>
  65. </class>