class_audioeffectchorus.rst 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectChorus.xml.
  6. .. _class_AudioEffectChorus:
  7. AudioEffectChorus
  8. =================
  9. **Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  10. Adds a chorus audio effect.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. Adds a chorus audio effect. The effect applies a filter with voices to duplicate the audio source and manipulate it through the filter.
  15. .. rst-class:: classref-reftable-group
  16. Properties
  17. ----------
  18. .. table::
  19. :widths: auto
  20. +---------------------------+------------------------------------------------------------------------------+------------+
  21. | :ref:`float<class_float>` | :ref:`dry<class_AudioEffectChorus_property_dry>` | ``1.0`` |
  22. +---------------------------+------------------------------------------------------------------------------+------------+
  23. | :ref:`float<class_float>` | :ref:`voice/1/cutoff_hz<class_AudioEffectChorus_property_voice/1/cutoff_hz>` | ``8000.0`` |
  24. +---------------------------+------------------------------------------------------------------------------+------------+
  25. | :ref:`float<class_float>` | :ref:`voice/1/delay_ms<class_AudioEffectChorus_property_voice/1/delay_ms>` | ``15.0`` |
  26. +---------------------------+------------------------------------------------------------------------------+------------+
  27. | :ref:`float<class_float>` | :ref:`voice/1/depth_ms<class_AudioEffectChorus_property_voice/1/depth_ms>` | ``2.0`` |
  28. +---------------------------+------------------------------------------------------------------------------+------------+
  29. | :ref:`float<class_float>` | :ref:`voice/1/level_db<class_AudioEffectChorus_property_voice/1/level_db>` | ``0.0`` |
  30. +---------------------------+------------------------------------------------------------------------------+------------+
  31. | :ref:`float<class_float>` | :ref:`voice/1/pan<class_AudioEffectChorus_property_voice/1/pan>` | ``-0.5`` |
  32. +---------------------------+------------------------------------------------------------------------------+------------+
  33. | :ref:`float<class_float>` | :ref:`voice/1/rate_hz<class_AudioEffectChorus_property_voice/1/rate_hz>` | ``0.8`` |
  34. +---------------------------+------------------------------------------------------------------------------+------------+
  35. | :ref:`float<class_float>` | :ref:`voice/2/cutoff_hz<class_AudioEffectChorus_property_voice/2/cutoff_hz>` | ``8000.0`` |
  36. +---------------------------+------------------------------------------------------------------------------+------------+
  37. | :ref:`float<class_float>` | :ref:`voice/2/delay_ms<class_AudioEffectChorus_property_voice/2/delay_ms>` | ``20.0`` |
  38. +---------------------------+------------------------------------------------------------------------------+------------+
  39. | :ref:`float<class_float>` | :ref:`voice/2/depth_ms<class_AudioEffectChorus_property_voice/2/depth_ms>` | ``3.0`` |
  40. +---------------------------+------------------------------------------------------------------------------+------------+
  41. | :ref:`float<class_float>` | :ref:`voice/2/level_db<class_AudioEffectChorus_property_voice/2/level_db>` | ``0.0`` |
  42. +---------------------------+------------------------------------------------------------------------------+------------+
  43. | :ref:`float<class_float>` | :ref:`voice/2/pan<class_AudioEffectChorus_property_voice/2/pan>` | ``0.5`` |
  44. +---------------------------+------------------------------------------------------------------------------+------------+
  45. | :ref:`float<class_float>` | :ref:`voice/2/rate_hz<class_AudioEffectChorus_property_voice/2/rate_hz>` | ``1.2`` |
  46. +---------------------------+------------------------------------------------------------------------------+------------+
  47. | :ref:`float<class_float>` | :ref:`voice/3/cutoff_hz<class_AudioEffectChorus_property_voice/3/cutoff_hz>` | |
  48. +---------------------------+------------------------------------------------------------------------------+------------+
  49. | :ref:`float<class_float>` | :ref:`voice/3/delay_ms<class_AudioEffectChorus_property_voice/3/delay_ms>` | |
  50. +---------------------------+------------------------------------------------------------------------------+------------+
  51. | :ref:`float<class_float>` | :ref:`voice/3/depth_ms<class_AudioEffectChorus_property_voice/3/depth_ms>` | |
  52. +---------------------------+------------------------------------------------------------------------------+------------+
  53. | :ref:`float<class_float>` | :ref:`voice/3/level_db<class_AudioEffectChorus_property_voice/3/level_db>` | |
  54. +---------------------------+------------------------------------------------------------------------------+------------+
  55. | :ref:`float<class_float>` | :ref:`voice/3/pan<class_AudioEffectChorus_property_voice/3/pan>` | |
  56. +---------------------------+------------------------------------------------------------------------------+------------+
  57. | :ref:`float<class_float>` | :ref:`voice/3/rate_hz<class_AudioEffectChorus_property_voice/3/rate_hz>` | |
  58. +---------------------------+------------------------------------------------------------------------------+------------+
  59. | :ref:`float<class_float>` | :ref:`voice/4/cutoff_hz<class_AudioEffectChorus_property_voice/4/cutoff_hz>` | |
  60. +---------------------------+------------------------------------------------------------------------------+------------+
  61. | :ref:`float<class_float>` | :ref:`voice/4/delay_ms<class_AudioEffectChorus_property_voice/4/delay_ms>` | |
  62. +---------------------------+------------------------------------------------------------------------------+------------+
  63. | :ref:`float<class_float>` | :ref:`voice/4/depth_ms<class_AudioEffectChorus_property_voice/4/depth_ms>` | |
  64. +---------------------------+------------------------------------------------------------------------------+------------+
  65. | :ref:`float<class_float>` | :ref:`voice/4/level_db<class_AudioEffectChorus_property_voice/4/level_db>` | |
  66. +---------------------------+------------------------------------------------------------------------------+------------+
  67. | :ref:`float<class_float>` | :ref:`voice/4/pan<class_AudioEffectChorus_property_voice/4/pan>` | |
  68. +---------------------------+------------------------------------------------------------------------------+------------+
  69. | :ref:`float<class_float>` | :ref:`voice/4/rate_hz<class_AudioEffectChorus_property_voice/4/rate_hz>` | |
  70. +---------------------------+------------------------------------------------------------------------------+------------+
  71. | :ref:`int<class_int>` | :ref:`voice_count<class_AudioEffectChorus_property_voice_count>` | ``2`` |
  72. +---------------------------+------------------------------------------------------------------------------+------------+
  73. | :ref:`float<class_float>` | :ref:`wet<class_AudioEffectChorus_property_wet>` | ``0.5`` |
  74. +---------------------------+------------------------------------------------------------------------------+------------+
  75. .. rst-class:: classref-reftable-group
  76. Methods
  77. -------
  78. .. table::
  79. :widths: auto
  80. +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | :ref:`float<class_float>` | :ref:`get_voice_cutoff_hz<class_AudioEffectChorus_method_get_voice_cutoff_hz>` **(** :ref:`int<class_int>` voice_idx **)** |const| |
  82. +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | :ref:`float<class_float>` | :ref:`get_voice_delay_ms<class_AudioEffectChorus_method_get_voice_delay_ms>` **(** :ref:`int<class_int>` voice_idx **)** |const| |
  84. +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | :ref:`float<class_float>` | :ref:`get_voice_depth_ms<class_AudioEffectChorus_method_get_voice_depth_ms>` **(** :ref:`int<class_int>` voice_idx **)** |const| |
  86. +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | :ref:`float<class_float>` | :ref:`get_voice_level_db<class_AudioEffectChorus_method_get_voice_level_db>` **(** :ref:`int<class_int>` voice_idx **)** |const| |
  88. +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | :ref:`float<class_float>` | :ref:`get_voice_pan<class_AudioEffectChorus_method_get_voice_pan>` **(** :ref:`int<class_int>` voice_idx **)** |const| |
  90. +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | :ref:`float<class_float>` | :ref:`get_voice_rate_hz<class_AudioEffectChorus_method_get_voice_rate_hz>` **(** :ref:`int<class_int>` voice_idx **)** |const| |
  92. +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | void | :ref:`set_voice_cutoff_hz<class_AudioEffectChorus_method_set_voice_cutoff_hz>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` cutoff_hz **)** |
  94. +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | void | :ref:`set_voice_delay_ms<class_AudioEffectChorus_method_set_voice_delay_ms>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` delay_ms **)** |
  96. +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | void | :ref:`set_voice_depth_ms<class_AudioEffectChorus_method_set_voice_depth_ms>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` depth_ms **)** |
  98. +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | void | :ref:`set_voice_level_db<class_AudioEffectChorus_method_set_voice_level_db>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` level_db **)** |
  100. +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | void | :ref:`set_voice_pan<class_AudioEffectChorus_method_set_voice_pan>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` pan **)** |
  102. +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | void | :ref:`set_voice_rate_hz<class_AudioEffectChorus_method_set_voice_rate_hz>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` rate_hz **)** |
  104. +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. .. rst-class:: classref-section-separator
  106. ----
  107. .. rst-class:: classref-descriptions-group
  108. Property Descriptions
  109. ---------------------
  110. .. _class_AudioEffectChorus_property_dry:
  111. .. rst-class:: classref-property
  112. :ref:`float<class_float>` **dry** = ``1.0``
  113. .. rst-class:: classref-property-setget
  114. - void **set_dry** **(** :ref:`float<class_float>` value **)**
  115. - :ref:`float<class_float>` **get_dry** **(** **)**
  116. The effect's raw signal.
  117. .. rst-class:: classref-item-separator
  118. ----
  119. .. _class_AudioEffectChorus_property_voice/1/cutoff_hz:
  120. .. rst-class:: classref-property
  121. :ref:`float<class_float>` **voice/1/cutoff_hz** = ``8000.0``
  122. .. rst-class:: classref-property-setget
  123. - void **set_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` cutoff_hz **)**
  124. - :ref:`float<class_float>` **get_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx **)** |const|
  125. The voice's cutoff frequency.
  126. .. rst-class:: classref-item-separator
  127. ----
  128. .. _class_AudioEffectChorus_property_voice/1/delay_ms:
  129. .. rst-class:: classref-property
  130. :ref:`float<class_float>` **voice/1/delay_ms** = ``15.0``
  131. .. rst-class:: classref-property-setget
  132. - void **set_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` delay_ms **)**
  133. - :ref:`float<class_float>` **get_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx **)** |const|
  134. The voice's signal delay.
  135. .. rst-class:: classref-item-separator
  136. ----
  137. .. _class_AudioEffectChorus_property_voice/1/depth_ms:
  138. .. rst-class:: classref-property
  139. :ref:`float<class_float>` **voice/1/depth_ms** = ``2.0``
  140. .. rst-class:: classref-property-setget
  141. - void **set_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` depth_ms **)**
  142. - :ref:`float<class_float>` **get_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx **)** |const|
  143. The voice filter's depth.
  144. .. rst-class:: classref-item-separator
  145. ----
  146. .. _class_AudioEffectChorus_property_voice/1/level_db:
  147. .. rst-class:: classref-property
  148. :ref:`float<class_float>` **voice/1/level_db** = ``0.0``
  149. .. rst-class:: classref-property-setget
  150. - void **set_voice_level_db** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` level_db **)**
  151. - :ref:`float<class_float>` **get_voice_level_db** **(** :ref:`int<class_int>` voice_idx **)** |const|
  152. The voice's volume.
  153. .. rst-class:: classref-item-separator
  154. ----
  155. .. _class_AudioEffectChorus_property_voice/1/pan:
  156. .. rst-class:: classref-property
  157. :ref:`float<class_float>` **voice/1/pan** = ``-0.5``
  158. .. rst-class:: classref-property-setget
  159. - void **set_voice_pan** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` pan **)**
  160. - :ref:`float<class_float>` **get_voice_pan** **(** :ref:`int<class_int>` voice_idx **)** |const|
  161. The voice's pan level.
  162. .. rst-class:: classref-item-separator
  163. ----
  164. .. _class_AudioEffectChorus_property_voice/1/rate_hz:
  165. .. rst-class:: classref-property
  166. :ref:`float<class_float>` **voice/1/rate_hz** = ``0.8``
  167. .. rst-class:: classref-property-setget
  168. - void **set_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` rate_hz **)**
  169. - :ref:`float<class_float>` **get_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx **)** |const|
  170. The voice's filter rate.
  171. .. rst-class:: classref-item-separator
  172. ----
  173. .. _class_AudioEffectChorus_property_voice/2/cutoff_hz:
  174. .. rst-class:: classref-property
  175. :ref:`float<class_float>` **voice/2/cutoff_hz** = ``8000.0``
  176. .. rst-class:: classref-property-setget
  177. - void **set_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` cutoff_hz **)**
  178. - :ref:`float<class_float>` **get_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx **)** |const|
  179. The voice's cutoff frequency.
  180. .. rst-class:: classref-item-separator
  181. ----
  182. .. _class_AudioEffectChorus_property_voice/2/delay_ms:
  183. .. rst-class:: classref-property
  184. :ref:`float<class_float>` **voice/2/delay_ms** = ``20.0``
  185. .. rst-class:: classref-property-setget
  186. - void **set_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` delay_ms **)**
  187. - :ref:`float<class_float>` **get_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx **)** |const|
  188. The voice's signal delay.
  189. .. rst-class:: classref-item-separator
  190. ----
  191. .. _class_AudioEffectChorus_property_voice/2/depth_ms:
  192. .. rst-class:: classref-property
  193. :ref:`float<class_float>` **voice/2/depth_ms** = ``3.0``
  194. .. rst-class:: classref-property-setget
  195. - void **set_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` depth_ms **)**
  196. - :ref:`float<class_float>` **get_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx **)** |const|
  197. The voice filter's depth.
  198. .. rst-class:: classref-item-separator
  199. ----
  200. .. _class_AudioEffectChorus_property_voice/2/level_db:
  201. .. rst-class:: classref-property
  202. :ref:`float<class_float>` **voice/2/level_db** = ``0.0``
  203. .. rst-class:: classref-property-setget
  204. - void **set_voice_level_db** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` level_db **)**
  205. - :ref:`float<class_float>` **get_voice_level_db** **(** :ref:`int<class_int>` voice_idx **)** |const|
  206. The voice's volume.
  207. .. rst-class:: classref-item-separator
  208. ----
  209. .. _class_AudioEffectChorus_property_voice/2/pan:
  210. .. rst-class:: classref-property
  211. :ref:`float<class_float>` **voice/2/pan** = ``0.5``
  212. .. rst-class:: classref-property-setget
  213. - void **set_voice_pan** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` pan **)**
  214. - :ref:`float<class_float>` **get_voice_pan** **(** :ref:`int<class_int>` voice_idx **)** |const|
  215. The voice's pan level.
  216. .. rst-class:: classref-item-separator
  217. ----
  218. .. _class_AudioEffectChorus_property_voice/2/rate_hz:
  219. .. rst-class:: classref-property
  220. :ref:`float<class_float>` **voice/2/rate_hz** = ``1.2``
  221. .. rst-class:: classref-property-setget
  222. - void **set_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` rate_hz **)**
  223. - :ref:`float<class_float>` **get_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx **)** |const|
  224. The voice's filter rate.
  225. .. rst-class:: classref-item-separator
  226. ----
  227. .. _class_AudioEffectChorus_property_voice/3/cutoff_hz:
  228. .. rst-class:: classref-property
  229. :ref:`float<class_float>` **voice/3/cutoff_hz**
  230. .. rst-class:: classref-property-setget
  231. - void **set_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` cutoff_hz **)**
  232. - :ref:`float<class_float>` **get_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx **)** |const|
  233. The voice's cutoff frequency.
  234. .. rst-class:: classref-item-separator
  235. ----
  236. .. _class_AudioEffectChorus_property_voice/3/delay_ms:
  237. .. rst-class:: classref-property
  238. :ref:`float<class_float>` **voice/3/delay_ms**
  239. .. rst-class:: classref-property-setget
  240. - void **set_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` delay_ms **)**
  241. - :ref:`float<class_float>` **get_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx **)** |const|
  242. The voice's signal delay.
  243. .. rst-class:: classref-item-separator
  244. ----
  245. .. _class_AudioEffectChorus_property_voice/3/depth_ms:
  246. .. rst-class:: classref-property
  247. :ref:`float<class_float>` **voice/3/depth_ms**
  248. .. rst-class:: classref-property-setget
  249. - void **set_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` depth_ms **)**
  250. - :ref:`float<class_float>` **get_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx **)** |const|
  251. The voice filter's depth.
  252. .. rst-class:: classref-item-separator
  253. ----
  254. .. _class_AudioEffectChorus_property_voice/3/level_db:
  255. .. rst-class:: classref-property
  256. :ref:`float<class_float>` **voice/3/level_db**
  257. .. rst-class:: classref-property-setget
  258. - void **set_voice_level_db** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` level_db **)**
  259. - :ref:`float<class_float>` **get_voice_level_db** **(** :ref:`int<class_int>` voice_idx **)** |const|
  260. The voice's volume.
  261. .. rst-class:: classref-item-separator
  262. ----
  263. .. _class_AudioEffectChorus_property_voice/3/pan:
  264. .. rst-class:: classref-property
  265. :ref:`float<class_float>` **voice/3/pan**
  266. .. rst-class:: classref-property-setget
  267. - void **set_voice_pan** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` pan **)**
  268. - :ref:`float<class_float>` **get_voice_pan** **(** :ref:`int<class_int>` voice_idx **)** |const|
  269. The voice's pan level.
  270. .. rst-class:: classref-item-separator
  271. ----
  272. .. _class_AudioEffectChorus_property_voice/3/rate_hz:
  273. .. rst-class:: classref-property
  274. :ref:`float<class_float>` **voice/3/rate_hz**
  275. .. rst-class:: classref-property-setget
  276. - void **set_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` rate_hz **)**
  277. - :ref:`float<class_float>` **get_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx **)** |const|
  278. The voice's filter rate.
  279. .. rst-class:: classref-item-separator
  280. ----
  281. .. _class_AudioEffectChorus_property_voice/4/cutoff_hz:
  282. .. rst-class:: classref-property
  283. :ref:`float<class_float>` **voice/4/cutoff_hz**
  284. .. rst-class:: classref-property-setget
  285. - void **set_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` cutoff_hz **)**
  286. - :ref:`float<class_float>` **get_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx **)** |const|
  287. The voice's cutoff frequency.
  288. .. rst-class:: classref-item-separator
  289. ----
  290. .. _class_AudioEffectChorus_property_voice/4/delay_ms:
  291. .. rst-class:: classref-property
  292. :ref:`float<class_float>` **voice/4/delay_ms**
  293. .. rst-class:: classref-property-setget
  294. - void **set_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` delay_ms **)**
  295. - :ref:`float<class_float>` **get_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx **)** |const|
  296. The voice's signal delay.
  297. .. rst-class:: classref-item-separator
  298. ----
  299. .. _class_AudioEffectChorus_property_voice/4/depth_ms:
  300. .. rst-class:: classref-property
  301. :ref:`float<class_float>` **voice/4/depth_ms**
  302. .. rst-class:: classref-property-setget
  303. - void **set_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` depth_ms **)**
  304. - :ref:`float<class_float>` **get_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx **)** |const|
  305. The voice filter's depth.
  306. .. rst-class:: classref-item-separator
  307. ----
  308. .. _class_AudioEffectChorus_property_voice/4/level_db:
  309. .. rst-class:: classref-property
  310. :ref:`float<class_float>` **voice/4/level_db**
  311. .. rst-class:: classref-property-setget
  312. - void **set_voice_level_db** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` level_db **)**
  313. - :ref:`float<class_float>` **get_voice_level_db** **(** :ref:`int<class_int>` voice_idx **)** |const|
  314. The voice's volume.
  315. .. rst-class:: classref-item-separator
  316. ----
  317. .. _class_AudioEffectChorus_property_voice/4/pan:
  318. .. rst-class:: classref-property
  319. :ref:`float<class_float>` **voice/4/pan**
  320. .. rst-class:: classref-property-setget
  321. - void **set_voice_pan** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` pan **)**
  322. - :ref:`float<class_float>` **get_voice_pan** **(** :ref:`int<class_int>` voice_idx **)** |const|
  323. The voice's pan level.
  324. .. rst-class:: classref-item-separator
  325. ----
  326. .. _class_AudioEffectChorus_property_voice/4/rate_hz:
  327. .. rst-class:: classref-property
  328. :ref:`float<class_float>` **voice/4/rate_hz**
  329. .. rst-class:: classref-property-setget
  330. - void **set_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` rate_hz **)**
  331. - :ref:`float<class_float>` **get_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx **)** |const|
  332. The voice's filter rate.
  333. .. rst-class:: classref-item-separator
  334. ----
  335. .. _class_AudioEffectChorus_property_voice_count:
  336. .. rst-class:: classref-property
  337. :ref:`int<class_int>` **voice_count** = ``2``
  338. .. rst-class:: classref-property-setget
  339. - void **set_voice_count** **(** :ref:`int<class_int>` value **)**
  340. - :ref:`int<class_int>` **get_voice_count** **(** **)**
  341. The amount of voices in the effect.
  342. .. rst-class:: classref-item-separator
  343. ----
  344. .. _class_AudioEffectChorus_property_wet:
  345. .. rst-class:: classref-property
  346. :ref:`float<class_float>` **wet** = ``0.5``
  347. .. rst-class:: classref-property-setget
  348. - void **set_wet** **(** :ref:`float<class_float>` value **)**
  349. - :ref:`float<class_float>` **get_wet** **(** **)**
  350. The effect's processed signal.
  351. .. rst-class:: classref-section-separator
  352. ----
  353. .. rst-class:: classref-descriptions-group
  354. Method Descriptions
  355. -------------------
  356. .. _class_AudioEffectChorus_method_get_voice_cutoff_hz:
  357. .. rst-class:: classref-method
  358. :ref:`float<class_float>` **get_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx **)** |const|
  359. .. container:: contribute
  360. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  361. .. rst-class:: classref-item-separator
  362. ----
  363. .. _class_AudioEffectChorus_method_get_voice_delay_ms:
  364. .. rst-class:: classref-method
  365. :ref:`float<class_float>` **get_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx **)** |const|
  366. .. container:: contribute
  367. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  368. .. rst-class:: classref-item-separator
  369. ----
  370. .. _class_AudioEffectChorus_method_get_voice_depth_ms:
  371. .. rst-class:: classref-method
  372. :ref:`float<class_float>` **get_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx **)** |const|
  373. .. container:: contribute
  374. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  375. .. rst-class:: classref-item-separator
  376. ----
  377. .. _class_AudioEffectChorus_method_get_voice_level_db:
  378. .. rst-class:: classref-method
  379. :ref:`float<class_float>` **get_voice_level_db** **(** :ref:`int<class_int>` voice_idx **)** |const|
  380. .. container:: contribute
  381. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  382. .. rst-class:: classref-item-separator
  383. ----
  384. .. _class_AudioEffectChorus_method_get_voice_pan:
  385. .. rst-class:: classref-method
  386. :ref:`float<class_float>` **get_voice_pan** **(** :ref:`int<class_int>` voice_idx **)** |const|
  387. .. container:: contribute
  388. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  389. .. rst-class:: classref-item-separator
  390. ----
  391. .. _class_AudioEffectChorus_method_get_voice_rate_hz:
  392. .. rst-class:: classref-method
  393. :ref:`float<class_float>` **get_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx **)** |const|
  394. .. container:: contribute
  395. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  396. .. rst-class:: classref-item-separator
  397. ----
  398. .. _class_AudioEffectChorus_method_set_voice_cutoff_hz:
  399. .. rst-class:: classref-method
  400. void **set_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` cutoff_hz **)**
  401. .. container:: contribute
  402. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  403. .. rst-class:: classref-item-separator
  404. ----
  405. .. _class_AudioEffectChorus_method_set_voice_delay_ms:
  406. .. rst-class:: classref-method
  407. void **set_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` delay_ms **)**
  408. .. container:: contribute
  409. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  410. .. rst-class:: classref-item-separator
  411. ----
  412. .. _class_AudioEffectChorus_method_set_voice_depth_ms:
  413. .. rst-class:: classref-method
  414. void **set_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` depth_ms **)**
  415. .. container:: contribute
  416. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  417. .. rst-class:: classref-item-separator
  418. ----
  419. .. _class_AudioEffectChorus_method_set_voice_level_db:
  420. .. rst-class:: classref-method
  421. void **set_voice_level_db** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` level_db **)**
  422. .. container:: contribute
  423. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  424. .. rst-class:: classref-item-separator
  425. ----
  426. .. _class_AudioEffectChorus_method_set_voice_pan:
  427. .. rst-class:: classref-method
  428. void **set_voice_pan** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` pan **)**
  429. .. container:: contribute
  430. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  431. .. rst-class:: classref-item-separator
  432. ----
  433. .. _class_AudioEffectChorus_method_set_voice_rate_hz:
  434. .. rst-class:: classref-method
  435. void **set_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` rate_hz **)**
  436. .. container:: contribute
  437. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  438. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  439. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  440. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  441. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`