Skip to content

Improve SoundSlot API docs #7621

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 27, 2025
Merged

Improve SoundSlot API docs #7621

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions src/framework/components/sound/slot.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,11 @@ const instanceOptions = {
};

/**
* The SoundSlot controls playback of an audio asset. A {@link SoundComponent} can have multiple
* slots that can be queried via {@link SoundComponent#slot}.
* The SoundSlot controls the playback of {@link SoundInstance}s. SoundSlots are managed by
* {@link SoundComponent}s. To add and remove SoundSlots on a SoundComponent, use
* {@link SoundComponent#addSlot} and {@link SoundComponent#removeSlot} respectively.
*
* @hideconstructor
* @category Sound
*/
class SoundSlot extends EventHandler {
Expand Down Expand Up @@ -113,8 +115,7 @@ class SoundSlot extends EventHandler {
/**
* Create a new SoundSlot.
*
* @param {SoundComponent} component - The Component that created this
* slot.
* @param {SoundComponent} component - The Component that created this slot.
* @param {string} [name] - The name of the slot. Defaults to 'Untitled'.
* @param {object} [options] - Settings for the slot.
* @param {number} [options.volume] - The playback volume, between 0 and 1.
Expand Down Expand Up @@ -164,7 +165,7 @@ class SoundSlot extends EventHandler {
}

/**
* Plays a sound. If {@link SoundSlot#overlap} is true the new sound instance will be played
* Plays a sound. If {@link overlap} is true the new sound instance will be played
* independently of any other instances already playing. Otherwise existing sound instances
* will stop before playing the new sound.
*
Expand Down Expand Up @@ -207,7 +208,7 @@ class SoundSlot extends EventHandler {
}

/**
* Pauses all sound instances. To continue playback call {@link SoundSlot#resume}.
* Pauses all sound instances. To continue playback call {@link resume}.
*
* @returns {boolean} True if the sound instances paused successfully, false otherwise.
*/
Expand Down Expand Up @@ -339,7 +340,7 @@ class SoundSlot extends EventHandler {
}

/**
* Clears any external nodes set by {@link SoundSlot#setExternalNodes}.
* Clears any external nodes set by {@link setExternalNodes}.
*/
clearExternalNodes() {
this._firstNode = null;
Expand All @@ -355,10 +356,10 @@ class SoundSlot extends EventHandler {
}

/**
* Gets an array that contains the two external nodes set by {@link SoundSlot#setExternalNodes}.
* Gets an array that contains the two external nodes set by {@link setExternalNodes}.
*
* @returns {AudioNode[]} An array of 2 elements that contains the first and last nodes set by
* {@link SoundSlot#setExternalNodes}.
* {@link setExternalNodes}.
*/
getExternalNodes() {
return [this._firstNode, this._lastNode];
Expand Down