Class default

Hierarchy

EventEmitter<WaveSurferEvents>
- default

Constructors

constructor

new default(options: WaveSurferOptions): default
Create a new WaveSurfer instance
Parameters
- options: WaveSurferOptions
Returns default
Overrides EventEmitter<WaveSurferEvents>.constructor
- Defined in wavesurfer.ts:220

Properties

options

options: WaveSurferOptions & {
    autoCenter: boolean;
    autoScroll: boolean;
    cursorWidth: number;
    dragToSeek: boolean;
    fillParent: boolean;
    interact: boolean;
    minPxPerSec: number;
    progressColor: string;
    sampleRate: number;
    waveColor: string;
}

`Protected`scope

scope: Scope = ...

`Static` `Readonly`BasePlugin

BasePlugin: typeof BasePlugin = BasePlugin

`Static` `Readonly`definePlugin

definePlugin: <Options, Events extends BasePluginEvents, Api extends object>(
name: string,
setup: PluginSetup<Options, Events, Api>,
) => DefinedPlugin<Options, Events, Api> = definePlugin

Type Declaration

- <Options, Events extends BasePluginEvents, Api extends object>(
  name: string,
  setup: PluginSetup<Options, Events, Api>,
  ): DefinedPlugin<Options, Events, Api>
- Define a functional wavesurfer plugin from a setup function.
  
  setup runs once per (re-)init on a fresh Scope; whatever it returns is merged onto the plugin instance as its public API. Resources registered via ctx.scope.add(...) are torn down when the plugin is destroyed.
  
  Api methods only exist on the instance after _init() has run (i.e. after wavesurfer.registerPlugin(...)); accessing them beforehand is undefined behavior. Symmetrically: calling an api method AFTER the plugin has been destroyed is also undefined behavior — ctx.wavesurfer is typed non-null, but destroy() sets the underlying field to undefined, so a post-destroy read returns undefined at runtime despite the type.
  
  new Plugin(options) / Plugin.create(options): the options argument is optional when (and only when) Options has no required properties (see PluginCtorArgs below) — same ergonomics a hand-written constructor(options?: Options) would give. When it's omitted, setup is called with options === undefined, not {}; a setup for an all-optional Options type must default it itself (e.g. Object.assign({}, defaultOptions, options)), exactly as it already had to for any individually-omitted field.
  Type Parameters
  - Options
  - Events extends BasePluginEvents
  - Api extends object
  Parameters
  - name: string
  - setup: PluginSetup<Options, Events, Api>
  Returns DefinedPlugin<Options, Events, Api>

`Static` `Readonly`dom

dom: __module = dom

Methods

destroy

destroy(): void
Unmount wavesurfer. Terminal: the instance is not usable afterwards -- load()/loadBlob() reject, registerPlugin() throws, and everything else is a safe no-op. Create a new instance instead of reusing a destroyed one.

Returns void
- Defined in wavesurfer.ts:1090

`Protected`emit

emit<EventName extends keyof WaveSurferEvents>(
eventName: EventName,
...args: WaveSurferEvents[EventName],
): void
Emit an event
Type Parameters
- EventName extends keyof WaveSurferEvents
Parameters
- eventName: EventName
- ...args: WaveSurferEvents[EventName]
Returns void
Inherited from EventEmitter.emit
- Defined in event-emitter.ts:65

empty

empty(): void
Empty the waveform

Returns void
- Defined in wavesurfer.ts:1052

exportImage

exportImage(format: string, quality: number, type: "dataURL"): Promise<string[]>
Export the waveform image as a data-URI or a blob.
Parameters
- format: string
  The format of the exported image, can be image/png, image/jpeg, image/webp or any other format supported by the browser.
- quality: number
  The quality of the exported image, for image/jpeg or image/webp. Must be between 0 and 1.
- type: "dataURL"
  The type of the exported image, can be dataURL (default) or blob.
Returns Promise<string[]>
A promise that resolves with an array of data-URLs or blobs, one for each canvas element.
- Defined in wavesurfer.ts:1075
exportImage(format: string, quality: number, type: "blob"): Promise<Blob[]>
Export the waveform image as a data-URI or a blob.
Parameters
- format: string
  The format of the exported image, can be image/png, image/jpeg, image/webp or any other format supported by the browser.
- quality: number
  The quality of the exported image, for image/jpeg or image/webp. Must be between 0 and 1.
- type: "blob"
  The type of the exported image, can be dataURL (default) or blob.
Returns Promise<Blob[]>
A promise that resolves with an array of data-URLs or blobs, one for each canvas element.
- Defined in wavesurfer.ts:1076

exportPeaks

exportPeaks(
    __namedParameters?: {
        channels?: number;
        maxLength?: number;
        precision?: number;
    },
): number[][]
Get decoded peaks
Parameters
- __namedParameters: { channels?: number; maxLength?: number; precision?: number } = {}
Returns number[][]
- Defined in wavesurfer.ts:884

getActivePlugins

getActivePlugins(): GenericPlugin[]
Get all registered plugins

