References

summary
public	C CanvasEntry The `CanvasEntry` class represents an element consisting of a wave `canvas` and an (optional) progress wave `canvas`.
public	C Drawer Parent class for renderers
public	C MultiCanvas MultiCanvas renderer for wavesurfer.
public	C Init The HTML initialisation API is not part of the main library bundle file and must be additionally included.
public	C MediaElementWebAudio MediaElementWebAudio backend: load audio via an HTML5 audio tag, but playback with the WebAudio API.	since 3.2.0
public	C MediaElement MediaElement backend
public	C PeakCache Caches the decoded peaks data to improve rendering speed for large audio
public	C WaveSurfer WaveSurfer core library class
public	C WebAudio WebAudio backend
public	T InitParams: Object
public	T PluginDefinition: Object The Object used to describe a plugin
public	T SplitChannelOptions: Object parameters applied when splitChannels option is true	since 4.3.0
public	T WavesurferParams: Object
public	E AudioNode
public	E Blob
public	E CanvasRenderingContext2D
public	E File
public	E HTMLElement
public	E MediaStreamConstraints
public	E OfflineAudioContext

plugin/cursor

summary
public	C CursorPlugin Displays a thin line at the position of the cursor on the waveform.
public	T CursorPluginParams: Object

summary
public	C ElanPlugin Downloads and renders ELAN audio transcription documents alongside the waveform.
public	T ElanPluginParams: Object

summary
public	C MarkersPlugin
public	T MarkerParams: Object The parameters used to describe a marker.
public	T MarkersPluginParams: Object

summary
public	C MediaSessionPlugin Visualize MediaSession information for a wavesurfer instance.
public	T MediaSessionPluginParams: Object

summary
public	C MicrophonePlugin Visualize microphone input in a wavesurfer instance.
public	T MicrophonePluginParams: Object

summary
public	C MinimapPlugin Renders a smaller version waveform as a minimap of the main waveform.
public	T MinimapPluginParams: Object Extends the `WavesurferParams` wavesurfer was initialised with

summary
public	C PlayheadPlugin
public	T PlayheadPluginParams: Object

summary
public	C RegionsPlugin Regions are visual overlays on waveform that can be used to play and loop portions of audio.
public	T RegionParams: Object The parameters used to describe a region.
public	T RegionsPluginParams: Object	since 4.0.0 This class has been split

summary
public	C SpectrogramPlugin Render a spectrogram visualisation of the audio.
public	F FFT(bufferSize: Number, sampleRate: Number, windowFunc: Function, alpha: Number) Calculate FFT - Based on https://github.com/corbanbrook/dsp.js
public	T SpectrogramPluginParams: Object

summary
public	C TimelinePlugin Adds a timeline to the waveform.
public	T TimelinePluginParams: Object Extends the `WavesurferParams` wavesurfer was initialised with

summary
public	C Observer Observer class
public	F absMax(values: Array): Number Get the largest absolute value in an array	since 4.3.0
public	F clamp(val: number, min: number, max: number): number Returns a number limited to the given range.
public	F fetchFile(options: object): Observer Load a file using `fetch`.
public	F frame(func: function): func Create a function which will be called at the next requestAnimationFrame cycle
public	F getId(prefix: String): String Get a random prefixed ID
public	F max(values: Array): Number Get the largest value
public	F min(values: Array): Number Get the smallest value
public	F withOrientation(target: object, vertical: bool): Proxy Returns an appropriately oriented object based on vertical.	since 5.0.0
public	F preventClick(values: object) Starts listening for click event and prevent propagation
public	F ignoreSilenceMode() Ignores device silence mode when using the `WebAudio` backend.	since 5.2.0
public	F style(el: HTMLElement, styles: Object): HTMLElement Apply a map of styles to an element
public	T ListenerDescriptor: Object

Directories