Skip to content

Commit 3c5f968

Browse files
committed
refactor(hook): update useSpectrogram JS doc
1 parent 2bbbcea commit 3c5f968

1 file changed

Lines changed: 1 addition & 3 deletions

File tree

packages/hooks/useSpectrogram.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,10 @@ const FFT_SIZE = 1024
2020
* - Default value is 1024.
2121
*
2222
* @returns {object} An object containing various properties and methods to interact with the spectrogram:
23+
* - init: A method to initialize the analyser.
2324
* - analyser: An instance of Tone.Analyser used for analyzing audio frequencies.
2425
* - data: An array of spectrogram data points.
25-
* - fftSize: The size of the FFT, can be updated dynamically.
26-
* - init: A method to initialize the analyser.
2726
* - getData: A method to fetch the latest spectrogram data from the analyser.
28-
* - setFftSize: A method to update the size of the FFT.
2927
* - observe: A method to start observing and updating the spectrogram data.
3028
* - cancelObserve: A method to stop observing the spectrogram data.
3129
* - error: A boolean indicating whether an error has occurred.

0 commit comments

Comments
 (0)