class_audioserver.rst 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the AudioServer.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_AudioServer:
  5. AudioServer
  6. ===========
  7. **Inherits:** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Server interface for low level audio access.
  12. Methods
  13. -------
  14. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | void | :ref:`add_bus<class_AudioServer_add_bus>` **(** :ref:`int<class_int>` at_position=-1 **)** |
  16. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | void | :ref:`add_bus_effect<class_AudioServer_add_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`AudioEffect<class_AudioEffect>` effect, :ref:`int<class_int>` at_position=-1 **)** |
  18. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`String<class_String>` | :ref:`capture_get_device<class_AudioServer_capture_get_device>` **(** **)** |
  20. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`Array<class_Array>` | :ref:`capture_get_device_list<class_AudioServer_capture_get_device_list>` **(** **)** |
  22. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | void | :ref:`capture_set_device<class_AudioServer_capture_set_device>` **(** :ref:`String<class_String>` name **)** |
  24. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`AudioBusLayout<class_AudioBusLayout>` | :ref:`generate_bus_layout<class_AudioServer_generate_bus_layout>` **(** **)** const |
  26. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`int<class_int>` | :ref:`get_bus_count<class_AudioServer_get_bus_count>` **(** **)** const |
  28. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`AudioEffect<class_AudioEffect>` | :ref:`get_bus_effect<class_AudioServer_get_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** |
  30. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`int<class_int>` | :ref:`get_bus_effect_count<class_AudioServer_get_bus_effect_count>` **(** :ref:`int<class_int>` bus_idx **)** |
  32. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`int<class_int>` | :ref:`get_bus_index<class_AudioServer_get_bus_index>` **(** :ref:`String<class_String>` bus_name **)** const |
  34. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. | :ref:`String<class_String>` | :ref:`get_bus_name<class_AudioServer_get_bus_name>` **(** :ref:`int<class_int>` bus_idx **)** const |
  36. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. | :ref:`float<class_float>` | :ref:`get_bus_peak_volume_left_db<class_AudioServer_get_bus_peak_volume_left_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const |
  38. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  39. | :ref:`float<class_float>` | :ref:`get_bus_peak_volume_right_db<class_AudioServer_get_bus_peak_volume_right_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const |
  40. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`String<class_String>` | :ref:`get_bus_send<class_AudioServer_get_bus_send>` **(** :ref:`int<class_int>` bus_idx **)** const |
  42. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | :ref:`float<class_float>` | :ref:`get_bus_volume_db<class_AudioServer_get_bus_volume_db>` **(** :ref:`int<class_int>` bus_idx **)** const |
  44. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | :ref:`String<class_String>` | :ref:`get_device<class_AudioServer_get_device>` **(** **)** |
  46. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | :ref:`Array<class_Array>` | :ref:`get_device_list<class_AudioServer_get_device_list>` **(** **)** |
  48. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | :ref:`float<class_float>` | :ref:`get_mix_rate<class_AudioServer_get_mix_rate>` **(** **)** const |
  50. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | :ref:`SpeakerMode<enum_AudioServer_SpeakerMode>` | :ref:`get_speaker_mode<class_AudioServer_get_speaker_mode>` **(** **)** const |
  52. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | :ref:`bool<class_bool>` | :ref:`is_bus_bypassing_effects<class_AudioServer_is_bus_bypassing_effects>` **(** :ref:`int<class_int>` bus_idx **)** const |
  54. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | :ref:`bool<class_bool>` | :ref:`is_bus_effect_enabled<class_AudioServer_is_bus_effect_enabled>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** const |
  56. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | :ref:`bool<class_bool>` | :ref:`is_bus_mute<class_AudioServer_is_bus_mute>` **(** :ref:`int<class_int>` bus_idx **)** const |
  58. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | :ref:`bool<class_bool>` | :ref:`is_bus_solo<class_AudioServer_is_bus_solo>` **(** :ref:`int<class_int>` bus_idx **)** const |
  60. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | void | :ref:`lock<class_AudioServer_lock>` **(** **)** |
  62. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | void | :ref:`move_bus<class_AudioServer_move_bus>` **(** :ref:`int<class_int>` index, :ref:`int<class_int>` to_index **)** |
  64. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | void | :ref:`remove_bus<class_AudioServer_remove_bus>` **(** :ref:`int<class_int>` index **)** |
  66. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | void | :ref:`remove_bus_effect<class_AudioServer_remove_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** |
  68. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | void | :ref:`set_bus_bypass_effects<class_AudioServer_set_bus_bypass_effects>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
  70. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | void | :ref:`set_bus_count<class_AudioServer_set_bus_count>` **(** :ref:`int<class_int>` amount **)** |
  72. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | void | :ref:`set_bus_effect_enabled<class_AudioServer_set_bus_effect_enabled>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`bool<class_bool>` enabled **)** |
  74. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | void | :ref:`set_bus_layout<class_AudioServer_set_bus_layout>` **(** :ref:`AudioBusLayout<class_AudioBusLayout>` bus_layout **)** |
  76. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | void | :ref:`set_bus_mute<class_AudioServer_set_bus_mute>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
  78. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | void | :ref:`set_bus_name<class_AudioServer_set_bus_name>` **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_String>` name **)** |
  80. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | void | :ref:`set_bus_send<class_AudioServer_set_bus_send>` **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_String>` send **)** |
  82. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | void | :ref:`set_bus_solo<class_AudioServer_set_bus_solo>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
  84. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | void | :ref:`set_bus_volume_db<class_AudioServer_set_bus_volume_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`float<class_float>` volume_db **)** |
  86. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | void | :ref:`set_device<class_AudioServer_set_device>` **(** :ref:`String<class_String>` device **)** |
  88. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | void | :ref:`swap_bus_effects<class_AudioServer_swap_bus_effects>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`int<class_int>` by_effect_idx **)** |
  90. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | void | :ref:`unlock<class_AudioServer_unlock>` **(** **)** |
  92. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. Signals
  94. -------
  95. .. _class_AudioServer_bus_layout_changed:
  96. - **bus_layout_changed** **(** **)**
  97. Emitted when the :ref:`AudioBusLayout<class_AudioBusLayout>` changes.
  98. Enumerations
  99. ------------
  100. .. _enum_AudioServer_SpeakerMode:
  101. enum **SpeakerMode**:
  102. - **SPEAKER_MODE_STEREO** = **0** --- Two or fewer speakers are detected.
  103. - **SPEAKER_SURROUND_31** = **1**
  104. - **SPEAKER_SURROUND_51** = **2** --- A 5.1 channel surround setup detected.
  105. - **SPEAKER_SURROUND_71** = **3** --- A 7.1 channel surround setup detected.
  106. Description
  107. -----------
  108. AudioServer is a low level server interface for audio access. It is in charge of creating sample data (playable audio) as well as its playback via a voice interface.
  109. Tutorials
  110. ---------
  111. - :doc:`../tutorials/audio/audio_buses`
  112. Method Descriptions
  113. -------------------
  114. .. _class_AudioServer_add_bus:
  115. - void **add_bus** **(** :ref:`int<class_int>` at_position=-1 **)**
  116. Adds a bus at ``at_position``.
  117. .. _class_AudioServer_add_bus_effect:
  118. - void **add_bus_effect** **(** :ref:`int<class_int>` bus_idx, :ref:`AudioEffect<class_AudioEffect>` effect, :ref:`int<class_int>` at_position=-1 **)**
  119. Adds an :ref:`AudioEffect<class_AudioEffect>` effect to the bus ``bus_idx`` at ``at_position``.
  120. .. _class_AudioServer_capture_get_device:
  121. - :ref:`String<class_String>` **capture_get_device** **(** **)**
  122. .. _class_AudioServer_capture_get_device_list:
  123. - :ref:`Array<class_Array>` **capture_get_device_list** **(** **)**
  124. .. _class_AudioServer_capture_set_device:
  125. - void **capture_set_device** **(** :ref:`String<class_String>` name **)**
  126. .. _class_AudioServer_generate_bus_layout:
  127. - :ref:`AudioBusLayout<class_AudioBusLayout>` **generate_bus_layout** **(** **)** const
  128. Generates an :ref:`AudioBusLayout<class_AudioBusLayout>` using the available busses and effects.
  129. .. _class_AudioServer_get_bus_count:
  130. - :ref:`int<class_int>` **get_bus_count** **(** **)** const
  131. Returns the number of available busses.
  132. .. _class_AudioServer_get_bus_effect:
  133. - :ref:`AudioEffect<class_AudioEffect>` **get_bus_effect** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)**
  134. Returns the :ref:`AudioEffect<class_AudioEffect>` at position ``effect_idx`` in bus ``bus_idx``.
  135. .. _class_AudioServer_get_bus_effect_count:
  136. - :ref:`int<class_int>` **get_bus_effect_count** **(** :ref:`int<class_int>` bus_idx **)**
  137. Returns the number of effects on the bus at ``bus_idx``.
  138. .. _class_AudioServer_get_bus_index:
  139. - :ref:`int<class_int>` **get_bus_index** **(** :ref:`String<class_String>` bus_name **)** const
  140. Returns the index of the bus with the name ``bus_name``.
  141. .. _class_AudioServer_get_bus_name:
  142. - :ref:`String<class_String>` **get_bus_name** **(** :ref:`int<class_int>` bus_idx **)** const
  143. Returns the name of the bus with the index ``bus_idx``.
  144. .. _class_AudioServer_get_bus_peak_volume_left_db:
  145. - :ref:`float<class_float>` **get_bus_peak_volume_left_db** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const
  146. Returns the peak volume of the left speaker at bus index ``bus_idx`` and channel index ``channel``.
  147. .. _class_AudioServer_get_bus_peak_volume_right_db:
  148. - :ref:`float<class_float>` **get_bus_peak_volume_right_db** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const
  149. Returns the peak volume of the right speaker at bus index ``bus_idx`` and channel index ``channel``.
  150. .. _class_AudioServer_get_bus_send:
  151. - :ref:`String<class_String>` **get_bus_send** **(** :ref:`int<class_int>` bus_idx **)** const
  152. Returns the name of the bus that the bus at index ``bus_idx`` sends to.
  153. .. _class_AudioServer_get_bus_volume_db:
  154. - :ref:`float<class_float>` **get_bus_volume_db** **(** :ref:`int<class_int>` bus_idx **)** const
  155. Returns the volume of the bus at index ``bus_idx`` in dB.
  156. .. _class_AudioServer_get_device:
  157. - :ref:`String<class_String>` **get_device** **(** **)**
  158. .. _class_AudioServer_get_device_list:
  159. - :ref:`Array<class_Array>` **get_device_list** **(** **)**
  160. .. _class_AudioServer_get_mix_rate:
  161. - :ref:`float<class_float>` **get_mix_rate** **(** **)** const
  162. Returns the sample rate at the output of the audioserver.
  163. .. _class_AudioServer_get_speaker_mode:
  164. - :ref:`SpeakerMode<enum_AudioServer_SpeakerMode>` **get_speaker_mode** **(** **)** const
  165. Returns the speaker configuration.
  166. .. _class_AudioServer_is_bus_bypassing_effects:
  167. - :ref:`bool<class_bool>` **is_bus_bypassing_effects** **(** :ref:`int<class_int>` bus_idx **)** const
  168. If ``true`` the bus at index ``bus_idx`` is bypassing effects.
  169. .. _class_AudioServer_is_bus_effect_enabled:
  170. - :ref:`bool<class_bool>` **is_bus_effect_enabled** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** const
  171. If ``true`` the effect at index ``effect_idx`` on the bus at index ``bus_idx`` is enabled.
  172. .. _class_AudioServer_is_bus_mute:
  173. - :ref:`bool<class_bool>` **is_bus_mute** **(** :ref:`int<class_int>` bus_idx **)** const
  174. If ``true`` the bus at index ``bus_idx`` is muted.
  175. .. _class_AudioServer_is_bus_solo:
  176. - :ref:`bool<class_bool>` **is_bus_solo** **(** :ref:`int<class_int>` bus_idx **)** const
  177. If ``true`` the bus at index ``bus_idx`` is in solo mode.
  178. .. _class_AudioServer_lock:
  179. - void **lock** **(** **)**
  180. Locks the audio drivers mainloop. Remember to unlock it afterwards.
  181. .. _class_AudioServer_move_bus:
  182. - void **move_bus** **(** :ref:`int<class_int>` index, :ref:`int<class_int>` to_index **)**
  183. Moves the bus from index ``index`` to index ``to_index``.
  184. .. _class_AudioServer_remove_bus:
  185. - void **remove_bus** **(** :ref:`int<class_int>` index **)**
  186. Removes the bus at index ``index``.
  187. .. _class_AudioServer_remove_bus_effect:
  188. - void **remove_bus_effect** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)**
  189. Removes the effect at index ``effect_idx`` from the bus at index ``bus_idx``.
  190. .. _class_AudioServer_set_bus_bypass_effects:
  191. - void **set_bus_bypass_effects** **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)**
  192. If ``true`` the bus at index ``bus_idx`` is bypassing effects.
  193. .. _class_AudioServer_set_bus_count:
  194. - void **set_bus_count** **(** :ref:`int<class_int>` amount **)**
  195. Adds and removes busses to make the number of busses match ``amount``.
  196. .. _class_AudioServer_set_bus_effect_enabled:
  197. - void **set_bus_effect_enabled** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`bool<class_bool>` enabled **)**
  198. If ``true`` the effect at index ``effect_idx`` on the bus at index ``bus_idx`` is enabled.
  199. .. _class_AudioServer_set_bus_layout:
  200. - void **set_bus_layout** **(** :ref:`AudioBusLayout<class_AudioBusLayout>` bus_layout **)**
  201. Overwrites the currently used :ref:`AudioBusLayout<class_AudioBusLayout>`.
  202. .. _class_AudioServer_set_bus_mute:
  203. - void **set_bus_mute** **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)**
  204. If ``true`` the bus at index ``bus_idx`` is muted.
  205. .. _class_AudioServer_set_bus_name:
  206. - void **set_bus_name** **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_String>` name **)**
  207. Sets the name of the bus at index ``bus_idx`` to ``name``.
  208. .. _class_AudioServer_set_bus_send:
  209. - void **set_bus_send** **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_String>` send **)**
  210. Connects the output of the bus at ``bus_idx`` to the bus named ``send``.
  211. .. _class_AudioServer_set_bus_solo:
  212. - void **set_bus_solo** **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)**
  213. If ``true`` the bus at index ``bus_idx`` is in solo mode.
  214. .. _class_AudioServer_set_bus_volume_db:
  215. - void **set_bus_volume_db** **(** :ref:`int<class_int>` bus_idx, :ref:`float<class_float>` volume_db **)**
  216. Sets the volume of the bus at index ``bus_idx`` to ``volume_db``.
  217. .. _class_AudioServer_set_device:
  218. - void **set_device** **(** :ref:`String<class_String>` device **)**
  219. .. _class_AudioServer_swap_bus_effects:
  220. - void **swap_bus_effects** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`int<class_int>` by_effect_idx **)**
  221. Swaps the position of two effects in bus ``bus_idx``.
  222. .. _class_AudioServer_unlock:
  223. - void **unlock** **(** **)**
  224. Unlocks the audiodriver's main loop. After locking it always unlock it.