ydeng/audioshowkit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

More JSDoc fixes.

Browse Source
This commit is contained in:
Harrison Deng 2022-04-17 14:27:31 -05:00
parent b771d211a4
commit 16089881d6
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/visualization/VisualizerUpdateManager.js
View File

@ -129,8 +129,12 @@ export default class VisualizerUpdateManager {
} }
/** /**
* * @param {object} listeners The listeners that this visualizer update manager should be set to use.
* @param {{binned: VisualizerUpdateManager.visualizerBinUpdateListener[][], ranged: {lower: number, upper: number, listener: VisualizerUpdateManager.visualizerRangedUpdateListener}[]}} listeners an object containing both the binned, and ranged listeners that this update manager should use. * @param {VisualizerUpdateManager.visualizerBinUpdateListener[][]} listeners.binned The bin listeners.
* @param {object[]} listeners.ranged The array of ranged listeners.
* @param {number} listeners.ranged[].lower The lower bound of the listener.
* @param {number} listeners.ranged[].upper The upper bound of the listener.
* @param {VisualizerUpdateManager.visualizerRangedUpdateListener} listeners.ranged[].listener The listener for the previously mentioned ranges.
* @returns {boolean} true if and only if successfully loaded the new listeners. * @returns {boolean} true if and only if successfully loaded the new listeners.
*/ */
setBinnedListeners(listeners) { setBinnedListeners(listeners) {
@ -142,7 +146,7 @@ export default class VisualizerUpdateManager {
/** /**
* *
* @returns {{binned: VisualizerUpdateManager.visualizerBinUpdateListener[][], ranged: {lower: number, upper: number, listener: VisualizerUpdateManager.visualizerRangedUpdateListener}[]}} All the listeners, both for binned, and ranged listeners. * @returns {object} All the listeners, both for binned, and ranged listeners. See {@link VisualizerUpdateManager#setBinnedListeners} to see the structure of the returned object.
*/ */
getAllListeners() { getAllListeners() {
return { return {