Skip to content
Sonoscope
Search
Ctrl
K
Cancel
GitHub
Getting Started
Overview
Quick Start
Packages
@sonoscope/core
@sonoscope/react
sonoscope (Python/Jupyter)
Interactive Demos
Spectrogram
Waveform
Rulers
Audio Sources
React Components
Python Widget
Plugins
Overview & Showcase
ASCII Spectrogram
Halftone Shader
Terrain 3D Shader
Topographic Shader
API Reference
@sonoscope/core
Classes
ArrayAudioSource
BarsWaveformRenderer
BlobByteSource
BoxesFrequencyRulerRenderer
BoxesTimeRulerRenderer
BufferByteSource
CanvasSpectrogramRenderer
CanvasWaveformRenderer
ClippedAudioSource
DecodedAudioSource
FetchByteSource
FrameMeter
FrequencyRulerViewer
MainThreadComputeBackend
NormalSpectrogramProgram
PerformanceProfiler
PlayheadOverlay
Sonoscope
SpectrogramProfiler
SpectrogramViewer
StreamingMp3Source
StreamingWavSource
TicksFrequencyRulerRenderer
TicksTimeRulerRenderer
TimeRulerViewer
ViewportController
WasmComputeBackend
WasmWorkerComputeBackend
WaveformViewer
WebGL2ShaderProgram
WebGL2SpectrogramRenderer
WebGL2TileProgramBase
WebGL2WaveformRenderer
WorkerComputeBackend
Interfaces
AudioSource
AutoResizeOptions
BarsWaveformRendererOptions
DragNavigationOptions
FrequencyRulerRenderer
IDataViewer
IFrequencyRulerViewer
IPlayheadOverlay
ISonoscope
ISonoscopeViewer
ISpectrogramViewer
ITimeRulerViewer
IViewportController
IViewportViewer
IWaveformViewer
NavigableViewer
NavigationOptions
PlayheadOverlayOptions
SpectrogramComputeBackend
SpectrogramProfileEvent
SpectrogramProfilerOptions
SpectrogramProfileStats
SpectrogramRenderer
TimeRulerRenderer
WaveformRenderer
WheelNavigationOptions
Type Aliases
AudioRange
AutoRendererConfig
BackendMode
BarPeakBlock
BarsWaveformRendererConfig
BuiltInColorMap
CacheStats
Canvas2DRendererConfig
Canvas2DWaveformRendererConfig
ClipBounds
ClippedSourceEvents
ColorMapConfig
ColorPoint
ComputeTileRequest
CustomViewerFactory
FollowPlaybackMode
FrameStats
FrequencyBounds
FrequencyFormatMode
FrequencyRulerConfig
FrequencyRulerEvents
FrequencyRulerFrame
FrequencyRulerOptions
FrequencyRulerRendererName
FrequencyRulerRenderInput
FrequencyRulerStatus
FrequencyRulerViewport
FrequencyScale
FrequencyTicksResult
ModifierKey
NavigationAxis
PeakBlock
PerformanceDetail
PerformanceMeasure
RendererKind
RendererMode
RenderInput
ResolvedFrequencyRulerConfig
ResolvedSpectrogramConfig
ResolvedTimeRulerConfig
ResolvedWaveformConfig
Rgba
SonoscopeEvents
SonoscopeOptions
SpectrogramConfig
SpectrogramEvents
SpectrogramMatrix
SpectrogramOptions
SpectrogramRendererConfig
SpectrogramRendererFactory
SpectrogramStatus
SpectrogramTransform
SpectrumPoint
SpectrumSlice
StftConfig
TileState
TileStateInfo
TimeBounds
TimeFormatMode
TimeRulerConfig
TimeRulerEvents
TimeRulerFrame
TimeRulerOptions
TimeRulerRendererName
TimeRulerRenderInput
TimeRulerStatus
TimeRulerViewport
TimeTicksResult
TransformContext
ValueMode
ValueScaleConfig
ViewportConfig
ViewportConstraints
ViewportControllerOptions
ViewportEvents
ViewportState
WaveformConfig
WaveformEvents
WaveformOptions
WaveformRendererFactory
WaveformRendererKind
WaveformRendererMode
WaveformRenderInput
WaveformStatus
WaveformViewport
WebGL2Frame
WebGL2RenderProgram
WebGL2RenderResources
WebGL2SpectrogramProgramFactory
WebGL2WaveformRendererConfig
WebGLRendererConfig
WebGLRendererProgram
WebGLRendererProgramName
WindowName
Variables
WEBGL2_FRAGMENT_UNIFORMS
WEBGL2_OVERLAY_CHECK
WEBGL2_SCALE_HELPERS
Functions
attachAutoResize
attachDragNavigation
attachNavigation
attachPlayheadOverlay
attachWheelNavigation
buildColorMap
canvasToTimeFrequency
clampViewportTimes
clearRegisteredSpectrogramPrograms
clearRegisteredSpectrogramRenderers
clearRegisteredViewers
clearRegisteredWaveformRenderers
clipAudioSource
colorMapToRgb
computeFrequencyTicks
computeTimeTicks
createAudioSourceFromBlob
createAudioSourceFromBuffer
createAudioSourceFromUrl
createShaderProgram
createSpectrogramBackend
createSpectrogramProgram
createSpectrogramRenderer
createWaveformRenderer
encodeWavBlob
encodeWavBuffer
formatFrequencyLabel
formatTimeLabel
frequencyScaleCode
getRegisteredSpectrogramProgram
getRegisteredSpectrogramRenderer
getRegisteredViewer
getRegisteredWaveformRenderer
hasRegisteredSpectrogramProgram
hasRegisteredSpectrogramRenderer
hasRegisteredViewer
hasRegisteredWaveformRenderer
hzToMel
hzToScale
isSeekableByteSource
isSonoscope
isSpectrogramComputeBackend
isWasmSupported
isWorkerSupported
locateSamplePosition
melToHz
normalizeValue
panViewportFrequency
panViewportTime
parseColor
readPrefix
registerSpectrogramProgram
registerSpectrogramRenderer
registerViewer
registerWaveformRenderer
sampleValueDataPosition
scaleToHz
setViewerViewport
tileFrequencyRange
tileTimeRange
timeFrequencyToCanvas
unregisterSpectrogramProgram
unregisterSpectrogramRenderer
unregisterViewer
unregisterWaveformRenderer
valueDataForMode
zoomViewportFrequency
zoomViewportTime
@sonoscope/react
Interfaces
FrequencyRulerProps
TimeRulerProps
UseFrequencyRulerOptions
UseSonoscopeOptions
UseSonoscopeResult
UseTimeRulerOptions
WaveformProps
Type Aliases
FrequencyRulerHandle
SonoscopeProviderProps
SpectrogramHandle
SpectrogramProps
SpectrogramReadyInfo
TimeRulerHandle
UseSpectrogramOptions
UseSpectrogramResult
UseViewerOptions
UseViewerResult
ViewerHandle
ViewerProps
WaveformHandle
Variables
FrequencyRuler
SonoscopeContext
SonoscopeProvider
Spectrogram
TimeRuler
Viewer
Waveform
Functions
useFrequencyRuler
useSonoscope
useSonoscopeContext
useSpectrogram
useTimeRuler
useViewer
GitHub
Canvas2DRendererConfig
type
Canvas2DRendererConfig
=
object
;
Properties
Section titled “Properties”
Property
Type
type
"canvas2d"