Home Reference Source

References

summary
public

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

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

MediaElementWebAudio backend: load audio via an HTML5 audio tag, but playback with the WebAudio API.

since 3.2.0
public

MediaElement backend

public

Caches the decoded peaks data to improve rendering speed for large audio

public

WaveSurfer core library class

public

WebAudio backend

public
public

The Object used to describe a plugin

public

parameters applied when splitChannels option is true

since 4.3.0
public
public
public

E Blob

public
public

E File

public
public
public

plugin/cursor

summary
public

Displays a thin line at the position of the cursor on the waveform.

public

plugin/elan

summary
public

Downloads and renders ELAN audio transcription documents alongside the waveform.

public

plugin/markers

summary
public
public

The parameters used to describe a marker.

public

plugin/mediasession

summary
public

Visualize MediaSession information for a wavesurfer instance.

public

plugin/microphone

summary
public

Visualize microphone input in a wavesurfer instance.

public

plugin/minimap

summary
public

Renders a smaller version waveform as a minimap of the main waveform.

public

Extends the WavesurferParams wavesurfer was initialised with

plugin/playhead

summary
public
public

plugin/regions

summary
public

Regions are visual overlays on waveform that can be used to play and loop portions of audio.

public

The parameters used to describe a region.

public
since 4.0.0 This class has been split

plugin/spectrogram

summary
public

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

plugin/timeline

summary
public

Adds a timeline to the waveform.

public

Extends the WavesurferParams wavesurfer was initialised with

util

summary
public

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

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