Skip to content

Commit 974a9c0

Browse files
Added addMarker method docs
1 parent f76aff7 commit 974a9c0

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

v3/src/sound/BaseSound.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,14 @@ var BaseSound = new Class({
163163
*/
164164
this.pendingRemove = false;
165165
},
166+
/**
167+
* Adds a marker into the current sound. A marker is represented by name, start time, duration, and optionally config object.
168+
* This allows you to bundle multiple sounds together into a single audio file and use markers to jump between them for playback.
169+
*
170+
* @method Phaser.Sound.BaseSound#addMarker
171+
* @param {ISoundMarker} marker - Marker object
172+
* @returns {boolean} Whether the marker was added successfully
173+
*/
166174
addMarker: function (marker) {
167175
if (!marker) {
168176
console.error('addMarker - Marker object has to be provided!');

0 commit comments

Comments
 (0)