@sonoscope/react
Interfaces
Section titled “Interfaces”| Interface | Description |
|---|---|
| FrequencyRulerProps | Props for the FrequencyRuler component. |
| TimeRulerProps | Props for the TimeRuler component. |
| UseFrequencyRulerOptions | - |
| UseSonoscopeOptions | Options for initializing a Sonoscope coordinator inside React. |
| UseSonoscopeResult | Result returned by the useSonoscope hook. |
| UseTimeRulerOptions | - |
| WaveformProps | Props for the Waveform component. |
Type Aliases
Section titled “Type Aliases”| Type Alias | Description |
|---|---|
| FrequencyRulerHandle | Imperative handle exposed by the FrequencyRuler component ref. |
| SonoscopeProviderProps | Props for the SonoscopeProvider component. Accepts either an existing Sonoscope instance as value or direct useSonoscope configuration options. |
| SpectrogramHandle | Imperative handle exposed by the Spectrogram component ref. |
| SpectrogramProps | Props for the Spectrogram component. |
| SpectrogramReadyInfo | - |
| TimeRulerHandle | Imperative handle exposed by the TimeRuler component ref. |
| UseSpectrogramOptions | - |
| UseSpectrogramResult | - |
| UseViewerOptions | - |
| UseViewerResult | - |
| ViewerHandle | - |
| ViewerProps | - |
| WaveformHandle | Imperative handle exposed by the Waveform component ref. |
Variables
Section titled “Variables”| Variable | Description |
|---|---|
| FrequencyRuler | Renders an interactive frequency axis ruler canvas. |
| SonoscopeContext | React context holding the active Sonoscope coordinator instance. |
| SonoscopeProvider | Provides a Sonoscope coordinator instance to child components. |
| Spectrogram | Renders an interactive audio spectrogram canvas. |
| TimeRuler | Renders an interactive time axis ruler canvas. |
| Viewer | - |
| Waveform | Renders an interactive audio waveform canvas. |
Functions
Section titled “Functions”| Function | Description |
|---|---|
| useFrequencyRuler | - |
| useSonoscope | React hook that creates and manages the lifecycle of a Sonoscope coordinator instance. |
| useSonoscopeContext | Returns the current Sonoscope coordinator from the nearest SonoscopeProvider. |
| useSpectrogram | - |
| useTimeRuler | - |
| useViewer | - |