Etusivu Tutki Apua
Kirjaudu sisään
Godot
/
godot-docs
peilaus alkaen https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Tiedostot Ongelmat 0 Wiki
Haara: 2.1
Haarat Tagit
godot-docs
/
classes
/
class_sampleplayer.rst

class_sampleplayer.rst 41 KB
Pysyvä linkki Historia Raaka

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
    3. 

  3. 

  4. .. _class_SamplePlayer:
    5. 

  5. 

  6. SamplePlayer
    7. 

  7. ============
    8. 

  8. 

  9. **Inherits:** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
    10. 

  10. 

  11. **Category:** Core
    12. 

  12. 

  13. Brief Description
    14. 

  14. -----------------
    15. 

  15. 

  16. Sample Player node.
    17. 

  17. 

  18. Member Functions
    19. 

  19. ----------------
    20. 

  20. 

  21. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    22. 

  22. | :ref:`float<class_float>`                  | :ref:`get_chorus<class_SamplePlayer_get_chorus>`  **(** :ref:`int<class_int>` voice  **)** const                                                                                                                                   |
    23. 

  23. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    24. 

  24. | :ref:`float<class_float>`                  | :ref:`get_default_chorus<class_SamplePlayer_get_default_chorus>`  **(** **)** const                                                                                                                                                |
    25. 

  25. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    26. 

  26. | :ref:`float<class_float>`                  | :ref:`get_default_filter_cutoff<class_SamplePlayer_get_default_filter_cutoff>`  **(** **)** const                                                                                                                                  |
    27. 

  27. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    28. 

  28. | :ref:`float<class_float>`                  | :ref:`get_default_filter_gain<class_SamplePlayer_get_default_filter_gain>`  **(** **)** const                                                                                                                                      |
    29. 

  29. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    30. 

  30. | :ref:`float<class_float>`                  | :ref:`get_default_filter_resonance<class_SamplePlayer_get_default_filter_resonance>`  **(** **)** const                                                                                                                            |
    31. 

  31. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

  32. | :ref:`int<class_int>`                      | :ref:`get_default_filter_type<class_SamplePlayer_get_default_filter_type>`  **(** **)** const                                                                                                                                      |
    33. 

  33. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    34. 

  34. | :ref:`float<class_float>`                  | :ref:`get_default_pan<class_SamplePlayer_get_default_pan>`  **(** **)** const                                                                                                                                                      |
    35. 

  35. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

  36. | :ref:`float<class_float>`                  | :ref:`get_default_pan_depth<class_SamplePlayer_get_default_pan_depth>`  **(** **)** const                                                                                                                                          |
    37. 

  37. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

  38. | :ref:`float<class_float>`                  | :ref:`get_default_pan_height<class_SamplePlayer_get_default_pan_height>`  **(** **)** const                                                                                                                                        |
    39. 

  39. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

  40. | :ref:`float<class_float>`                  | :ref:`get_default_pitch_scale<class_SamplePlayer_get_default_pitch_scale>`  **(** **)** const                                                                                                                                      |
    41. 

  41. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | :ref:`float<class_float>`                  | :ref:`get_default_reverb<class_SamplePlayer_get_default_reverb>`  **(** **)** const                                                                                                                                                |
    43. 

  43. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. | :ref:`int<class_int>`                      | :ref:`get_default_reverb_room<class_SamplePlayer_get_default_reverb_room>`  **(** **)** const                                                                                                                                      |
    45. 

  45. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. | :ref:`float<class_float>`                  | :ref:`get_default_volume<class_SamplePlayer_get_default_volume>`  **(** **)** const                                                                                                                                                |
    47. 

  47. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48. | :ref:`float<class_float>`                  | :ref:`get_default_volume_db<class_SamplePlayer_get_default_volume_db>`  **(** **)** const                                                                                                                                          |
    49. 

  49. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    50. 

  50. | :ref:`float<class_float>`                  | :ref:`get_filter_cutoff<class_SamplePlayer_get_filter_cutoff>`  **(** :ref:`int<class_int>` voice  **)** const                                                                                                                     |
    51. 

  51. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    52. 

  52. | :ref:`float<class_float>`                  | :ref:`get_filter_gain<class_SamplePlayer_get_filter_gain>`  **(** :ref:`int<class_int>` voice  **)** const                                                                                                                         |
    53. 

  53. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    54. 

  54. | :ref:`float<class_float>`                  | :ref:`get_filter_resonance<class_SamplePlayer_get_filter_resonance>`  **(** :ref:`int<class_int>` voice  **)** const                                                                                                               |
    55. 

  55. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    56. 

  56. | :ref:`int<class_int>`                      | :ref:`get_filter_type<class_SamplePlayer_get_filter_type>`  **(** :ref:`int<class_int>` voice  **)** const                                                                                                                         |
    57. 

  57. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    58. 

  58. | :ref:`int<class_int>`                      | :ref:`get_mix_rate<class_SamplePlayer_get_mix_rate>`  **(** :ref:`int<class_int>` voice  **)** const                                                                                                                               |
    59. 

  59. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    60. 

  60. | :ref:`float<class_float>`                  | :ref:`get_pan<class_SamplePlayer_get_pan>`  **(** :ref:`int<class_int>` voice  **)** const                                                                                                                                         |
    61. 

  61. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    62. 

  62. | :ref:`float<class_float>`                  | :ref:`get_pan_depth<class_SamplePlayer_get_pan_depth>`  **(** :ref:`int<class_int>` voice  **)** const                                                                                                                             |
    63. 

  63. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    64. 

  64. | :ref:`float<class_float>`                  | :ref:`get_pan_height<class_SamplePlayer_get_pan_height>`  **(** :ref:`int<class_int>` voice  **)** const                                                                                                                           |
    65. 

  65. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    66. 

  66. | :ref:`float<class_float>`                  | :ref:`get_pitch_scale<class_SamplePlayer_get_pitch_scale>`  **(** :ref:`int<class_int>` voice  **)** const                                                                                                                         |
    67. 

  67. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    68. 

  68. | :ref:`int<class_int>`                      | :ref:`get_polyphony<class_SamplePlayer_get_polyphony>`  **(** **)** const                                                                                                                                                          |
    69. 

  69. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    70. 

  70. | :ref:`float<class_float>`                  | :ref:`get_reverb<class_SamplePlayer_get_reverb>`  **(** :ref:`int<class_int>` voice  **)** const                                                                                                                                   |
    71. 

  71. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    72. 

  72. | :ref:`int<class_int>`                      | :ref:`get_reverb_room<class_SamplePlayer_get_reverb_room>`  **(** :ref:`int<class_int>` voice  **)** const                                                                                                                         |
    73. 

  73. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    74. 

  74. | :ref:`SampleLibrary<class_samplelibrary>`  | :ref:`get_sample_library<class_SamplePlayer_get_sample_library>`  **(** **)** const                                                                                                                                                |
    75. 

  75. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    76. 

  76. | :ref:`float<class_float>`                  | :ref:`get_volume<class_SamplePlayer_get_volume>`  **(** :ref:`int<class_int>` voice  **)** const                                                                                                                                   |
    77. 

  77. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    78. 

  78. | :ref:`float<class_float>`                  | :ref:`get_volume_db<class_SamplePlayer_get_volume_db>`  **(** :ref:`int<class_int>` voice  **)** const                                                                                                                             |
    79. 

  79. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    80. 

  80. | :ref:`bool<class_bool>`                    | :ref:`is_active<class_SamplePlayer_is_active>`  **(** **)** const                                                                                                                                                                  |
    81. 

  81. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    82. 

  82. | :ref:`bool<class_bool>`                    | :ref:`is_voice_active<class_SamplePlayer_is_voice_active>`  **(** :ref:`int<class_int>` voice  **)** const                                                                                                                         |
    83. 

  83. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    84. 

  84. | :ref:`int<class_int>`                      | :ref:`play<class_SamplePlayer_play>`  **(** :ref:`String<class_string>` name, :ref:`bool<class_bool>` unique=false  **)**                                                                                                          |
    85. 

  85. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    86. 

  86. | void                                       | :ref:`set_chorus<class_SamplePlayer_set_chorus>`  **(** :ref:`int<class_int>` voice, :ref:`float<class_float>` send  **)**                                                                                                         |
    87. 

  87. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    88. 

  88. | void                                       | :ref:`set_default_chorus<class_SamplePlayer_set_default_chorus>`  **(** :ref:`float<class_float>` send  **)**                                                                                                                      |
    89. 

  89. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    90. 

  90. | void                                       | :ref:`set_default_filter<class_SamplePlayer_set_default_filter>`  **(** :ref:`int<class_int>` type, :ref:`float<class_float>` cutoff_hz, :ref:`float<class_float>` resonance, :ref:`float<class_float>` gain=0  **)**              |
    91. 

  91. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    92. 

  92. | void                                       | :ref:`set_default_pan<class_SamplePlayer_set_default_pan>`  **(** :ref:`float<class_float>` pan, :ref:`float<class_float>` depth=0, :ref:`float<class_float>` height=0  **)**                                                      |
    93. 

  93. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    94. 

  94. | void                                       | :ref:`set_default_pitch_scale<class_SamplePlayer_set_default_pitch_scale>`  **(** :ref:`float<class_float>` ratio  **)**                                                                                                           |
    95. 

  95. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    96. 

  96. | void                                       | :ref:`set_default_reverb<class_SamplePlayer_set_default_reverb>`  **(** :ref:`int<class_int>` room_type, :ref:`float<class_float>` send  **)**                                                                                     |
    97. 

  97. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    98. 

  98. | void                                       | :ref:`set_default_volume<class_SamplePlayer_set_default_volume>`  **(** :ref:`float<class_float>` volume  **)**                                                                                                                    |
    99. 

  99. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    100. 

  100. | void                                       | :ref:`set_default_volume_db<class_SamplePlayer_set_default_volume_db>`  **(** :ref:`float<class_float>` db  **)**                                                                                                                  |
    101. 

  101. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    102. 

  102. | void                                       | :ref:`set_filter<class_SamplePlayer_set_filter>`  **(** :ref:`int<class_int>` voice, :ref:`int<class_int>` type, :ref:`float<class_float>` cutoff_hz, :ref:`float<class_float>` resonance, :ref:`float<class_float>` gain=0  **)** |
    103. 

  103. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    104. 

  104. | void                                       | :ref:`set_mix_rate<class_SamplePlayer_set_mix_rate>`  **(** :ref:`int<class_int>` voice, :ref:`int<class_int>` hz  **)**                                                                                                           |
    105. 

  105. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    106. 

  106. | void                                       | :ref:`set_pan<class_SamplePlayer_set_pan>`  **(** :ref:`int<class_int>` voice, :ref:`float<class_float>` pan, :ref:`float<class_float>` depth=0, :ref:`float<class_float>` height=0  **)**                                         |
    107. 

  107. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    108. 

  108. | void                                       | :ref:`set_pitch_scale<class_SamplePlayer_set_pitch_scale>`  **(** :ref:`int<class_int>` voice, :ref:`float<class_float>` ratio  **)**                                                                                              |
    109. 

  109. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    110. 

  110. | void                                       | :ref:`set_polyphony<class_SamplePlayer_set_polyphony>`  **(** :ref:`int<class_int>` max_voices  **)**                                                                                                                              |
    111. 

  111. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    112. 

  112. | void                                       | :ref:`set_reverb<class_SamplePlayer_set_reverb>`  **(** :ref:`int<class_int>` voice, :ref:`int<class_int>` room_type, :ref:`float<class_float>` send  **)**                                                                        |
    113. 

  113. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    114. 

  114. | void                                       | :ref:`set_sample_library<class_SamplePlayer_set_sample_library>`  **(** :ref:`SampleLibrary<class_samplelibrary>` library  **)**                                                                                                   |
    115. 

  115. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    116. 

  116. | void                                       | :ref:`set_volume<class_SamplePlayer_set_volume>`  **(** :ref:`int<class_int>` voice, :ref:`float<class_float>` volume  **)**                                                                                                       |
    117. 

  117. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    118. 

  118. | void                                       | :ref:`set_volume_db<class_SamplePlayer_set_volume_db>`  **(** :ref:`int<class_int>` voice, :ref:`float<class_float>` db  **)**                                                                                                     |
    119. 

  119. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    120. 

  120. | void                                       | :ref:`stop<class_SamplePlayer_stop>`  **(** :ref:`int<class_int>` voice  **)**                                                                                                                                                     |
    121. 

  121. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    122. 

  122. | void                                       | :ref:`stop_all<class_SamplePlayer_stop_all>`  **(** **)**                                                                                                                                                                          |
    123. 

  123. +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    124. 

  124. 

  125. Numeric Constants
    126. 

  126. -----------------
    127. 

  127. 

  128. - **FILTER_NONE** = **0** --- Filter is disabled for voice.
    129. 

  129. - **FILTER_LOWPASS** = **1** --- Low-pass filter is used for voice.
    130. 

  130. - **FILTER_BANDPASS** = **2** --- Band-pass filter is used for voice.
    131. 

  131. - **FILTER_HIPASS** = **3** --- High-pass filter is used for voice.
    132. 

  132. - **FILTER_NOTCH** = **4** --- Notch (band reject) filter is used for voice.
    133. 

  133. - **FILTER_PEAK** = **5** --- Peak (exclusive band) filter is used for voice.
    134. 

  134. - **FILTER_BANDLIMIT** = **6** --- Band-limit filter is used for voice, in this case resonance is the high-pass cutoff. A band-limit filter has a different frequency response than a notch filter, but otherwise both are band-rejecting filters.
    135. 

  135. - **FILTER_LOW_SHELF** = **7** --- Low-shelf filter is used for voice.
    136. 

  136. - **FILTER_HIGH_SHELF** = **8** --- High-shelf filter is used for voice.
    137. 

  137. - **REVERB_SMALL** = **0** --- Small reverberation room (house room).
    138. 

  138. - **REVERB_MEDIUM** = **1** --- Medium reverberation room (street)
    139. 

  139. - **REVERB_LARGE** = **2** --- Large reverberation room (theatre)
    140. 

  140. - **REVERB_HALL** = **3** --- Huge reverberation room (cathedral, warehouse).
    141. 

  141. - **INVALID_VOICE_ID** = **-1** --- Value returned if the voice ID is invalid.
    142. 

  142. 

  143. Description
    144. 

  144. -----------
    145. 

  145. 

  146. SamplePlayer is a :ref:`Node<class_node>` meant for simple sample playback. A library of samples is loaded and played back "as is", without positioning or anything.
    147. 

  147. 

  148. Member Function Description
    149. 

  149. ---------------------------
    150. 

  150. 

  151. .. _class_SamplePlayer_get_chorus:
    152. 

  152. 

  153. - :ref:`float<class_float>`  **get_chorus**  **(** :ref:`int<class_int>` voice  **)** const
    154. 

  154. 

  155. Return the current chorus send level for a given voice.
    156. 

  156. 

  157. .. _class_SamplePlayer_get_default_chorus:
    158. 

  158. 

  159. - :ref:`float<class_float>`  **get_default_chorus**  **(** **)** const
    160. 

  160. 

  161. Return the default chorus send level of the player.
    162. 

  162. 

  163. .. _class_SamplePlayer_get_default_filter_cutoff:
    164. 

  164. 

  165. - :ref:`float<class_float>`  **get_default_filter_cutoff**  **(** **)** const
    166. 

  166. 

  167. Return the default filter cutoff frequency of the player.
    168. 

  168. 

  169. .. _class_SamplePlayer_get_default_filter_gain:
    170. 

  170. 

  171. - :ref:`float<class_float>`  **get_default_filter_gain**  **(** **)** const
    172. 

  172. 

  173. Return the default filter gain of the player.
    174. 

  174. 

  175. .. _class_SamplePlayer_get_default_filter_resonance:
    176. 

  176. 

  177. - :ref:`float<class_float>`  **get_default_filter_resonance**  **(** **)** const
    178. 

  178. 

  179. Return the default filter resonance of the player.
    180. 

  180. 

  181. .. _class_SamplePlayer_get_default_filter_type:
    182. 

  182. 

  183. - :ref:`int<class_int>`  **get_default_filter_type**  **(** **)** const
    184. 

  184. 

  185. Return the default filter type in use (see FILTER\_\* constants) for the player.
    186. 

  186. 

  187. .. _class_SamplePlayer_get_default_pan:
    188. 

  188. 

  189. - :ref:`float<class_float>`  **get_default_pan**  **(** **)** const
    190. 

  190. 

  191. Return the default panning of the player.
    192. 

  192. 

  193. .. _class_SamplePlayer_get_default_pan_depth:
    194. 

  194. 

  195. - :ref:`float<class_float>`  **get_default_pan_depth**  **(** **)** const
    196. 

  196. 

  197. Return the default pan depth of the player.
    198. 

  198. 

  199. .. _class_SamplePlayer_get_default_pan_height:
    200. 

  200. 

  201. - :ref:`float<class_float>`  **get_default_pan_height**  **(** **)** const
    202. 

  202. 

  203. Return the default pan height of the player.
    204. 

  204. 

  205. .. _class_SamplePlayer_get_default_pitch_scale:
    206. 

  206. 

  207. - :ref:`float<class_float>`  **get_default_pitch_scale**  **(** **)** const
    208. 

  208. 

  209. Return the default pitch scale of the player.
    210. 

  210. 

  211. .. _class_SamplePlayer_get_default_reverb:
    212. 

  212. 

  213. - :ref:`float<class_float>`  **get_default_reverb**  **(** **)** const
    214. 

  214. 

  215. Return the default reverberation send level of the player.
    216. 

  216. 

  217. .. _class_SamplePlayer_get_default_reverb_room:
    218. 

  218. 

  219. - :ref:`int<class_int>`  **get_default_reverb_room**  **(** **)** const
    220. 

  220. 

  221. Return the default reverberation room type of the player (see REVERB\_\* enum).
    222. 

  222. 

  223. .. _class_SamplePlayer_get_default_volume:
    224. 

  224. 

  225. - :ref:`float<class_float>`  **get_default_volume**  **(** **)** const
    226. 

  226. 

  227. Return the default volume (on a linear scale) of the player.
    228. 

  228. 

  229. .. _class_SamplePlayer_get_default_volume_db:
    230. 

  230. 

  231. - :ref:`float<class_float>`  **get_default_volume_db**  **(** **)** const
    232. 

  232. 

  233. Return the default volume (in dB) of the player.
    234. 

  234. 

  235. .. _class_SamplePlayer_get_filter_cutoff:
    236. 

  236. 

  237. - :ref:`float<class_float>`  **get_filter_cutoff**  **(** :ref:`int<class_int>` voice  **)** const
    238. 

  238. 

  239. Return the current filter cutoff frequency for a given voice.
    240. 

  240. 

  241. .. _class_SamplePlayer_get_filter_gain:
    242. 

  242. 

  243. - :ref:`float<class_float>`  **get_filter_gain**  **(** :ref:`int<class_int>` voice  **)** const
    244. 

  244. 

  245. Return the current filter gain for a given voice.
    246. 

  246. 

  247. .. _class_SamplePlayer_get_filter_resonance:
    248. 

  248. 

  249. - :ref:`float<class_float>`  **get_filter_resonance**  **(** :ref:`int<class_int>` voice  **)** const
    250. 

  250. 

  251. Return the current filter resonance for a given voice.
    252. 

  252. 

  253. .. _class_SamplePlayer_get_filter_type:
    254. 

  254. 

  255. - :ref:`int<class_int>`  **get_filter_type**  **(** :ref:`int<class_int>` voice  **)** const
    256. 

  256. 

  257. Return the current filter type in use (see FILTER\_\* constants) for a given voice.
    258. 

  258. 

  259. .. _class_SamplePlayer_get_mix_rate:
    260. 

  260. 

  261. - :ref:`int<class_int>`  **get_mix_rate**  **(** :ref:`int<class_int>` voice  **)** const
    262. 

  262. 

  263. Return the current mix rate for a given voice.
    264. 

  264. 

  265. .. _class_SamplePlayer_get_pan:
    266. 

  266. 

  267. - :ref:`float<class_float>`  **get_pan**  **(** :ref:`int<class_int>` voice  **)** const
    268. 

  268. 

  269. Return the current panning for a given voice.
    270. 

  270. 

  271. .. _class_SamplePlayer_get_pan_depth:
    272. 

  272. 

  273. - :ref:`float<class_float>`  **get_pan_depth**  **(** :ref:`int<class_int>` voice  **)** const
    274. 

  274. 

  275. Return the current pan depth for a given voice.
    276. 

  276. 

  277. .. _class_SamplePlayer_get_pan_height:
    278. 

  278. 

  279. - :ref:`float<class_float>`  **get_pan_height**  **(** :ref:`int<class_int>` voice  **)** const
    280. 

  280. 

  281. Return the current pan height for a given voice.
    282. 

  282. 

  283. .. _class_SamplePlayer_get_pitch_scale:
    284. 

  284. 

  285. - :ref:`float<class_float>`  **get_pitch_scale**  **(** :ref:`int<class_int>` voice  **)** const
    286. 

  286. 

  287. Return the current pitch scale for a given voice.
    288. 

  288. 

  289. .. _class_SamplePlayer_get_polyphony:
    290. 

  290. 

  291. - :ref:`int<class_int>`  **get_polyphony**  **(** **)** const
    292. 

  292. 

  293. Return the polyphony of the player.
    294. 

  294. 

  295. .. _class_SamplePlayer_get_reverb:
    296. 

  296. 

  297. - :ref:`float<class_float>`  **get_reverb**  **(** :ref:`int<class_int>` voice  **)** const
    298. 

  298. 

  299. Return the current reverberation send level for a given voice.
    300. 

  300. 

  301. .. _class_SamplePlayer_get_reverb_room:
    302. 

  302. 

  303. - :ref:`int<class_int>`  **get_reverb_room**  **(** :ref:`int<class_int>` voice  **)** const
    304. 

  304. 

  305. Return the current reverberation room type for a given voice (see REVERB\_\* enum).
    306. 

  306. 

  307. .. _class_SamplePlayer_get_sample_library:
    308. 

  308. 

  309. - :ref:`SampleLibrary<class_samplelibrary>`  **get_sample_library**  **(** **)** const
    310. 

  310. 

  311. Return the sample library used by the player.
    312. 

  312. 

  313. .. _class_SamplePlayer_get_volume:
    314. 

  314. 

  315. - :ref:`float<class_float>`  **get_volume**  **(** :ref:`int<class_int>` voice  **)** const
    316. 

  316. 

  317. Return the current volume (on a linear scale) for a given voice.
    318. 

  318. 

  319. .. _class_SamplePlayer_get_volume_db:
    320. 

  320. 

  321. - :ref:`float<class_float>`  **get_volume_db**  **(** :ref:`int<class_int>` voice  **)** const
    322. 

  322. 

  323. Return the current volume (in dB) for a given voice.
    324. 

  324. 

  325. .. _class_SamplePlayer_is_active:
    326. 

  326. 

  327. - :ref:`bool<class_bool>`  **is_active**  **(** **)** const
    328. 

  328. 

  329. Return whether the player is currently active.
    330. 

  330. 

  331. .. _class_SamplePlayer_is_voice_active:
    332. 

  332. 

  333. - :ref:`bool<class_bool>`  **is_voice_active**  **(** :ref:`int<class_int>` voice  **)** const
    334. 

  334. 

  335. Return whether the given voice is currently active.
    336. 

  336. 

  337. .. _class_SamplePlayer_play:
    338. 

  338. 

  339. - :ref:`int<class_int>`  **play**  **(** :ref:`String<class_string>` name, :ref:`bool<class_bool>` unique=false  **)**
    340. 

  340. 

  341. Play a sample referenced by its name.
    342. 

  342. 

  343. Optionally, the playback can be made "unique" to force stopping all other samples currently played. The voices allocated for playback will then be returned.
    344. 

  344. 

  345. .. _class_SamplePlayer_set_chorus:
    346. 

  346. 

  347. - void  **set_chorus**  **(** :ref:`int<class_int>` voice, :ref:`float<class_float>` send  **)**
    348. 

  348. 

  349. Set the chorus send level of a voice (from 0 to 1.0). For setting chorus parameters, see :ref:`AudioServer<class_audioserver>`.
    350. 

  350. 

  351. .. _class_SamplePlayer_set_default_chorus:
    352. 

  352. 

  353. - void  **set_default_chorus**  **(** :ref:`float<class_float>` send  **)**
    354. 

  354. 

  355. Set the default chorus send level of the player (from 0 to 1.0). For setting chorus parameters, see :ref:`AudioServer<class_audioserver>`.
    356. 

  356. 

  357. .. _class_SamplePlayer_set_default_filter:
    358. 

  358. 

  359. - void  **set_default_filter**  **(** :ref:`int<class_int>` type, :ref:`float<class_float>` cutoff_hz, :ref:`float<class_float>` resonance, :ref:`float<class_float>` gain=0  **)**
    360. 

  360. 

  361. Set the default filter for the player, using the given type (see FILTER\_\* constants), cutoff frequency (from 20 to 16,384 Hz) and resonance (from 0 to 4.0).
    362. 

  362. 

  363. Optionally, a gain can also be given (from 0 to 2.0).
    364. 

  364. 

  365. .. _class_SamplePlayer_set_default_pan:
    366. 

  366. 

  367. - void  **set_default_pan**  **(** :ref:`float<class_float>` pan, :ref:`float<class_float>` depth=0, :ref:`float<class_float>` height=0  **)**
    368. 

  368. 

  369. Set the default panning of the player. Panning goes from -1.0 (left) to +1.0 (right).
    370. 

  370. 

  371. Optionally, for hardware than support 3D sound, one can also set depth and height (also in range -1.0 to +1.0).
    372. 

  372. 

  373. .. _class_SamplePlayer_set_default_pitch_scale:
    374. 

  374. 

  375. - void  **set_default_pitch_scale**  **(** :ref:`float<class_float>` ratio  **)**
    376. 

  376. 

  377. Set the default pitch scale of the player. A ratio of 1.0 is the normal scale.
    378. 

  378. 

  379. .. _class_SamplePlayer_set_default_reverb:
    380. 

  380. 

  381. - void  **set_default_reverb**  **(** :ref:`int<class_int>` room_type, :ref:`float<class_float>` send  **)**
    382. 

  382. 

  383. Set the default reverberation type (see REVERB\_\* constants) and send level (from 0 to 1.0) of the player.
    384. 

  384. 

  385. .. _class_SamplePlayer_set_default_volume:
    386. 

  386. 

  387. - void  **set_default_volume**  **(** :ref:`float<class_float>` volume  **)**
    388. 

  388. 

  389. Set the default volume of the player using a linear scale.
    390. 

  390. 

  391. The "volume" argument should be a positive factor ranging from 0.0 (mute) up to 16.0 (i.e. 24 dB).
    392. 

  392. 

  393. A factor of 1.0 means that the voice will be played at normal system volume. Factors above 1.0 might be limited by the platform's audio output.
    394. 

  394. 

  395. .. _class_SamplePlayer_set_default_volume_db:
    396. 

  396. 

  397. - void  **set_default_volume_db**  **(** :ref:`float<class_float>` db  **)**
    398. 

  398. 

  399. Set the default volume of the player in dB.
    400. 

  400. 

  401. The "dB" argument can range from -80 to 24 dB, 0 dB being the maximum volume. Every 6 dB (resp. -6 dB), the volume is increased (resp. reduced) by half.
    402. 

  402. 

  403. .. _class_SamplePlayer_set_filter:
    404. 

  404. 

  405. - void  **set_filter**  **(** :ref:`int<class_int>` voice, :ref:`int<class_int>` type, :ref:`float<class_float>` cutoff_hz, :ref:`float<class_float>` resonance, :ref:`float<class_float>` gain=0  **)**
    406. 

  406. 

  407. Set the filter for a given voice, using the given type (see FILTER\_\* constants), cutoff frequency (from 20 to 16,384 Hz) and resonance (from 0 to 4.0).
    408. 

  408. 

  409. Optionally, a gain can also be given (from 0 to 2.0).
    410. 

  410. 

  411. .. _class_SamplePlayer_set_mix_rate:
    412. 

  412. 

  413. - void  **set_mix_rate**  **(** :ref:`int<class_int>` voice, :ref:`int<class_int>` hz  **)**
    414. 

  414. 

  415. Set the mix rate (in Hz) of a given voice.
    416. 

  416. 

  417. .. _class_SamplePlayer_set_pan:
    418. 

  418. 

  419. - void  **set_pan**  **(** :ref:`int<class_int>` voice, :ref:`float<class_float>` pan, :ref:`float<class_float>` depth=0, :ref:`float<class_float>` height=0  **)**
    420. 

  420. 

  421. Set the panning of a voice. Panning goes from -1.0 (left) to +1.0 (right).
    422. 

  422. 

  423. Optionally, for hardware than support 3D sound, one can also set depth and height (also in range -1.0 to +1.0).
    424. 

  424. 

  425. .. _class_SamplePlayer_set_pitch_scale:
    426. 

  426. 

  427. - void  **set_pitch_scale**  **(** :ref:`int<class_int>` voice, :ref:`float<class_float>` ratio  **)**
    428. 

  428. 

  429. Set the pitch scale of a given voice. A ratio of 1.0 is the normal scale.
    430. 

  430. 

  431. .. _class_SamplePlayer_set_polyphony:
    432. 

  432. 

  433. - void  **set_polyphony**  **(** :ref:`int<class_int>` max_voices  **)**
    434. 

  434. 

  435. Set the polyphony of the player (maximum amount of simultaneous voices).
    436. 

  436. 

  437. .. _class_SamplePlayer_set_reverb:
    438. 

  438. 

  439. - void  **set_reverb**  **(** :ref:`int<class_int>` voice, :ref:`int<class_int>` room_type, :ref:`float<class_float>` send  **)**
    440. 

  440. 

  441. Set the reverberation type (see REVERB\_\* constants) and send level (from 0 to 1.0) of a voice.
    442. 

  442. 

  443. .. _class_SamplePlayer_set_sample_library:
    444. 

  444. 

  445. - void  **set_sample_library**  **(** :ref:`SampleLibrary<class_samplelibrary>` library  **)**
    446. 

  446. 

  447. Set the sample library for the player.
    448. 

  448. 

  449. .. _class_SamplePlayer_set_volume:
    450. 

  450. 

  451. - void  **set_volume**  **(** :ref:`int<class_int>` voice, :ref:`float<class_float>` volume  **)**
    452. 

  452. 

  453. Set the volume of a given voice using a linear scale.
    454. 

  454. 

  455. The "volume" argument should be a positive factor ranging from 0.0 (mute) up to 16.0 (i.e. 24 dB).
    456. 

  456. 

  457. A factor of 1.0 means that the voice will be played at normal system volume. Factors above 1.0 might be limited by the platform's audio output.
    458. 

  458. 

  459. .. _class_SamplePlayer_set_volume_db:
    460. 

  460. 

  461. - void  **set_volume_db**  **(** :ref:`int<class_int>` voice, :ref:`float<class_float>` db  **)**
    462. 

  462. 

  463. Set the volume of a given voice in dB.
    464. 

  464. 

  465. The "dB" argument can range from -80 to 24 dB, 0 dB being the maximum volume. Every 6 dB (resp. -6 dB), the volume is increased (resp. reduced) by half.
    466. 

  466. 

  467. .. _class_SamplePlayer_stop:
    468. 

  468. 

  469. - void  **stop**  **(** :ref:`int<class_int>` voice  **)**
    470. 

  470. 

  471. Stop a given voice.
    472. 

  472. 

  473. .. _class_SamplePlayer_stop_all:
    474. 

  474. 

  475. - void  **stop_all**  **(** **)**
    476. 

  476. 

  477. Stop all playing voices.
    478. 

  478. 

  479.