Skip to content

Commit 28bf61f

Browse files
Added docs for defining SoundMarker custom type
1 parent 8e2cb94 commit 28bf61f

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

src/sound/index.js

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,17 @@
2222
* @property {number} [delay=0] - Time, in seconds, that should elapse before the sound actually starts its playback.
2323
*/
2424

25+
/**
26+
* Marked section of a sound represented by name, and optionally start time, duration, and config object.
27+
*
28+
* @typedef {object} SoundMarker
29+
*
30+
* @property {string} name - Unique identifier of a sound marker.
31+
* @property {number} [start=0] - Sound position offset at witch playback should start.
32+
* @property {number} [duration] - Playback duration of this marker.
33+
* @property {SoundConfig} [config] - An optional config object containing default marker settings.
34+
*/
35+
2536
module.exports = {
2637

2738
SoundManagerCreator: require('./SoundManagerCreator'),

0 commit comments

Comments
 (0)