Skip to content

Commit 848770d

Browse files
committed
Adds jsDoc for AudioModule #358
1 parent c02ab0c commit 848770d

File tree

1 file changed

+31
-2
lines changed

1 file changed

+31
-2
lines changed

src/modules/extra/AudioModule.js

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,23 @@ import {
44
AudioLoader
55
} from 'three';
66

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+
*/
724
export default class PositionalAudioModule {
825
constructor(params = {}) {
926
this.params = Object.assign({
@@ -17,10 +34,22 @@ export default class PositionalAudioModule {
1734
this.positionalAudio.setLoop(this.params.loop);
1835
}
1936

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+
*/
2043
addListener(object) {
2144
object.native.add(this.audioListener);
22-
};
45+
}
2346

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+
*/
2453
play(path) {
2554
const sound = this.positionalAudio;
2655

@@ -29,7 +58,7 @@ export default class PositionalAudioModule {
2958
sound.setRefDistance(50);
3059
sound.play();
3160
});
32-
};
61+
}
3362

3463
bridge = {
3564
mesh(mesh, self) {

0 commit comments

Comments
 (0)