Class default

Hierarchy

Player<WaveSurferEvents>
- default

Constructors

constructor

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

Properties

`Protected` abortController

abortController: null | AbortController = null

`Private` decodedData

decodedData: null | AudioBuffer = null

`Protected` media

media: HTMLMediaElement

`Protected` mediaSubscriptions

mediaSubscriptions: (() => void)[] = []

Type declaration

- (): void
- Returns void

options

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

Type declaration

autoCenter: boolean
autoScroll: boolean
cursorWidth: number
dragToSeek: boolean
fillParent: boolean
interact: boolean
minPxPerSec: number
progressColor: string
sampleRate: number
waveColor: string

`Private` plugins

plugins: GenericPlugin[] = []

`Private` renderer

renderer: Renderer

`Protected` subscriptions

subscriptions: (() => void)[] = []

Type declaration

- (): void
- Returns void

`Private` timer

timer: Timer

`Static` `Readonly` BasePlugin

BasePlugin: typeof BasePlugin = BasePlugin

`Static` `Readonly` dom

dom: __module = dom

Methods

destroy

destroy(): void
Unmount wavesurfer

Returns void
Overrides Player.destroy
- Defined in wavesurfer.ts:600

`Protected` emit

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

empty

empty(): void
Empty the waveform

Returns void
- Defined in wavesurfer.ts:570

exportImage

exportImage(format, quality, type): 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:589
exportImage(format, quality, type): Promise<Blob[]>
Parameters
- format: string
- quality: number
- type: "blob"
Returns Promise<Blob[]>
- Defined in wavesurfer.ts:590

exportPeaks

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

getActivePlugins

getActivePlugins(): GenericPlugin[]
Get all registered plugins

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

getCurrentTime

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

Returns number
Inherited from Player.getCurrentTime
- Defined in player.ts:123

getDecodedData

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

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

getDuration

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

Returns number
Overrides Player.getDuration
- Defined in wavesurfer.ts:526

getMediaElement

getMediaElement(): HTMLMediaElement
Get the HTML media element

Returns HTMLMediaElement
Inherited from Player.getMediaElement
- Defined in player.ts:167

getMuted

getMuted(): boolean
Get the audio muted state

Returns boolean
Inherited from Player.getMuted
- Defined in player.ts:138

getPlaybackRate

getPlaybackRate(): number
Get the playback speed

Returns number
Inherited from Player.getPlaybackRate
- Defined in player.ts:148

getScroll

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

Returns number
- Defined in wavesurfer.ts:389

`Protected` getSrc

getSrc(): string
Returns string
Inherited from Player.getSrc
- Defined in player.ts:55

getVolume

getVolume(): number
Get the audio volume

Returns number
Inherited from Player.getVolume
- Defined in player.ts:128

getWidth

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

Returns number
- Defined in wavesurfer.ts:384

getWrapper

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

Returns HTMLElement
- Defined in wavesurfer.ts:379

`Private` initPlayerEvents

initPlayerEvents(): void
Returns void
- Defined in wavesurfer.ts:221

`Private` initPlugins

initPlugins(): void
Returns void
- Defined in wavesurfer.ts:337

`Private` initRendererEvents

initRendererEvents(): void
Returns void
- Defined in wavesurfer.ts:261

`Private` initTimerEvents

initTimerEvents(): void
Returns void
- Defined in wavesurfer.ts:208

isPlaying

isPlaying(): boolean
Check if the audio is playing

Returns boolean
Inherited from Player.isPlaying
- Defined in player.ts:108

isSeeking

isSeeking(): boolean
Check if the audio is seeking

Returns boolean
Inherited from Player.isSeeking
- Defined in player.ts:153

load

load(url, channelData?, duration?): Promise<void>
Load an audio file by URL, with optional pre-decoded audio data
Parameters
- url: string
- Optional channelData: (Float32Array | number[])[]
- Optional duration: number
Returns Promise<void>
- Defined in wavesurfer.ts:467

`Private` loadAudio

loadAudio(url, blob?, channelData?, duration?): Promise<void>
Parameters
- url: string
- Optional blob: Blob
- Optional channelData: (Float32Array | number[])[]
- Optional duration: number
Returns Promise<void>
- Defined in wavesurfer.ts:409

loadBlob

loadBlob(blob, channelData?, duration?): Promise<void>
Load an audio blob
Parameters
- blob: Blob
- Optional channelData: (Float32Array | number[])[]
- Optional duration: number
Returns Promise<void>
- Defined in wavesurfer.ts:477

on

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

`Protected` onMediaEvent

onMediaEvent<K>(event, callback, options?): (() => void)
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- event: K
- callback: ((ev) => void)
  - - (ev): void
    - Parameters
      
      ev: HTMLElementEventMap[K]
      
      Returns void