Returns GenericPlugin[]
- Defined in wavesurfer.ts:606

getCurrentTime

getCurrentTime(): number
Get the current audio position in seconds

Returns number
- Defined in wavesurfer.ts:955

getDecodedData

getDecodedData(): AudioBuffer | null
Get the decoded audio data

Returns AudioBuffer | null
- Defined in wavesurfer.ts:879

getDuration

getDuration(): number
Get the duration of the audio in seconds

Returns number
- Defined in wavesurfer.ts:909

getMediaElement

getMediaElement(): HTMLMediaElement | null
Get the HTML media element.

Returns null under the WebAudio backend (i.e. when the current media is a WebAudioPlayer -- either backend: 'WebAudio' or a user-supplied WebAudioPlayer), which has no HTML media element. Breaking change in v8: previously the WebAudioPlayer itself was returned, mistyped as an HTMLMediaElement.

Returns HTMLMediaElement | null
- Defined in wavesurfer.ts:1007

getMuted

getMuted(): boolean
Get the audio muted state

Returns boolean
- Defined in wavesurfer.ts:971

getPlaybackRate

getPlaybackRate(): number
Get the playback speed

Returns number
- Defined in wavesurfer.ts:982

getRenderer

getRenderer(): Renderer
Get the renderer instance for plugin access to reactive streams

Returns Renderer
- Defined in wavesurfer.ts:215

getScroll

getScroll(): number
Get the current scroll position in pixels

Returns number
- Defined in wavesurfer.ts:589

getState

getState(): WaveSurferState
Get the reactive state for advanced use cases

Returns WaveSurferState
- Defined in wavesurfer.ts:210

getVolume

getVolume(): number
Get the audio volume

Returns number
- Defined in wavesurfer.ts:960

getWidth

getWidth(): number
For plugins only: get the scroll container client width

Returns number
- Defined in wavesurfer.ts:584

getWrapper

getWrapper(): HTMLElement
For plugins only: get the waveform wrapper div

Returns HTMLElement
- Defined in wavesurfer.ts:579

isPlaying

isPlaying(): boolean
Check if the audio is playing

Returns boolean
- Defined in wavesurfer.ts:945

isSeeking

isSeeking(): boolean
Check if the audio is seeking

Returns boolean
- Defined in wavesurfer.ts:950

load

load(
    url: string,
    channelData?: (Float32Array<ArrayBufferLike> | number[])[],
    duration?: number,
): Promise<void>
Load an audio file by URL, with optional pre-decoded audio data. If a newer load()/loadBlob() supersedes this call before it completes, the returned promise rejects with an AbortError DOMException (and no 'error' event is emitted for it).
Parameters
- url: string
- OptionalchannelData: (Float32Array<ArrayBufferLike> | number[])[]
- Optionalduration: number
Returns Promise<void>
- Defined in wavesurfer.ts:854

loadBlob

loadBlob(
    blob: Blob,
    channelData?: (Float32Array<ArrayBufferLike> | number[])[],
    duration?: number,
): Promise<void>
Load an audio blob. If a newer load()/loadBlob() supersedes this call before it completes, the returned promise rejects with an AbortError DOMException (and no 'error' event is emitted for it).
Parameters
- blob: Blob
- OptionalchannelData: (Float32Array<ArrayBufferLike> | number[])[]
- Optionalduration: number
Returns Promise<void>
- Defined in wavesurfer.ts:864

on

on<EventName extends keyof WaveSurferEvents>(
    event: EventName,
    listener: EventListener<WaveSurferEvents, EventName>,
    options?: { once?: boolean },
): () => void
Subscribe to an event. Returns an unsubscribe function.
Type Parameters
- EventName extends keyof WaveSurferEvents
Parameters
- event: EventName
- listener: EventListener<WaveSurferEvents, EventName>
- Optionaloptions: { once?: boolean }
Returns () => void
Inherited from EventEmitter.on
- Defined in event-emitter.ts:20

once

once<EventName extends keyof WaveSurferEvents>(
event: EventName,
listener: EventListener<WaveSurferEvents, EventName>,
): () => void
Subscribe to an event only once
Type Parameters
- EventName extends keyof WaveSurferEvents
Parameters
- event: EventName
- listener: EventListener<WaveSurferEvents, EventName>
Returns () => void
Inherited from EventEmitter.once
- Defined in event-emitter.ts:52

pause

pause(): void
Pause the audio

Returns void
- Defined in wavesurfer.ts:939

play

play(start?: number, end?: number): Promise<void>
Start playing the audio
Parameters
- Optionalstart: number
- Optionalend: number
Returns Promise<void>
- Defined in wavesurfer.ts:1014

playPause

playPause(): Promise<void>
Play or pause the audio

Returns Promise<void>
- Defined in wavesurfer.ts:1036

registerPlugin

registerPlugin<T extends GenericPlugin>(plugin: T): T
Register a wavesurfer.js plugin
Type Parameters
- T extends GenericPlugin
Parameters
- plugin: T
Returns T
- Defined in wavesurfer.ts:548

