Class WaveSurfer

Hierarchy

Player<WaveSurferEvents>
- WaveSurfer

Constructors

constructor

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

Properties

`Private` decodedData

decodedData: null | AudioBuffer = null

`Private` duration

duration: null | number = null

`Protected` media

media: HTMLMediaElement

options

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

Type declaration

autoCenter: boolean
autoScroll: boolean
cursorWidth: number
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

Methods

destroy

destroy(): void
Unmount wavesurfer

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

`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:69

empty

empty(): void
Empty the waveform by loading a tiny silent audio

Returns void
- Defined in wavesurfer.ts:378

getActivePlugins

getActivePlugins(): GenericPlugin[]
Get all registered plugins

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

getCurrentTime

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

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

getDecodedData

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

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

getDuration

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

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

getMediaElement

getMediaElement(): HTMLMediaElement
Get the HTML media element

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

getMuted

getMuted(): boolean
Get the audio muted state

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

getPlaybackRate

getPlaybackRate(): number
Get the playback speed

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

getScroll

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

Returns number
- Defined in wavesurfer.ts:274

getVolume

getVolume(): number
Get the audio volume

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

getWrapper

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

Returns HTMLElement
- Defined in wavesurfer.ts:269

`Private` initPlayerEvents

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

`Private` initPlugins

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

`Private` initRendererEvents

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

`Private` initTimerEvents

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

isPlaying

isPlaying(): boolean
Check if the audio is playing

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

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:284

on

on<EventName>(eventName, listener): (() => void)
Subscribe to an event. Returns an unsubscribe function.
Type Parameters
- EventName extends keyof WaveSurferEvents
Parameters
- eventName: EventName
- listener: EventListener<WaveSurferEvents, EventName>
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(event, callback, options?): (() => void)
Parameters
- event: keyof HTMLMediaElementEventMap
- callback: (() => void)
  - - (): void
    - Returns void
- Optional options: AddEventListenerOptions
Returns (() => void)
- - (): void
  - Returns void
Inherited from Player.onMediaEvent
- Defined in player.ts:31

once

once<EventName>(eventName, listener): (() => void)
Subscribe to an event only once
Type Parameters
- EventName extends keyof WaveSurferEvents
Parameters
- eventName: 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:33

`Protected` onceMediaEvent

onceMediaEvent(event, callback): (() => void)
Parameters
- event: keyof HTMLMediaElementEventMap
- callback: (() => void)
  - - (): void
    - Returns void
Returns (() => void)
- - (): void
  - Returns void
Inherited from Player.onceMediaEvent
- Defined in player.ts:40

pause

pause(): void
Pause the audio

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

play

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

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

playPause

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

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

registerPlugin

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

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:356

setMuted

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

setOptions

setOptions(options): void
Parameters
- options: Partial<WaveSurferOptions>
Returns void
- Defined in wavesurfer.ts:155

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:128

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:142

`Protected` setSrc

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

setTime

setTime(time): void
Jumpt to a specific time in the audio (in seconds)
Parameters
- time: number
Returns void
Inherited from Player.setTime
- Defined in player.ts:88

setVolume

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

skip

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

stop

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

Returns void
- Defined in wavesurfer.ts:367

toggleInteraction

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

un

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

unAll

unAll(): void
Clear all events

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

zoom

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

`Static` create

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

Class WaveSurfer

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: WaveSurferOptions

Returns WaveSurfer

Properties

Private decodedData

Private duration

Protected media

options

Type declaration

autoCenter: boolean

autoScroll: boolean

cursorWidth: number

fillParent: boolean

interact: boolean

minPxPerSec: number

progressColor: string

sampleRate: number

waveColor: string

Private plugins

Private renderer

Protected subscriptions

Type declaration

Returns void

Private timer

Methods

destroy

Returns void

Protected emit

Type Parameters

EventName extends keyof WaveSurferEvents

Parameters

eventName: EventName

Rest ...args: WaveSurferEvents[EventName]

Returns void

empty

Returns void

getActivePlugins

Returns GenericPlugin[]

getCurrentTime

Returns number

getDecodedData

Returns null | AudioBuffer

getDuration

Returns number

getMediaElement

Returns HTMLMediaElement

getMuted

Returns boolean

getPlaybackRate

Returns number

getScroll

Returns number

getVolume

Returns number

getWrapper

Returns HTMLElement

Private initPlayerEvents

Returns void

Private initPlugins

Returns void

Private initRendererEvents

Returns void

Private initTimerEvents

Returns void

isPlaying

Returns boolean

load

Parameters

url: string

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

Optional duration: number

Returns Promise<void>

`Private` decodedData

`Private` duration

`Protected` media

`Private` plugins

`Private` renderer

`Protected` subscriptions

`Private` timer

`Protected` emit

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

`Private` initPlayerEvents

`Private` initPlugins

`Private` initRendererEvents

`Private` initTimerEvents

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

`Optional` duration: number

`Protected` onMediaEvent

`Optional` options: AddEventListenerOptions

`Protected` onceMediaEvent

`Optional` preservePitch: boolean

`Protected` setSrc

`Optional` blob: Blob