@@ -4,6 +4,23 @@ import {
4
4
AudioLoader
5
5
} from 'three' ;
6
6
7
+ /**
8
+ * @class PositionalAudioModule
9
+ * @category modules/extra
10
+ * @param {Object } [params={loop: true}] - The parameters object.
11
+ * @memberof module:modules/extra
12
+ * @example <caption>How to create and apply a PositionalAudioModule</caption>
13
+ * const fogModule = const audioModule = new AudioModule({
14
+ * loop: true
15
+ * });
16
+ *
17
+ * new Sphere({
18
+ * ...,
19
+ * modules: [
20
+ * audioModule
21
+ * ]
22
+ * };
23
+ */
7
24
export default class PositionalAudioModule {
8
25
constructor ( params = { } ) {
9
26
this . params = Object . assign ( {
@@ -17,10 +34,22 @@ export default class PositionalAudioModule {
17
34
this . positionalAudio . setLoop ( this . params . loop ) ;
18
35
}
19
36
37
+ /**
38
+ * @method addListener
39
+ * @description Adds the listener of this audio source, usually the camera, origin of the user perspective
40
+ * @param {Object } object The listener object
41
+ * @memberof module:modules/extra.PositionalAudioModule
42
+ */
20
43
addListener ( object ) {
21
44
object . native . add ( this . audioListener ) ;
22
- } ;
45
+ }
23
46
47
+ /**
48
+ * @method play
49
+ * @description Plays the given sound
50
+ * @param {String } path The path to the sound file
51
+ * @memberof module:modules/extra.PositionalAudioModule
52
+ */
24
53
play ( path ) {
25
54
const sound = this . positionalAudio ;
26
55
@@ -29,7 +58,7 @@ export default class PositionalAudioModule {
29
58
sound . setRefDistance ( 50 ) ;
30
59
sound . play ( ) ;
31
60
} ) ;
32
- } ;
61
+ }
33
62
34
63
bridge = {
35
64
mesh ( mesh , self ) {
0 commit comments