Class default

Hierarchy

EventEmitter<MultitrackEvents>
- default

Constructors

constructor

new default(tracks, options): default
Parameters
- tracks: MultitrackTracks
- options: MultitrackOptions
Returns default
Overrides EventEmitter<MultitrackEvents>.constructor
- Defined in src/multitrack.ts:102

Properties

`Private` audioContext

audioContext: AudioContext

`Private` audios

audios: (WebAudioPlayer | HTMLAudioElement)[] = []

`Private` currentTime

currentTime: number = 0

`Private` durations

durations: number[] = []

`Private` envelopes

envelopes: EnvelopePlugin[] = []

`Private` frameRequest

frameRequest: null | number = null

`Private` maxDuration

maxDuration: number = 0

`Private` options

options: MultitrackOptions

`Private` rendering

rendering: {
    addClickHandler: ((onClick) => void);
    addDropHandler: ((onDrop) => void);
    containers: HTMLDivElement[];
    destroy: (() => void);
    setContainerOffsets: (() => void);
    setMainWidth: ((trackDurations, maxDuration) => void);
    updateCursor: ((position, autoCenter) => void);
}

Type declaration

addClickHandler: ((onClick) => void)
- - (onClick): void
  - Parameters
    - onClick: ((position) => void)
      
      (position): void
      
      Parameters
      
      position: number
      
      Returns void
    Returns void
addDropHandler: ((onDrop) => void)
- - (onDrop): void
  - Parameters
    - onDrop: ((trackId) => void)
      
      (trackId): void
      
      Parameters
      
      trackId: TrackId
      
      Returns void
    Returns void
containers: HTMLDivElement[]
destroy: (() => void)
- - (): void
  - Returns void
setContainerOffsets: (() => void)
- - (): void
  - Returns void
setMainWidth: ((trackDurations, maxDuration) => void)
- - (trackDurations, maxDuration): void
  - Parameters
    - trackDurations: number[]
    - maxDuration: number
    Returns void
updateCursor: ((position, autoCenter) => void)
- - (position, autoCenter): void
  - Parameters
    - position: number
    - autoCenter: boolean
    Returns void

`Private` subscriptions

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

Type declaration

- (): void
- Returns void

`Private` tracks

tracks: MultitrackTracks

`Private` wavesurfers

wavesurfers: WaveSurfer[] = []

Methods

addTrack

addTrack(track): void
Parameters
- track: TrackOptions
Returns void
- Defined in src/multitrack.ts:525

destroy

destroy(): void
Returns void
- Defined in src/multitrack.ts:553

`Protected` emit

emit<EventName>(eventName, ...args): void
Emit an event
Type Parameters
- EventName extends keyof MultitrackEvents
Parameters
- eventName: EventName
- Rest ...args: MultitrackEvents[EventName]
Returns void
Inherited from EventEmitter.emit
- Defined in node_modules/wavesurfer.js/dist/event-emitter.d.ts:19

`Private` findCurrentTracks

findCurrentTracks(): number[]
Returns number[]
- Defined in src/multitrack.ts:438

getCurrentTime

getCurrentTime(): number
Returns number
- Defined in src/multitrack.ts:500

getEnvelopePoints

getEnvelopePoints(trackIndex): undefined | EnvelopePoint[]
Parameters
- trackIndex: number
Returns undefined | EnvelopePoint[]
- Defined in src/multitrack.ts:577

`Private` initAllAudios

initAllAudios(): Promise<number[]>
Returns Promise<number[]>
- Defined in src/multitrack.ts:181

`Private` initAllWavesurfers

initAllWavesurfers(): void
Returns void
- Defined in src/multitrack.ts:380

`Private` initAudio

initAudio(track): Promise<WebAudioPlayer | HTMLAudioElement>
Parameters
- track: TrackOptions
Returns Promise<WebAudioPlayer | HTMLAudioElement>
- Defined in src/multitrack.ts:161

`Private` initDurations

initDurations(durations): void
Parameters
- durations: number[]
Returns void
- Defined in src/multitrack.ts:144

`Private` initWavesurfer

initWavesurfer(track, index): WaveSurfer
Parameters
- track: TrackOptions
- index: number
Returns WaveSurfer
- Defined in src/multitrack.ts:186

isPlaying

isPlaying(): boolean
Returns boolean
- Defined in src/multitrack.ts:496

on

on<EventName>(event, listener, options?): (() => void)
Subscribe to an event. Returns an unsubscribe function.
Type Parameters
- EventName extends keyof MultitrackEvents
Parameters
- event: EventName
- listener: EventListener<MultitrackEvents, EventName>
- Optional options: {
  once?: boolean;
  }
  - Optional once?: boolean
Returns (() => void)
- - (): void
  - Subscribe to an event. Returns an unsubscribe function.
    
    Returns void