seekTo

seekTo(progress: number): void
Seek to a ratio of audio as [0..1] (0 = beginning, 1 = end)
Parameters
- progress: number
Returns void
- Defined in wavesurfer.ts:933

setMediaElement

setMediaElement(element: HTMLMediaElement): void
Set HTML media element
Parameters
- element: HTMLMediaElement
Returns void
- Defined in wavesurfer.ts:1058

setMuted

setMuted(muted: boolean): void
Mute or unmute the audio
Parameters
- muted: boolean
Returns void
- Defined in wavesurfer.ts:976

setOptions

setOptions(options: Partial<WaveSurferOptions>): void
Set new wavesurfer options and re-render it
Parameters
- options: Partial<WaveSurferOptions>
Returns void
- Defined in wavesurfer.ts:523

setPlaybackRate

setPlaybackRate(rate: number, preservePitch?: boolean): void
Set the playback speed, pass an optional false to NOT preserve the pitch
Parameters
- rate: number
- OptionalpreservePitch: boolean
Returns void
- Defined in wavesurfer.ts:987

setScroll

setScroll(pixels: number): void
Set the current scroll position in pixels
Parameters
- pixels: number
Returns void
- Defined in wavesurfer.ts:594

setScrollTime

setScrollTime(time: number): void
Move the start of the viewing window to a specific time in the audio (in seconds)
Parameters
- time: number
Returns void
- Defined in wavesurfer.ts:600

setSinkId

setSinkId(sinkId: string): Promise<void>
Set a sink id to change the audio output device
Parameters
- sinkId: string
Returns Promise<void>
- Defined in wavesurfer.ts:993

setTime

setTime(time: number): void
Jump to a specific time in the audio (in seconds)
Parameters
- time: number
Returns void
- Defined in wavesurfer.ts:924

setVolume

setVolume(volume: number): void
Set the audio volume
Parameters
- volume: number
Returns void
- Defined in wavesurfer.ts:965

skip

skip(seconds: number): void
Skip N or -N seconds from the current position
Parameters
- seconds: number
Returns void
- Defined in wavesurfer.ts:1047

stop

stop(): void
Stop the audio and go to the beginning

Returns void
- Defined in wavesurfer.ts:1041

toggleInteraction

toggleInteraction(isInteractive: boolean): void
Toggle if the waveform should react to clicks
Parameters
- isInteractive: boolean
Returns void
- Defined in wavesurfer.ts:919

un

un<EventName extends keyof WaveSurferEvents>(
event: EventName,
listener: EventListener<WaveSurferEvents, EventName>,
): void
Unsubscribe from an event
Type Parameters
- EventName extends keyof WaveSurferEvents
Parameters
- event: EventName
- listener: EventListener<WaveSurferEvents, EventName>
Returns void
Inherited from EventEmitter.un
- Defined in event-emitter.ts:44

unAll

unAll(): void
Clear all events

Returns void
Inherited from EventEmitter.unAll
- Defined in event-emitter.ts:60

unregisterPlugin

unregisterPlugin(plugin: GenericPlugin): void
Unregister a wavesurfer.js plugin
Parameters
- plugin: GenericPlugin
Returns void
- Defined in wavesurfer.ts:573

zoom

zoom(minPxPerSec: number): void
Zoom the waveform by a given pixels-per-second factor
Parameters
- minPxPerSec: number
Returns void
- Defined in wavesurfer.ts:869

`Static`create

create(options: WaveSurferOptions): default
Create a new WaveSurfer instance
Parameters
- options: WaveSurferOptions
Returns default
- Defined in wavesurfer.ts:205

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

options

Protectedscope

Static ReadonlyBasePlugin

Static ReadonlydefinePlugin

Type Declaration

Type Parameters

Parameters

Returns DefinedPlugin<Options, Events, Api>

Static Readonlydom

Methods

destroy

Returns void

Protectedemit

Type Parameters

Parameters

Returns void

empty

Returns void

exportImage

Parameters

Returns Promise<string[]>

Parameters

Returns Promise<Blob[]>

exportPeaks

Parameters

Returns number[][]

getActivePlugins

Returns GenericPlugin[]

getCurrentTime

Returns number

getDecodedData

Returns AudioBuffer | null

getDuration

Returns number

getMediaElement

Returns HTMLMediaElement | null

getMuted

Returns boolean

getPlaybackRate

Returns number

getRenderer

Returns Renderer

getScroll

Returns number

getState

Returns WaveSurferState

getVolume

Returns number

getWidth

Returns number

getWrapper

Returns HTMLElement

isPlaying

Returns boolean

isSeeking

Returns boolean

load

Parameters

Returns Promise<void>

loadBlob

Parameters

Returns Promise<void>

on

Type Parameters

Parameters

Returns () => void

once

Type Parameters

Parameters

`Protected`scope

`Static` `Readonly`BasePlugin

`Static` `Readonly`definePlugin

`Static` `Readonly`dom

`Protected`emit

`Static`create