- Optional options: boolean | AddEventListenerOptions
Returns (() => void)
- - (): void
  - Returns void
Inherited from Player.onMediaEvent
- Defined in player.ts:46

once

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

pause

pause(): void
Pause the audio

Returns void
Inherited from Player.pause
- Defined in player.ts:103

play

play(): Promise<void>
Start playing the audio

Returns Promise<void>
Inherited from Player.play
- Defined in player.ts:98

playPause

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

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

registerPlugin

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

seekTo

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

setMediaElement

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

setMuted

setMuted(muted): void
Mute or unmute the audio
Parameters
- muted: boolean
Returns void
Inherited from Player.setMuted
- Defined in player.ts:143

setOptions

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

setPlaybackRate

setPlaybackRate(rate, preservePitch?): void
Set the playback speed, pass an optional false to NOT preserve the pitch
Parameters
- rate: number
- Optional preservePitch: boolean
Returns void
Inherited from Player.setPlaybackRate
- Defined in player.ts:158

setScroll

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

setScrollTime

setScrollTime(time): 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:399

setSinkId

setSinkId(sinkId): Promise<void>
Set a sink id to change the audio output device
Parameters
- sinkId: string
Returns Promise<void>
Inherited from Player.setSinkId
- Defined in player.ts:172

`Protected` setSrc

setSrc(url, blob?): void
Parameters
- url: string
- Optional blob: Blob
Returns void
Inherited from Player.setSrc
- Defined in player.ts:70

setTime

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

setVolume

setVolume(volume): void
Set the audio volume
Parameters
- volume: number
Returns void
Inherited from Player.setVolume
- Defined in player.ts:133

skip

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

stop

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

Returns void
- Defined in wavesurfer.ts:559

toggleInteraction

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

un

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

unAll

unAll(): void
Clear all events

Returns void
Inherited from Player.unAll
- Defined in event-emitter.ts:59

`Private` unsubscribePlayerEvents

unsubscribePlayerEvents(): void
Returns void
- Defined in wavesurfer.ts:345

`Private` updateProgress

updateProgress(currentTime?): number
Parameters
- currentTime: number = ...
Returns number
- Defined in wavesurfer.ts:203

zoom

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

`Static` create

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

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: WaveSurferOptions

Returns default

Properties

Protected abortController

Private decodedData

Protected media

Protected mediaSubscriptions

Type declaration

Returns void

options

Type declaration

autoCenter: boolean

autoScroll: boolean

cursorWidth: number

dragToSeek: boolean

fillParent: boolean

interact: boolean

minPxPerSec: number

progressColor: string

sampleRate: number

waveColor: string

Private plugins

Private renderer

Protected subscriptions

Type declaration

Returns void

Private timer

Static Readonly BasePlugin

Static Readonly dom

Methods

destroy

Returns void

Protected emit

Type Parameters

EventName extends keyof WaveSurferEvents

Parameters

eventName: EventName

Rest ...args: WaveSurferEvents[EventName]

Returns void

empty

Returns void

exportImage

Parameters

format: string

quality: number

type: "dataURL"

Returns Promise<string[]>

Parameters

format: string

quality: number

type: "blob"

Returns Promise<Blob[]>

exportPeaks

Parameters

__namedParameters: { channels: undefined | number; maxLength: undefined | number; precision: undefined | number; } = {}

channels: undefined | number

maxLength: undefined | number

precision: undefined | number

Returns number[][]

getActivePlugins

Returns GenericPlugin[]

getCurrentTime

Returns number

getDecodedData

Returns null | AudioBuffer

getDuration

Returns number

getMediaElement

Returns HTMLMediaElement

getMuted

Returns boolean

`Protected` abortController

`Private` decodedData

`Protected` media

`Protected` mediaSubscriptions

`Private` plugins

`Private` renderer

`Protected` subscriptions

`Private` timer

`Static` `Readonly` BasePlugin

`Static` `Readonly` dom

`Protected` emit

`Rest` ...args: WaveSurferEvents[EventName]

__namedParameters: {
channels: undefined | number;
maxLength: undefined | number;
precision: undefined | number;
} = {}

`Protected` getSrc

`Private` initPlayerEvents

`Private` initPlugins

`Private` initRendererEvents

`Private` initTimerEvents

`Optional` channelData: (Float32Array | number[])[]

`Optional` duration: number

`Private` loadAudio

`Optional` blob: Blob

`Optional` channelData: (Float32Array | number[])[]

`Optional` duration: number

`Optional` channelData: (Float32Array | number[])[]

`Optional` duration: number

`Optional` options: {
once?: boolean;
}

`Optional` once?: boolean

`Protected` onMediaEvent

`Optional` options: boolean | AddEventListenerOptions