class_audiostreamplayer.rst 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_AudioStreamPlayer:
  4. AudioStreamPlayer
  5. =================
  6. **Inherits:** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Member Functions
  11. ----------------
  12. +------------------------------+------------------------------------------------------------------------------------------------------------------+
  13. | :ref:`String<class_string>` | :ref:`get_bus<class_AudioStreamPlayer_get_bus>` **(** **)** const |
  14. +------------------------------+------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`int<class_int>` | :ref:`get_mix_target<class_AudioStreamPlayer_get_mix_target>` **(** **)** const |
  16. +------------------------------+------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`float<class_float>` | :ref:`get_pos<class_AudioStreamPlayer_get_pos>` **(** **)** |
  18. +------------------------------+------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`Object<class_object>` | :ref:`get_stream<class_AudioStreamPlayer_get_stream>` **(** **)** const |
  20. +------------------------------+------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`float<class_float>` | :ref:`get_volume_db<class_AudioStreamPlayer_get_volume_db>` **(** **)** const |
  22. +------------------------------+------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`bool<class_bool>` | :ref:`is_autoplay_enabled<class_AudioStreamPlayer_is_autoplay_enabled>` **(** **)** |
  24. +------------------------------+------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`bool<class_bool>` | :ref:`is_playing<class_AudioStreamPlayer_is_playing>` **(** **)** const |
  26. +------------------------------+------------------------------------------------------------------------------------------------------------------+
  27. | void | :ref:`play<class_AudioStreamPlayer_play>` **(** :ref:`float<class_float>` from_pos=0 **)** |
  28. +------------------------------+------------------------------------------------------------------------------------------------------------------+
  29. | void | :ref:`seek<class_AudioStreamPlayer_seek>` **(** :ref:`float<class_float>` to_pos **)** |
  30. +------------------------------+------------------------------------------------------------------------------------------------------------------+
  31. | void | :ref:`set_autoplay<class_AudioStreamPlayer_set_autoplay>` **(** :ref:`bool<class_bool>` enable **)** |
  32. +------------------------------+------------------------------------------------------------------------------------------------------------------+
  33. | void | :ref:`set_bus<class_AudioStreamPlayer_set_bus>` **(** :ref:`String<class_string>` bus **)** |
  34. +------------------------------+------------------------------------------------------------------------------------------------------------------+
  35. | void | :ref:`set_mix_target<class_AudioStreamPlayer_set_mix_target>` **(** :ref:`int<class_int>` mix_target **)** |
  36. +------------------------------+------------------------------------------------------------------------------------------------------------------+
  37. | void | :ref:`set_stream<class_AudioStreamPlayer_set_stream>` **(** :ref:`AudioStream<class_audiostream>` stream **)** |
  38. +------------------------------+------------------------------------------------------------------------------------------------------------------+
  39. | void | :ref:`set_volume_db<class_AudioStreamPlayer_set_volume_db>` **(** :ref:`float<class_float>` volume_db **)** |
  40. +------------------------------+------------------------------------------------------------------------------------------------------------------+
  41. | void | :ref:`stop<class_AudioStreamPlayer_stop>` **(** **)** |
  42. +------------------------------+------------------------------------------------------------------------------------------------------------------+
  43. Member Variables
  44. ----------------
  45. - :ref:`bool<class_bool>` **autoplay**
  46. - :ref:`String<class_string>` **bus**
  47. - :ref:`int<class_int>` **mix_target**
  48. - :ref:`bool<class_bool>` **playing**
  49. - :ref:`AudioStream<class_audiostream>` **stream**
  50. - :ref:`float<class_float>` **volume_db**
  51. Member Function Description
  52. ---------------------------
  53. .. _class_AudioStreamPlayer_get_bus:
  54. - :ref:`String<class_string>` **get_bus** **(** **)** const
  55. .. _class_AudioStreamPlayer_get_mix_target:
  56. - :ref:`int<class_int>` **get_mix_target** **(** **)** const
  57. .. _class_AudioStreamPlayer_get_pos:
  58. - :ref:`float<class_float>` **get_pos** **(** **)**
  59. .. _class_AudioStreamPlayer_get_stream:
  60. - :ref:`Object<class_object>` **get_stream** **(** **)** const
  61. .. _class_AudioStreamPlayer_get_volume_db:
  62. - :ref:`float<class_float>` **get_volume_db** **(** **)** const
  63. .. _class_AudioStreamPlayer_is_autoplay_enabled:
  64. - :ref:`bool<class_bool>` **is_autoplay_enabled** **(** **)**
  65. .. _class_AudioStreamPlayer_is_playing:
  66. - :ref:`bool<class_bool>` **is_playing** **(** **)** const
  67. .. _class_AudioStreamPlayer_play:
  68. - void **play** **(** :ref:`float<class_float>` from_pos=0 **)**
  69. .. _class_AudioStreamPlayer_seek:
  70. - void **seek** **(** :ref:`float<class_float>` to_pos **)**
  71. .. _class_AudioStreamPlayer_set_autoplay:
  72. - void **set_autoplay** **(** :ref:`bool<class_bool>` enable **)**
  73. .. _class_AudioStreamPlayer_set_bus:
  74. - void **set_bus** **(** :ref:`String<class_string>` bus **)**
  75. .. _class_AudioStreamPlayer_set_mix_target:
  76. - void **set_mix_target** **(** :ref:`int<class_int>` mix_target **)**
  77. .. _class_AudioStreamPlayer_set_stream:
  78. - void **set_stream** **(** :ref:`AudioStream<class_audiostream>` stream **)**
  79. .. _class_AudioStreamPlayer_set_volume_db:
  80. - void **set_volume_db** **(** :ref:`float<class_float>` volume_db **)**
  81. .. _class_AudioStreamPlayer_stop:
  82. - void **stop** **(** **)**