Inherited from EventEmitter.on
- Defined in node_modules/wavesurfer.js/dist/event-emitter.d.ts:9

`Private` onDrag

onDrag(index, delta): void
Parameters
- index: number
- delta: number
Returns void
- Defined in src/multitrack.ts:421

once

once<EventName>(event, listener): (() => void)
Subscribe to an event only once
Type Parameters
- EventName extends keyof MultitrackEvents
Parameters
- event: EventName
- listener: EventListener<MultitrackEvents, EventName>
Returns (() => void)
- - (): void
  - Subscribe to an event only once
    
    Returns void
Inherited from EventEmitter.once
- Defined in node_modules/wavesurfer.js/dist/event-emitter.d.ts:15

pause

pause(): void
Returns void
- Defined in src/multitrack.ts:492

play

play(): void
Returns void
- Defined in src/multitrack.ts:479

seekTo

seekTo(position): void
Position percentage from 0 to 1
Parameters
- position: number
Returns void
- Defined in src/multitrack.ts:505

setEnvelopePoints

setEnvelopePoints(trackIndex, points): void
Parameters
- trackIndex: number
- points: EnvelopePoint[]
Returns void
- Defined in src/multitrack.ts:581

setSinkId

setSinkId(sinkId): Promise<void[]>
Parameters
- sinkId: string
Returns Promise<void[]>
- Defined in src/multitrack.ts:569

setTime

setTime(time): void
Set time in seconds
Parameters
- time: number
Returns void
- Defined in src/multitrack.ts:512

setTrackVolume

setTrackVolume(index, volume): void
Parameters
- index: number
- volume: number
Returns void
- Defined in src/multitrack.ts:573

`Private` startSync

startSync(): void
Returns void
- Defined in src/multitrack.ts:460

un

un<EventName>(event, listener): void
Unsubscribe from an event
Type Parameters
- EventName extends keyof MultitrackEvents
Parameters
- event: EventName
- listener: EventListener<MultitrackEvents, EventName>
Returns void
Inherited from EventEmitter.un
- Defined in node_modules/wavesurfer.js/dist/event-emitter.d.ts:13

unAll

unAll(): void
Clear all events

Returns void
Inherited from EventEmitter.unAll
- Defined in node_modules/wavesurfer.js/dist/event-emitter.d.ts:17

`Private` updatePosition

updatePosition(time, autoCenter?): void
Parameters
- time: number
- autoCenter: boolean = false
Returns void
- Defined in src/multitrack.ts:388

zoom

zoom(pxPerSec): void
Parameters
- pxPerSec: number
Returns void
- Defined in src/multitrack.ts:518

`Static` create

create(tracks, options): default
Parameters
- tracks: MultitrackTracks
- options: MultitrackOptions
Returns default
- Defined in src/multitrack.ts:98

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

tracks: MultitrackTracks

options: MultitrackOptions

Returns default

Properties

Private audioContext

Private audios

Private currentTime

Private durations

Private envelopes

Private frameRequest

Private maxDuration

Private options

Private rendering

Type declaration

addClickHandler: ((onClick) => void)

Parameters

onClick: ((position) => void)

Parameters

position: number

Returns void

Returns void

addDropHandler: ((onDrop) => void)

Parameters

onDrop: ((trackId) => void)

Parameters

trackId: TrackId

Returns void

Returns void

containers: HTMLDivElement[]

destroy: (() => void)

Returns void

setContainerOffsets: (() => void)

Returns void

setMainWidth: ((trackDurations, maxDuration) => void)

Parameters

trackDurations: number[]

maxDuration: number

Returns void

updateCursor: ((position, autoCenter) => void)

Parameters

position: number

autoCenter: boolean

Returns void

Private subscriptions

Type declaration

Returns void

Private tracks

Private wavesurfers

Methods

addTrack

Parameters

track: TrackOptions

Returns void

destroy

Returns void

Protected emit

Type Parameters

EventName extends keyof MultitrackEvents

Parameters

eventName: EventName

Rest ...args: MultitrackEvents[EventName]

Returns void

Private findCurrentTracks

Returns number[]

getCurrentTime

Returns number

getEnvelopePoints

Parameters

trackIndex: number

Returns undefined | EnvelopePoint[]

Private initAllAudios

`Private` audioContext

`Private` audios

`Private` currentTime

`Private` durations

`Private` envelopes

`Private` frameRequest

`Private` maxDuration

`Private` options

`Private` rendering

`Private` subscriptions

`Private` tracks

`Private` wavesurfers

`Protected` emit

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

`Private` findCurrentTracks

`Private` initAllAudios

`Private` initAllWavesurfers

`Private` initAudio

`Private` initDurations

`Private` initWavesurfer

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

`Optional` once?: boolean

`Private` onDrag

`Private` startSync