PositionalAudio.html 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../" />
  6. <script src="list.js"></script>
  7. <script src="page.js"></script>
  8. <link type="text/css" rel="stylesheet" href="page.css" />
  9. </head>
  10. <body>
  11. [page:Object3D] &rarr; [page:Audio] &rarr;
  12. <h1>[name]</h1>
  13. <div class="desc">
  14. Create a positional audio object.<br /><br />
  15. This uses the [link:https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API Web Audio API].
  16. </div>
  17. <h2>Example</h2>
  18. <div>[example:misc_sound misc / sound ]</div>
  19. <code>
  20. //Create an AudioListener and add it to the camera
  21. var listener = new THREE.AudioListener();
  22. camera.add( listener );
  23. //Create the PositionalAudio object (passing in the listener)
  24. var sound = new THREE.PositionalAudio( listener );
  25. //Load a sound and set it as the PositionalAudio object's buffer
  26. var audioLoader = new THREE.AudioLoader();
  27. audioLoader.load( 'sounds/song.ogg', function( buffer ) {
  28. sound1.setBuffer( buffer );
  29. sound1.setRefDistance( 20 );
  30. sound1.play();
  31. });
  32. //Create an object for the sound to play from
  33. var sphere = new THREE.SphereGeometry( 20, 32, 16 );
  34. var material = new THREE.MeshPhongMaterial( { color: 0xff2200 } );
  35. var mesh = new THREE.Mesh( sphere, material );
  36. scene.add( mesh );
  37. //Finally add the sound to the mesh
  38. mesh.add( sound );
  39. </code>
  40. <h2>Constructor</h2>
  41. <h3>[name]( [page:AudioListener listener] )</h3>
  42. <div>
  43. listener — (required) [page:AudioListener AudioListener] instance.
  44. </div>
  45. <h2>Properties</h2>
  46. <div>
  47. See the [page:Audio Audio] class for inherited properties.
  48. </div>
  49. <h3>[property:PannerNode panner]</h3>
  50. <div>The PositionalAudio's [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode PannerNode].</div>
  51. <h2>Methods</h2>
  52. <div>
  53. See the [page:Audio Audio] class for inherited methods.
  54. </div>
  55. <h3>[method:PannerNode getOutput]()</h3>
  56. <div>
  57. Returns the [page:PositionalAudio.panner panner].
  58. </div>
  59. <h3>[method:Number getRefDistance]()</h3>
  60. <div>
  61. Returns the value of [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/refDistance panner.refDistance].
  62. </div>
  63. <h3>[method:PannerNode setRefDistance]( [page:Number value] )</h3>
  64. <div>
  65. Sets the value of [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/refDistance panner.refDistance].
  66. </div>
  67. <h3>[method:PannerNode getRolloffFactor]()</h3>
  68. <div>
  69. Returns the value of [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/rolloffFactor panner.rolloffFactor].
  70. </div>
  71. <h3>[method:PannerNode setRolloffFactor]( [page:Number value] )</h3>
  72. <div>
  73. Sets the value of [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/rolloffFactor panner.rolloffFactor].
  74. </div>
  75. <h3>[method:String getDistanceModel]()</h3>
  76. <div>
  77. Returns the value of [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/distanceModel panner.distanceModel].
  78. </div>
  79. <h3>[method:String setDistanceModel]( [page:String value] )</h3>
  80. <div>
  81. Sets the value of [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/distanceModel panner.distanceModel].
  82. </div>
  83. <h3>[method:PannerNode getMaxDistance]()</h3>
  84. <div>
  85. Returns the value of [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/maxDistance panner.distanceModel].
  86. </div>
  87. <h3>[method:PannerNode setMaxDistance]( [page:Number value] )</h3>
  88. <div>
  89. Sets the value of [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/maxDistance panner.distanceModel].
  90. </div>
  91. <h2>Source</h2>
  92. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  93. </body>
  94. </html>