Skip to content

Commit 5e1a144

Browse files
authored
Merge pull request phaserjs#4181 from samme/docs/audioconfig
Correct docs for Phaser.Boot.Config#audio
2 parents 7ea0316 + 80cd835 commit 5e1a144

1 file changed

Lines changed: 7 additions & 9 deletions

File tree

src/boot/Config.js

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,13 @@ var ValueToColor = require('../display/color/ValueToColor');
3131
/**
3232
* Config object containing various sound settings.
3333
*
34-
* @typedef {object} SoundConfig
34+
* @typedef {object} AudioConfig
3535
*
36-
* @property {boolean} [mute=false] - Boolean indicating whether the sound should be muted or not.
37-
* @property {number} [volume=1] - A value between 0 (silence) and 1 (full volume).
38-
* @property {number} [rate=1] - Defines the speed at which the sound should be played.
39-
* @property {number} [detune=0] - Represents detuning of sound in [cents](https://en.wikipedia.org/wiki/Cent_%28music%29).
40-
* @property {number} [seek=0] - Position of playback for this sound, in seconds.
41-
* @property {boolean} [loop=false] - Whether or not the sound or current sound marker should loop.
42-
* @property {number} [delay=0] - Time, in seconds, that should elapse before the sound actually starts its playback.
36+
* @property {boolean} [disableWebAudio=false] - Use HTML5 Audio instead of Web Audio.
37+
* @property {AudioContext} [context] - An existing Web Audio context.
38+
* @property {boolean} [noAudio=false] - Disable all audio output.
39+
*
40+
* @see Phaser.Sound.SoundManagerCreator
4341
*/
4442

4543
/**
@@ -481,7 +479,7 @@ var Config = new Class({
481479
this.disableContextMenu = GetValue(config, 'disableContextMenu', false);
482480

483481
/**
484-
* @const {SoundConfig} Phaser.Boot.Config#audio - The Audio Configuration object.
482+
* @const {AudioConfig} Phaser.Boot.Config#audio - The Audio Configuration object.
485483
*/
486484
this.audio = GetValue(config, 'audio');
487485

0 commit comments

Comments
 (0)