1
0

Audio.html 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248
  1. <!DOCTYPE html>
  2. <html lang="fr">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../" />
  6. <script src="page.js"></script>
  7. <link type="text/css" rel="stylesheet" href="page.css" />
  8. </head>
  9. <body>
  10. [page:Object3D] &rarr;
  11. <h1>[name]</h1>
  12. <p class="desc">
  13. Crée un objet audio non-positionnel ( global ).<br /><br />
  14. La [link:https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API Web Audio API] est utilisée.
  15. </p>
  16. <h2>Exemple de Code</h2>
  17. <code>
  18. // create an AudioListener and add it to the camera
  19. const listener = new THREE.AudioListener();
  20. camera.add( listener );
  21. // create a global audio source
  22. const sound = new THREE.Audio( listener );
  23. // load a sound and set it as the Audio object's buffer
  24. const audioLoader = new THREE.AudioLoader();
  25. audioLoader.load( 'sounds/ambient.ogg', function( buffer ) {
  26. sound.setBuffer( buffer );
  27. sound.setLoop( true );
  28. sound.setVolume( 0.5 );
  29. sound.play();
  30. });
  31. </code>
  32. <h2>Exemples</h2>
  33. <p>
  34. [example:webaudio_sandbox webaudio / sandbox ]<br />
  35. [example:webaudio_visualizer webaudio / visualizer ]
  36. </p>
  37. <h2>Constructeur</h2>
  38. <h3>[name]( [param:AudioListener listener] )</h3>
  39. <p>
  40. listener — (requis) instance d'[page:AudioListener AudioListener].
  41. </p>
  42. <h2>Propriétés</h2>
  43. <h3>[property:Boolean autoplay]</h3>
  44. <p>Démarrage automatique de la lecture. La valeur par défaut est `false`.</p>
  45. <h3>[property:AudioContext context]</h3>
  46. <p>L'[link:https://developer.mozilla.org/en-US/docs/Web/API/AudioContext AudioContext] du [page:AudioListener listener] passé au constructeur.</p>
  47. <h3>[property:Number detune]</h3>
  48. <p>Modifie le ton, mesuré en centaines. +/- 100 est un demi-ton. +/- 1200 est un octave. La valeur par défaut est `0`.</p>
  49. <h3>[property:Array filters]</h3>
  50. <p>Représente un tableau d'[link:https://developer.mozilla.org/en-US/docs/Web/API/AudioNode AudioNodes]. Peut être utilisé pour appliquer une variété de filtres d'ordres inférieurs pour créer des effets sonores complexes.
  51. Dans la plupart des cas, le tableau contient des instances de [link:https://developer.mozilla.org/en-US/docs/Web/API/BiquadFilterNode BiquadFilterNodes]. Les filtres sont appliqués via [page:Audio.setFilter] ou [page:Audio.setFilters].</p>
  52. <h3>[property:GainNode gain]</h3>
  53. <p>Un [link:https://developer.mozilla.org/en-US/docs/Web/API/GainNode GainNode] créé
  54. en utilisant [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/createGain AudioContext.createGain]().</p>
  55. <h3>[property:Boolean hasPlaybackControl]</h3>
  56. <p>Définit si la lecture peut-être contrôlée en utilisant les méthodes [page:Audio.play play](),
  57. [page:Audio.pause pause]() etc. La valeur par défaut est `true`.</p>
  58. <h3>[property:Boolean isPlaying]</h3>
  59. <p>Indique si l'audio est en cours de lecture.</p>
  60. <h3>[property:AudioListener listener]</h3>
  61. <p>Une reference à l'objet listener de cet audio.</p>
  62. <h3>[property:Number playbackRate]</h3>
  63. <p>Vitesse de lecture. La valeur par défaut est `1`.</p>
  64. <h3>[property:Number offset]</h3>
  65. <p>Un décalage temporel après lequel la lecture doit commencer. Équivalent au paramètre `offset` de [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/start AudioBufferSourceNode.start](). La valeur par défaut est `0`.</p>
  66. <h3>[property:Number duration]</h3>
  67. <p>Écrase la durée de l'audio. Équivalent au paramètre `duration` de [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/start AudioBufferSourceNode.start](). La valeur par défaut est `undefined` afin de jour le buffer entier.</p>
  68. <h3>[property:AudioNode source]</h3>
  69. <p>Un [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode AudioBufferSourceNode] créé
  70. en utilisant [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/createBufferSource AudioContext.createBufferSource]().</p>
  71. <h3>[property:String sourceType]</h3>
  72. <p>Type de source audio. La valeur par défaut est 'empty'.</p>
  73. <h3>[property:String type]</h3>
  74. <p>String indiquant le type, contenant 'Audio'.</p>
  75. <h2>Méthodes</h2>
  76. <h3>[method:this connect]()</h3>
  77. <p>
  78. Connecte à la [page:Audio.source] audio. Ceci est utilisé en interne à l'initialisation et lors
  79. de l'ajout/retrait de filtres.
  80. </p>
  81. <h3>[method:this disconnect]()</h3>
  82. <p>
  83. Déconnecte de la [page:Audio.source]. Ceci est utilisé en interne lors
  84. de l'ajout/retrait de filtres.
  85. </p>
  86. <h3>[method:Float getDetune]()</h3>
  87. <p>
  88. Renvoie le detuning de l'oscillation en centaines.
  89. </p>
  90. <h3>[method:BiquadFilterNode getFilter]()</h3>
  91. <p>
  92. Renvoie le premier élément du tableau [page:Audio.filters filters].
  93. </p>
  94. <h3>[method:Array getFilters]()</h3>
  95. <p>
  96. Renvoie le tableau [page:Audio.filters filters].
  97. </p>
  98. <h3>[method:Boolean getLoop]()</h3>
  99. <p>
  100. Renvoie la valeur de [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loop source.loop]
  101. (Indique si la lecture doit boucler).
  102. </p>
  103. <h3>[method:GainNode getOutput]()</h3>
  104. <p>
  105. Renvoie le [page:Audio.gain gainNode].
  106. </p>
  107. <h3>[method:Float getPlaybackRate]()</h3>
  108. <p>
  109. Renvoie la valeur de [page:Audio.playbackRate playbackRate].
  110. </p>
  111. <h3>[method:Float getVolume]( value )</h3>
  112. <p>
  113. Renvoie le volume actuel.
  114. </p>
  115. <h3>[method:this play]( delay )</h3>
  116. <p>
  117. Si [page:Audio.hasPlaybackControl hasPlaybackControl] est à true, la lecture se lance.
  118. </p>
  119. <h3>[method:this pause]()</h3>
  120. <p>
  121. Si [page:Audio.hasPlaybackControl hasPlaybackControl] est à true, la lecture se met en pause.
  122. </p>
  123. <h3>[method:undefined onEnded]()</h3>
  124. <p>
  125. Appelée automatiquement quand la lecture est terminée.
  126. </p>
  127. <h3>[method:this setBuffer]( audioBuffer )</h3>
  128. <p>
  129. Met la [page:Audio.source source] à audioBuffer, et met le [page:Audio.sourceType sourceType] à 'buffer'.<br />
  130. Si [page:Audio.autoplay autoplay] est activé, la méthode démarrera également la lecture.
  131. </p>
  132. <h3>[method:this setDetune]( [param:Float value] )</h3>
  133. <p>
  134. Définit le detuning de l'oscillation en centaines.
  135. </p>
  136. <h3>[method:this setFilter]( filter )</h3>
  137. <p>
  138. Applique un noeud à filtre unique à l'audio.
  139. </p>
  140. <h3>[method:this setFilters]( [param:Array value] )</h3>
  141. <p>
  142. value - tableau de filtres.<br />
  143. Applique un tableau de noeuds de filtres à l'audio.
  144. </p>
  145. <h3>[method:this setLoop]( [param:Boolean value] )</h3>
  146. <p>
  147. Met [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loop source.loop] à `value`
  148. (Indique si la lecture doit boucler).
  149. </p>
  150. <h3>[method:this setLoopStart]( [param:Float value] )</h3>
  151. <p>
  152. Met [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loopStart source.loopStart] à `value`.
  153. </p>
  154. <h3>[method:this setLoopEnd]( [param:Float value] )</h3>
  155. <p>
  156. Met [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loopEnd source.loopEnd] à `value`.
  157. </p>
  158. <h3>[method:this setMediaElementSource]( mediaElement )</h3>
  159. <p>
  160. Définit le type d'objet passé en paramètre [link:https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement HTMLMediaElement] comme source de l'audio.<br />
  161. Met également [page:Audio.hasPlaybackControl hasPlaybackControl] à false.
  162. </p>
  163. <h3>[method:this setMediaStreamSource]( mediaStream )</h3>
  164. <p>
  165. Définit le type d'objet passé en paramètre [link:https://developer.mozilla.org/en-US/docs/Web/API/MediaStream MediaStream] comme source de l'audio.<br />
  166. Met également [page:Audio.hasPlaybackControl hasPlaybackControl] à false.
  167. </p>
  168. <h3>[method:this setNodeSource]( audioNode )</h3>
  169. <p>
  170. Met la [page:Audio.source source] à audioBuffer, et met le [page:Audio.sourceType sourceType] à 'audioNode'.<br />
  171. Met également [page:Audio.hasPlaybackControl hasPlaybackControl] à false.
  172. </p>
  173. <h3>[method:this setPlaybackRate]( [param:Float value] )</h3>
  174. <p>
  175. Si [page:Audio.hasPlaybackControl hasPlaybackControl] est activé, mets le [page:Audio.playbackRate playbackRate] à `value`.
  176. </p>
  177. <h3>[method:this setVolume]( [param:Float value] )</h3>
  178. <p>
  179. Modifie le volume.
  180. </p>
  181. <h3>[method:this stop]()</h3>
  182. <p>
  183. Si [page:Audio.hasPlaybackControl hasPlaybackControl] est activé, la lecture est stoppée.
  184. </p>
  185. <h2>Source</h2>
  186. <p>
  187. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  188. </p>
  189. </body>
  190. </html>