Startseite Erkunden Hilfe
Registrieren Anmelden
samien
/
three.js
Mirror von https://github.com/mrdoob/three.js.git
1
0
Fork 0
Dateien Issues 0 Wiki
Struktur: 374b07c0cf
Branches Tags
three.js
/
docs
/
pages
/
Audio.html

Audio.html 27 KB
Verlauf Originalformat

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605 
  1. <!DOCTYPE html>
    2. 

  2. <html lang="en">
    3. 

  3. <head>
    4. 

  4. 	<meta charset="utf-8">
    5. 

  5. 	<title>Audio - Three.js Docs</title>
    6. 

  6. 	<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
    7. 

  7. 	<script src="../scripts/highlight.min.js"></script>
    8. 

  8. 	<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
    9. 

  9. 	<link type="text/css" rel="stylesheet" href="../styles/page.css">
    10. 

  10. </head>
    11. 

  11. <body>
    12. 

  12. 		<p class="inheritance" translate="no"><a href="EventDispatcher.html">EventDispatcher</a> → <a href="Object3D.html">Object3D</a> → </p>
    13. 

  13. 	<h1 translate="no">Audio</h1>
    14. 

  14. 		<section>
    15. 

  15. 			<header>
    16. 

  16. 				<div class="class-description"><p>Represents a non-positional ( global ) audio object.</p>
    17. 

  17. <p>This and related audio modules make use of the <a href="https://www.w3.org/TR/webaudio-1.1/" target="_blank" rel="noopener">Web Audio API</a>.</p></div>
    18. 

  18. 				<h2>Code Example</h2>
    19. 

  19. 				<div translate="no"><pre><code class="language-js">// create an AudioListener and add it to the camera
    20. 

  20. const listener = new THREE.AudioListener();
    21. 

  21. camera.add( listener );
    22. 

  22. // create a global audio source
    23. 

  23. const sound = new THREE.Audio( listener );
    24. 

  24. // load a sound and set it as the Audio object's buffer
    25. 

  25. const audioLoader = new THREE.AudioLoader();
    26. 

  26. audioLoader.load( 'sounds/ambient.ogg', function( buffer ) {
    27. 

  27. 	sound.setBuffer( buffer );
    28. 

  28. 	sound.setLoop( true );
    29. 

  29. 	sound.setVolume( 0.5 );
    30. 

  30. 	sound.play();
    31. 

  31. });
    32. 

  32. </code></pre></div>
    33. 

  33. 			</header>
    34. 

  34. 			<article>
    35. 

  35. 				<div class="container-overview">
    36. 

  36. 					<h2>Constructor</h2>
    37. 

  37. 					<h3 class="name name-method" id="Audio" translate="no">new <a href="#Audio">Audio</a><span class="signature">( listener : <span class="param-type"><a href="AudioListener.html">AudioListener</a></span> )</span> </h3>
    38. 

  38. 					<div class="method">
    39. 

  39. 						<div class="description">
    40. 

  40. 							<p>Constructs a new audio.</p>
    41. 

  41. 						</div>
    42. 

  42. 						<table class="params">
    43. 

  43. 							<tbody>
    44. 

  44. 								<tr>
    45. 

  45. 									<td class="name">
    46. 

  46. 										<strong>listener</strong>
    47. 

  47. 									</td>
    48. 

  48. 									<td class="description last">
    49. 

  49. 										<p>The global audio listener.</p>
    50. 

  50. 									</td>
    51. 

  51. 								</tr>
    52. 

  52. 							</tbody>
    53. 

  53. 						</table>
    54. 

  54. 					</div>
    55. 

  55. 				</div>
    56. 

  56. 				<h2 class="subsection-title">Properties</h2>
    57. 

  57. 				<div class="member">
    58. 

  58. 					<h3 class="name" id="autoplay" translate="no">.<a href="#autoplay">autoplay</a><span class="type-signature"> : boolean</span> </h3>
    59. 

  59. 					<div class="description">
    60. 

  60. 						<p>Whether to start playback automatically or not.</p>
    61. 

  61. 						<p>Default is <code>false</code>.</p>
    62. 

  62. 					</div>
    63. 

  63. 				</div>
    64. 

  64. 				<div class="member">
    65. 

  65. 					<h3 class="name" id="buffer" translate="no">.<a href="#buffer">buffer</a><span class="type-signature"> : AudioBuffer</span> <span class="type-signature">(readonly) </span></h3>
    66. 

  66. 					<div class="description">
    67. 

  67. 						<p>A reference to an audio buffer.</p>
    68. 

  68. <p>Defined via <a href="Audio.html#setBuffer">Audio#setBuffer</a>.</p>
    69. 

  69. 						<p>Default is <code>null</code>.</p>
    70. 

  70. 					</div>
    71. 

  71. 				</div>
    72. 

  72. 				<div class="member">
    73. 

  73. 					<h3 class="name" id="context" translate="no">.<a href="#context">context</a><span class="type-signature"> : <a href="AudioContext.html">AudioContext</a></span> <span class="type-signature">(readonly) </span></h3>
    74. 

  74. 					<div class="description">
    75. 

  75. 						<p>The audio context.</p>
    76. 

  76. 					</div>
    77. 

  77. 				</div>
    78. 

  78. 				<div class="member">
    79. 

  79. 					<h3 class="name" id="detune" translate="no">.<a href="#detune">detune</a><span class="type-signature"> : number</span> <span class="type-signature">(readonly) </span></h3>
    80. 

  80. 					<div class="description">
    81. 

  81. 						<p>Modify pitch, measured in cents. +/- 100 is a semitone.
    82. 

  82. +/- 1200 is an octave.</p>
    83. 

  83. <p>Defined via <a href="Audio.html#setDetune">Audio#setDetune</a>.</p>
    84. 

  84. 						<p>Default is <code>0</code>.</p>
    85. 

  85. 					</div>
    86. 

  86. 				</div>
    87. 

  87. 				<div class="member">
    88. 

  88. 					<h3 class="name" id="duration" translate="no">.<a href="#duration">duration</a><span class="type-signature"> : undefined | number</span> </h3>
    89. 

  89. 					<div class="description">
    90. 

  90. 						<p>Overrides the default duration of the audio.</p>
    91. 

  91. 						<p>Default is <code>undefined</code>.</p>
    92. 

  92. 					</div>
    93. 

  93. 				</div>
    94. 

  94. 				<div class="member">
    95. 

  95. 					<h3 class="name" id="filters" translate="no">.<a href="#filters">filters</a><span class="type-signature"> : Array.&lt;AudioNode></span> <span class="type-signature">(readonly) </span></h3>
    96. 

  96. 					<div class="description">
    97. 

  97. 						<p>Can be used to apply a variety of low-order filters to create
    98. 

  98. more complex sound effects e.g. via <code>BiquadFilterNode</code>.</p>
    99. 

  99. <p>The property is automatically set by <a href="Audio.html#setFilters">Audio#setFilters</a>.</p>
    100. 

  100. 					</div>
    101. 

  101. 				</div>
    102. 

  102. 				<div class="member">
    103. 

  103. 					<h3 class="name" id="gain" translate="no">.<a href="#gain">gain</a><span class="type-signature"> : GainNode</span> <span class="type-signature">(readonly) </span></h3>
    104. 

  104. 					<div class="description">
    105. 

  105. 						<p>The gain node used for volume control.</p>
    106. 

  106. 					</div>
    107. 

  107. 				</div>
    108. 

  108. 				<div class="member">
    109. 

  109. 					<h3 class="name" id="hasPlaybackControl" translate="no">.<a href="#hasPlaybackControl">hasPlaybackControl</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
    110. 

  110. 					<div class="description">
    111. 

  111. 						<p>Indicates whether the audio playback can be controlled
    112. 

  112. with method like <a href="Audio.html#play">Audio#play</a> or <a href="Audio.html#pause">Audio#pause</a>.</p>
    113. 

  113. <p>This flag will be automatically set when audio sources are
    114. 

  114. defined.</p>
    115. 

  115. 						<p>Default is <code>true</code>.</p>
    116. 

  116. 					</div>
    117. 

  117. 				</div>
    118. 

  118. 				<div class="member">
    119. 

  119. 					<h3 class="name" id="isPlaying" translate="no">.<a href="#isPlaying">isPlaying</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
    120. 

  120. 					<div class="description">
    121. 

  121. 						<p>Indicates whether the audio is playing or not.</p>
    122. 

  122. <p>This flag will be automatically set when using <a href="Audio.html#play">Audio#play</a>,
    123. 

  123. <a href="Audio.html#pause">Audio#pause</a>, <a href="Audio.html#stop">Audio#stop</a>.</p>
    124. 

  124. 						<p>Default is <code>false</code>.</p>
    125. 

  125. 					</div>
    126. 

  126. 				</div>
    127. 

  127. 				<div class="member">
    128. 

  128. 					<h3 class="name" id="listener" translate="no">.<a href="#listener">listener</a><span class="type-signature"> : <a href="AudioListener.html">AudioListener</a></span> <span class="type-signature">(readonly) </span></h3>
    129. 

  129. 					<div class="description">
    130. 

  130. 						<p>The global audio listener.</p>
    131. 

  131. 					</div>
    132. 

  132. 				</div>
    133. 

  133. 				<div class="member">
    134. 

  134. 					<h3 class="name" id="loop" translate="no">.<a href="#loop">loop</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
    135. 

  135. 					<div class="description">
    136. 

  136. 						<p>Whether the audio should loop or not.</p>
    137. 

  137. <p>Defined via <a href="Audio.html#setLoop">Audio#setLoop</a>.</p>
    138. 

  138. 						<p>Default is <code>false</code>.</p>
    139. 

  139. 					</div>
    140. 

  140. 				</div>
    141. 

  141. 				<div class="member">
    142. 

  142. 					<h3 class="name" id="loopEnd" translate="no">.<a href="#loopEnd">loopEnd</a><span class="type-signature"> : number</span> </h3>
    143. 

  143. 					<div class="description">
    144. 

  144. 						<p>Defines where in the audio buffer the replay should
    145. 

  145. stop, in seconds.</p>
    146. 

  146. 						<p>Default is <code>0</code>.</p>
    147. 

  147. 					</div>
    148. 

  148. 				</div>
    149. 

  149. 				<div class="member">
    150. 

  150. 					<h3 class="name" id="loopStart" translate="no">.<a href="#loopStart">loopStart</a><span class="type-signature"> : number</span> </h3>
    151. 

  151. 					<div class="description">
    152. 

  152. 						<p>Defines where in the audio buffer the replay should
    153. 

  153. start, in seconds.</p>
    154. 

  154. 						<p>Default is <code>0</code>.</p>
    155. 

  155. 					</div>
    156. 

  156. 				</div>
    157. 

  157. 				<div class="member">
    158. 

  158. 					<h3 class="name" id="offset" translate="no">.<a href="#offset">offset</a><span class="type-signature"> : number</span> </h3>
    159. 

  159. 					<div class="description">
    160. 

  160. 						<p>An offset to the time within the audio buffer the playback
    161. 

  161. should begin, in seconds.</p>
    162. 

  162. 						<p>Default is <code>0</code>.</p>
    163. 

  163. 					</div>
    164. 

  164. 				</div>
    165. 

  165. 				<div class="member">
    166. 

  166. 					<h3 class="name" id="playbackRate" translate="no">.<a href="#playbackRate">playbackRate</a><span class="type-signature"> : number</span> <span class="type-signature">(readonly) </span></h3>
    167. 

  167. 					<div class="description">
    168. 

  168. 						<p>The playback speed.</p>
    169. 

  169. <p>Defined via <a href="Audio.html#setPlaybackRate">Audio#setPlaybackRate</a>.</p>
    170. 

  170. 						<p>Default is <code>1</code>.</p>
    171. 

  171. 					</div>
    172. 

  172. 				</div>
    173. 

  173. 				<div class="member">
    174. 

  174. 					<h3 class="name" id="source" translate="no">.<a href="#source">source</a><span class="type-signature"> : AudioNode</span> <span class="type-signature">(readonly) </span></h3>
    175. 

  175. 					<div class="description">
    176. 

  176. 						<p>Holds a reference to the current audio source.</p>
    177. 

  177. <p>The property is automatically by one of the <code>set*()</code> methods.</p>
    178. 

  178. 						<p>Default is <code>null</code>.</p>
    179. 

  179. 					</div>
    180. 

  180. 				</div>
    181. 

  181. 				<div class="member">
    182. 

  182. 					<h3 class="name" id="sourceType" translate="no">.<a href="#sourceType">sourceType</a><span class="type-signature"> : 'empty' | 'audioNode' | 'mediaNode' | 'mediaStreamNode' | 'buffer'</span> <span class="type-signature">(readonly) </span></h3>
    183. 

  183. 					<div class="description">
    184. 

  184. 						<p>Defines the source type.</p>
    185. 

  185. <p>The property is automatically set by one of the <code>set*()</code> methods.</p>
    186. 

  186. 						<p>Default is <code>'empty'</code>.</p>
    187. 

  187. 					</div>
    188. 

  188. 				</div>
    189. 

  189. 				<h2 class="subsection-title">Methods</h2>
    190. 

  190. 					<h3 class="name name-method" id="connect" translate="no">.<a href="#connect">connect</a><span class="signature">()</span><span class="type-signature"> : <a href="Audio.html">Audio</a></span> </h3>
    191. 

  191. 					<div class="method">
    192. 

  192. 						<div class="description">
    193. 

  193. 							<p>Connects to the audio source. This is used internally on
    194. 

  194. initialisation and when setting / removing filters.</p>
    195. 

  195. 						</div>
    196. 

  196. 						<dl class="details">
    197. 

  197. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
    198. 

  198. 						</dl>
    199. 

  199. 					</div>
    200. 

  200. 					<h3 class="name name-method" id="disconnect" translate="no">.<a href="#disconnect">disconnect</a><span class="signature">()</span><span class="type-signature"> : <a href="Audio.html">Audio</a> | undefined</span> </h3>
    201. 

  201. 					<div class="method">
    202. 

  202. 						<div class="description">
    203. 

  203. 							<p>Disconnects to the audio source. This is used internally on
    204. 

  204. initialisation and when setting / removing filters.</p>
    205. 

  205. 						</div>
    206. 

  206. 						<dl class="details">
    207. 

  207. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
    208. 

  208. 						</dl>
    209. 

  209. 					</div>
    210. 

  210. 					<h3 class="name name-method" id="getDetune" translate="no">.<a href="#getDetune">getDetune</a><span class="signature">()</span><span class="type-signature"> : number</span> </h3>
    211. 

  211. 					<div class="method">
    212. 

  212. 						<div class="description">
    213. 

  213. 							<p>Returns the detuning of oscillation in cents.</p>
    214. 

  214. 						</div>
    215. 

  215. 						<dl class="details">
    216. 

  216. 							<dt class="tag-returns"><strong>Returns:</strong> The detuning of oscillation in cents.</dt>
    217. 

  217. 						</dl>
    218. 

  218. 					</div>
    219. 

  219. 					<h3 class="name name-method" id="getFilter" translate="no">.<a href="#getFilter">getFilter</a><span class="signature">()</span><span class="type-signature"> : AudioNode | undefined</span> </h3>
    220. 

  220. 					<div class="method">
    221. 

  221. 						<div class="description">
    222. 

  222. 							<p>Returns the first filter in the list of filters.</p>
    223. 

  223. 						</div>
    224. 

  224. 						<dl class="details">
    225. 

  225. 							<dt class="tag-returns"><strong>Returns:</strong> The first filter in the list of filters.</dt>
    226. 

  226. 						</dl>
    227. 

  227. 					</div>
    228. 

  228. 					<h3 class="name name-method" id="getFilters" translate="no">.<a href="#getFilters">getFilters</a><span class="signature">()</span><span class="type-signature"> : Array.&lt;AudioNode></span> </h3>
    229. 

  229. 					<div class="method">
    230. 

  230. 						<div class="description">
    231. 

  231. 							<p>Returns the current set filters.</p>
    232. 

  232. 						</div>
    233. 

  233. 						<dl class="details">
    234. 

  234. 							<dt class="tag-returns"><strong>Returns:</strong> The list of filters.</dt>
    235. 

  235. 						</dl>
    236. 

  236. 					</div>
    237. 

  237. 					<h3 class="name name-method" id="getLoop" translate="no">.<a href="#getLoop">getLoop</a><span class="signature">()</span><span class="type-signature"> : boolean</span> </h3>
    238. 

  238. 					<div class="method">
    239. 

  239. 						<div class="description">
    240. 

  240. 							<p>Returns the loop flag.</p>
    241. 

  241. <p>Can only be used with compatible audio sources that allow playback control.</p>
    242. 

  242. 						</div>
    243. 

  243. 						<dl class="details">
    244. 

  244. 							<dt class="tag-returns"><strong>Returns:</strong> Whether the audio should loop or not.</dt>
    245. 

  245. 						</dl>
    246. 

  246. 					</div>
    247. 

  247. 					<h3 class="name name-method" id="getOutput" translate="no">.<a href="#getOutput">getOutput</a><span class="signature">()</span><span class="type-signature"> : GainNode</span> </h3>
    248. 

  248. 					<div class="method">
    249. 

  249. 						<div class="description">
    250. 

  250. 							<p>Returns the output audio node.</p>
    251. 

  251. 						</div>
    252. 

  252. 						<dl class="details">
    253. 

  253. 							<dt class="tag-returns"><strong>Returns:</strong> The output node.</dt>
    254. 

  254. 						</dl>
    255. 

  255. 					</div>
    256. 

  256. 					<h3 class="name name-method" id="getPlaybackRate" translate="no">.<a href="#getPlaybackRate">getPlaybackRate</a><span class="signature">()</span><span class="type-signature"> : number</span> </h3>
    257. 

  257. 					<div class="method">
    258. 

  258. 						<div class="description">
    259. 

  259. 							<p>Returns the current playback rate.</p>
    260. 

  260. 						</div>
    261. 

  261. 						<dl class="details">
    262. 

  262. 							<dt class="tag-returns"><strong>Returns:</strong> The playback rate.</dt>
    263. 

  263. 						</dl>
    264. 

  264. 					</div>
    265. 

  265. 					<h3 class="name name-method" id="getVolume" translate="no">.<a href="#getVolume">getVolume</a><span class="signature">()</span><span class="type-signature"> : number</span> </h3>
    266. 

  266. 					<div class="method">
    267. 

  267. 						<div class="description">
    268. 

  268. 							<p>Returns the volume.</p>
    269. 

  269. 						</div>
    270. 

  270. 						<dl class="details">
    271. 

  271. 							<dt class="tag-returns"><strong>Returns:</strong> The volume.</dt>
    272. 

  272. 						</dl>
    273. 

  273. 					</div>
    274. 

  274. 					<h3 class="name name-method" id="onEnded" translate="no">.<a href="#onEnded">onEnded</a><span class="signature">()</span> </h3>
    275. 

  275. 					<div class="method">
    276. 

  276. 						<div class="description">
    277. 

  277. 							<p>Automatically called when playback finished.</p>
    278. 

  278. 						</div>
    279. 

  279. 					</div>
    280. 

  280. 					<h3 class="name name-method" id="pause" translate="no">.<a href="#pause">pause</a><span class="signature">()</span><span class="type-signature"> : <a href="Audio.html">Audio</a> | undefined</span> </h3>
    281. 

  281. 					<div class="method">
    282. 

  282. 						<div class="description">
    283. 

  283. 							<p>Pauses the playback of the audio.</p>
    284. 

  284. <p>Can only be used with compatible audio sources that allow playback control.</p>
    285. 

  285. 						</div>
    286. 

  286. 						<dl class="details">
    287. 

  287. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
    288. 

  288. 						</dl>
    289. 

  289. 					</div>
    290. 

  290. 					<h3 class="name name-method" id="play" translate="no">.<a href="#play">play</a><span class="signature">( delay : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Audio.html">Audio</a> | undefined</span> </h3>
    291. 

  291. 					<div class="method">
    292. 

  292. 						<div class="description">
    293. 

  293. 							<p>Starts the playback of the audio.</p>
    294. 

  294. <p>Can only be used with compatible audio sources that allow playback control.</p>
    295. 

  295. 						</div>
    296. 

  296. 						<table class="params">
    297. 

  297. 							<tbody>
    298. 

  298. 								<tr>
    299. 

  299. 									<td class="name">
    300. 

  300. 										<strong>delay</strong>
    301. 

  301. 									</td>
    302. 

  302. 									<td class="description last">
    303. 

  303. 										<p>The delay, in seconds, at which the audio should start playing.</p>
    304. 

  304. 										<p>Default is <code>0</code>.</p>
    305. 

  305. 									</td>
    306. 

  306. 								</tr>
    307. 

  307. 							</tbody>
    308. 

  308. 						</table>
    309. 

  309. 						<dl class="details">
    310. 

  310. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
    311. 

  311. 						</dl>
    312. 

  312. 					</div>
    313. 

  313. 					<h3 class="name name-method" id="setBuffer" translate="no">.<a href="#setBuffer">setBuffer</a><span class="signature">( audioBuffer : <span class="param-type">AudioBuffer</span> )</span><span class="type-signature"> : <a href="Audio.html">Audio</a></span> </h3>
    314. 

  314. 					<div class="method">
    315. 

  315. 						<div class="description">
    316. 

  316. 							<p>Sets the given audio buffer as the source of this instance.</p>
    317. 

  317. <p><a href="Audio.html#sourceType">Audio#sourceType</a> is set to <code>buffer</code> and <a href="Audio.html#hasPlaybackControl">Audio#hasPlaybackControl</a> to <code>true</code>.</p>
    318. 

  318. 						</div>
    319. 

  319. 						<table class="params">
    320. 

  320. 							<tbody>
    321. 

  321. 								<tr>
    322. 

  322. 									<td class="name">
    323. 

  323. 										<strong>audioBuffer</strong>
    324. 

  324. 									</td>
    325. 

  325. 									<td class="description last">
    326. 

  326. 										<p>The audio buffer.</p>
    327. 

  327. 									</td>
    328. 

  328. 								</tr>
    329. 

  329. 							</tbody>
    330. 

  330. 						</table>
    331. 

  331. 						<dl class="details">
    332. 

  332. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
    333. 

  333. 						</dl>
    334. 

  334. 					</div>
    335. 

  335. 					<h3 class="name name-method" id="setDetune" translate="no">.<a href="#setDetune">setDetune</a><span class="signature">( value : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Audio.html">Audio</a></span> </h3>
    336. 

  336. 					<div class="method">
    337. 

  337. 						<div class="description">
    338. 

  338. 							<p>Defines the detuning of oscillation in cents.</p>
    339. 

  339. 						</div>
    340. 

  340. 						<table class="params">
    341. 

  341. 							<tbody>
    342. 

  342. 								<tr>
    343. 

  343. 									<td class="name">
    344. 

  344. 										<strong>value</strong>
    345. 

  345. 									</td>
    346. 

  346. 									<td class="description last">
    347. 

  347. 										<p>The detuning of oscillation in cents.</p>
    348. 

  348. 									</td>
    349. 

  349. 								</tr>
    350. 

  350. 							</tbody>
    351. 

  351. 						</table>
    352. 

  352. 						<dl class="details">
    353. 

  353. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
    354. 

  354. 						</dl>
    355. 

  355. 					</div>
    356. 

  356. 					<h3 class="name name-method" id="setFilter" translate="no">.<a href="#setFilter">setFilter</a><span class="signature">( filter : <span class="param-type">AudioNode</span> )</span><span class="type-signature"> : <a href="Audio.html">Audio</a></span> </h3>
    357. 

  357. 					<div class="method">
    358. 

  358. 						<div class="description">
    359. 

  359. 							<p>Applies a single filter node to the audio.</p>
    360. 

  360. 						</div>
    361. 

  361. 						<table class="params">
    362. 

  362. 							<tbody>
    363. 

  363. 								<tr>
    364. 

  364. 									<td class="name">
    365. 

  365. 										<strong>filter</strong>
    366. 

  366. 									</td>
    367. 

  367. 									<td class="description last">
    368. 

  368. 										<p>The filter to set.</p>
    369. 

  369. 									</td>
    370. 

  370. 								</tr>
    371. 

  371. 							</tbody>
    372. 

  372. 						</table>
    373. 

  373. 						<dl class="details">
    374. 

  374. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
    375. 

  375. 						</dl>
    376. 

  376. 					</div>
    377. 

  377. 					<h3 class="name name-method" id="setFilters" translate="no">.<a href="#setFilters">setFilters</a><span class="signature">( value : <span class="param-type">Array.&lt;AudioNode></span> )</span><span class="type-signature"> : <a href="Audio.html">Audio</a></span> </h3>
    378. 

  378. 					<div class="method">
    379. 

  379. 						<div class="description">
    380. 

  380. 							<p>Sets an array of filters and connects them with the audio source.</p>
    381. 

  381. 						</div>
    382. 

  382. 						<table class="params">
    383. 

  383. 							<tbody>
    384. 

  384. 								<tr>
    385. 

  385. 									<td class="name">
    386. 

  386. 										<strong>value</strong>
    387. 

  387. 									</td>
    388. 

  388. 									<td class="description last">
    389. 

  389. 										<p>A list of filters.</p>
    390. 

  390. 									</td>
    391. 

  391. 								</tr>
    392. 

  392. 							</tbody>
    393. 

  393. 						</table>
    394. 

  394. 						<dl class="details">
    395. 

  395. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
    396. 

  396. 						</dl>
    397. 

  397. 					</div>
    398. 

  398. 					<h3 class="name name-method" id="setLoop" translate="no">.<a href="#setLoop">setLoop</a><span class="signature">( value : <span class="param-type">boolean</span> )</span><span class="type-signature"> : <a href="Audio.html">Audio</a> | undefined</span> </h3>
    399. 

  399. 					<div class="method">
    400. 

  400. 						<div class="description">
    401. 

  401. 							<p>Sets the loop flag.</p>
    402. 

  402. <p>Can only be used with compatible audio sources that allow playback control.</p>
    403. 

  403. 						</div>
    404. 

  404. 						<table class="params">
    405. 

  405. 							<tbody>
    406. 

  406. 								<tr>
    407. 

  407. 									<td class="name">
    408. 

  408. 										<strong>value</strong>
    409. 

  409. 									</td>
    410. 

  410. 									<td class="description last">
    411. 

  411. 										<p>Whether the audio should loop or not.</p>
    412. 

  412. 									</td>
    413. 

  413. 								</tr>
    414. 

  414. 							</tbody>
    415. 

  415. 						</table>
    416. 

  416. 						<dl class="details">
    417. 

  417. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
    418. 

  418. 						</dl>
    419. 

  419. 					</div>
    420. 

  420. 					<h3 class="name name-method" id="setLoopEnd" translate="no">.<a href="#setLoopEnd">setLoopEnd</a><span class="signature">( value : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Audio.html">Audio</a></span> </h3>
    421. 

  421. 					<div class="method">
    422. 

  422. 						<div class="description">
    423. 

  423. 							<p>Sets the loop end value which defines where in the audio buffer the replay should
    424. 

  424. stop, in seconds.</p>
    425. 

  425. 						</div>
    426. 

  426. 						<table class="params">
    427. 

  427. 							<tbody>
    428. 

  428. 								<tr>
    429. 

  429. 									<td class="name">
    430. 

  430. 										<strong>value</strong>
    431. 

  431. 									</td>
    432. 

  432. 									<td class="description last">
    433. 

  433. 										<p>The loop end value.</p>
    434. 

  434. 									</td>
    435. 

  435. 								</tr>
    436. 

  436. 							</tbody>
    437. 

  437. 						</table>
    438. 

  438. 						<dl class="details">
    439. 

  439. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
    440. 

  440. 						</dl>
    441. 

  441. 					</div>
    442. 

  442. 					<h3 class="name name-method" id="setLoopStart" translate="no">.<a href="#setLoopStart">setLoopStart</a><span class="signature">( value : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Audio.html">Audio</a></span> </h3>
    443. 

  443. 					<div class="method">
    444. 

  444. 						<div class="description">
    445. 

  445. 							<p>Sets the loop start value which defines where in the audio buffer the replay should
    446. 

  446. start, in seconds.</p>
    447. 

  447. 						</div>
    448. 

  448. 						<table class="params">
    449. 

  449. 							<tbody>
    450. 

  450. 								<tr>
    451. 

  451. 									<td class="name">
    452. 

  452. 										<strong>value</strong>
    453. 

  453. 									</td>
    454. 

  454. 									<td class="description last">
    455. 

  455. 										<p>The loop start value.</p>
    456. 

  456. 									</td>
    457. 

  457. 								</tr>
    458. 

  458. 							</tbody>
    459. 

  459. 						</table>
    460. 

  460. 						<dl class="details">
    461. 

  461. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
    462. 

  462. 						</dl>
    463. 

  463. 					</div>
    464. 

  464. 					<h3 class="name name-method" id="setMediaElementSource" translate="no">.<a href="#setMediaElementSource">setMediaElementSource</a><span class="signature">( mediaElement : <span class="param-type">HTMLMediaElement</span> )</span><span class="type-signature"> : <a href="Audio.html">Audio</a></span> </h3>
    465. 

  465. 					<div class="method">
    466. 

  466. 						<div class="description">
    467. 

  467. 							<p>Sets the given media element as the source of this instance.</p>
    468. 

  468. <p><a href="Audio.html#sourceType">Audio#sourceType</a> is set to <code>mediaNode</code> and <a href="Audio.html#hasPlaybackControl">Audio#hasPlaybackControl</a> to <code>false</code>.</p>
    469. 

  469. 						</div>
    470. 

  470. 						<table class="params">
    471. 

  471. 							<tbody>
    472. 

  472. 								<tr>
    473. 

  473. 									<td class="name">
    474. 

  474. 										<strong>mediaElement</strong>
    475. 

  475. 									</td>
    476. 

  476. 									<td class="description last">
    477. 

  477. 										<p>The media element.</p>
    478. 

  478. 									</td>
    479. 

  479. 								</tr>
    480. 

  480. 							</tbody>
    481. 

  481. 						</table>
    482. 

  482. 						<dl class="details">
    483. 

  483. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
    484. 

  484. 						</dl>
    485. 

  485. 					</div>
    486. 

  486. 					<h3 class="name name-method" id="setMediaStreamSource" translate="no">.<a href="#setMediaStreamSource">setMediaStreamSource</a><span class="signature">( mediaStream : <span class="param-type">MediaStream</span> )</span><span class="type-signature"> : <a href="Audio.html">Audio</a></span> </h3>
    487. 

  487. 					<div class="method">
    488. 

  488. 						<div class="description">
    489. 

  489. 							<p>Sets the given media stream as the source of this instance.</p>
    490. 

  490. <p><a href="Audio.html#sourceType">Audio#sourceType</a> is set to <code>mediaStreamNode</code> and <a href="Audio.html#hasPlaybackControl">Audio#hasPlaybackControl</a> to <code>false</code>.</p>
    491. 

  491. 						</div>
    492. 

  492. 						<table class="params">
    493. 

  493. 							<tbody>
    494. 

  494. 								<tr>
    495. 

  495. 									<td class="name">
    496. 

  496. 										<strong>mediaStream</strong>
    497. 

  497. 									</td>
    498. 

  498. 									<td class="description last">
    499. 

  499. 										<p>The media stream.</p>
    500. 

  500. 									</td>
    501. 

  501. 								</tr>
    502. 

  502. 							</tbody>
    503. 

  503. 						</table>
    504. 

  504. 						<dl class="details">
    505. 

  505. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
    506. 

  506. 						</dl>
    507. 

  507. 					</div>
    508. 

  508. 					<h3 class="name name-method" id="setNodeSource" translate="no">.<a href="#setNodeSource">setNodeSource</a><span class="signature">( audioNode : <span class="param-type">AudioNode</span> )</span><span class="type-signature"> : <a href="Audio.html">Audio</a></span> </h3>
    509. 

  509. 					<div class="method">
    510. 

  510. 						<div class="description">
    511. 

  511. 							<p>Sets the given audio node as the source of this instance.</p>
    512. 

  512. <p><a href="Audio.html#sourceType">Audio#sourceType</a> is set to <code>audioNode</code> and <a href="Audio.html#hasPlaybackControl">Audio#hasPlaybackControl</a> to <code>false</code>.</p>
    513. 

  513. 						</div>
    514. 

  514. 						<table class="params">
    515. 

  515. 							<tbody>
    516. 

  516. 								<tr>
    517. 

  517. 									<td class="name">
    518. 

  518. 										<strong>audioNode</strong>
    519. 

  519. 									</td>
    520. 

  520. 									<td class="description last">
    521. 

  521. 										<p>The audio node like an instance of <code>OscillatorNode</code>.</p>
    522. 

  522. 									</td>
    523. 

  523. 								</tr>
    524. 

  524. 							</tbody>
    525. 

  525. 						</table>
    526. 

  526. 						<dl class="details">
    527. 

  527. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
    528. 

  528. 						</dl>
    529. 

  529. 					</div>
    530. 

  530. 					<h3 class="name name-method" id="setPlaybackRate" translate="no">.<a href="#setPlaybackRate">setPlaybackRate</a><span class="signature">( value : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Audio.html">Audio</a> | undefined</span> </h3>
    531. 

  531. 					<div class="method">
    532. 

  532. 						<div class="description">
    533. 

  533. 							<p>Sets the playback rate.</p>
    534. 

  534. <p>Can only be used with compatible audio sources that allow playback control.</p>
    535. 

  535. 						</div>
    536. 

  536. 						<table class="params">
    537. 

  537. 							<tbody>
    538. 

  538. 								<tr>
    539. 

  539. 									<td class="name">
    540. 

  540. 										<strong>value</strong>
    541. 

  541. 									</td>
    542. 

  542. 									<td class="description last">
    543. 

  543. 										<p>The playback rate to set.</p>
    544. 

  544. 									</td>
    545. 

  545. 								</tr>
    546. 

  546. 							</tbody>
    547. 

  547. 						</table>
    548. 

  548. 						<dl class="details">
    549. 

  549. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
    550. 

  550. 						</dl>
    551. 

  551. 					</div>
    552. 

  552. 					<h3 class="name name-method" id="setVolume" translate="no">.<a href="#setVolume">setVolume</a><span class="signature">( value : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Audio.html">Audio</a></span> </h3>
    553. 

  553. 					<div class="method">
    554. 

  554. 						<div class="description">
    555. 

  555. 							<p>Sets the volume.</p>
    556. 

  556. 						</div>
    557. 

  557. 						<table class="params">
    558. 

  558. 							<tbody>
    559. 

  559. 								<tr>
    560. 

  560. 									<td class="name">
    561. 

  561. 										<strong>value</strong>
    562. 

  562. 									</td>
    563. 

  563. 									<td class="description last">
    564. 

  564. 										<p>The volume to set.</p>
    565. 

  565. 									</td>
    566. 

  566. 								</tr>
    567. 

  567. 							</tbody>
    568. 

  568. 						</table>
    569. 

  569. 						<dl class="details">
    570. 

  570. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
    571. 

  571. 						</dl>
    572. 

  572. 					</div>
    573. 

  573. 					<h3 class="name name-method" id="stop" translate="no">.<a href="#stop">stop</a><span class="signature">( delay : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Audio.html">Audio</a> | undefined</span> </h3>
    574. 

  574. 					<div class="method">
    575. 

  575. 						<div class="description">
    576. 

  576. 							<p>Stops the playback of the audio.</p>
    577. 

  577. <p>Can only be used with compatible audio sources that allow playback control.</p>
    578. 

  578. 						</div>
    579. 

  579. 						<table class="params">
    580. 

  580. 							<tbody>
    581. 

  581. 								<tr>
    582. 

  582. 									<td class="name">
    583. 

  583. 										<strong>delay</strong>
    584. 

  584. 									</td>
    585. 

  585. 									<td class="description last">
    586. 

  586. 										<p>The delay, in seconds, at which the audio should stop playing.</p>
    587. 

  587. 										<p>Default is <code>0</code>.</p>
    588. 

  588. 									</td>
    589. 

  589. 								</tr>
    590. 

  590. 							</tbody>
    591. 

  591. 						</table>
    592. 

  592. 						<dl class="details">
    593. 

  593. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this instance.</dt>
    594. 

  594. 						</dl>
    595. 

  595. 					</div>
    596. 

  596. 				<h2 class="subsection-title">Source</h2>
    597. 

  597. 				<p>
    598. 

  598. 					<a href="https://github.com/mrdoob/three.js/blob/master/src/audio/Audio.js" translate="no" target="_blank" rel="noopener">src/audio/Audio.js</a>
    599. 

  599. 				</p>
    600. 

  600. 			</article>
    601. 

  601. 		</section>
    602. 

  602. <script src="../scripts/linenumber.js"></script>
    603. 

  603. <script src="../scripts/page.js"></script>
    604. 

  604. </body>
    605. 

  605. </html>
    606.
粤ICP备19079148号