Class default

Hierarchy

BasePlugin<MinimapPluginEvents, MinimapPluginOptions>
- default

Index

Constructors

Properties

container miniWavesurfer minimapWrapper options overlay subscriptions wavesurfer?

Methods

_init destroy emit getOverlayWidth initMinimap initMinimapWrapper initOverlay initWaveSurferEvents on onInit onRedraw onScroll once un unAll create

Constructors

constructor

new default(options): default
Parameters
- options: MinimapPluginOptions
Returns default
Overrides BasePlugin<MinimapPluginEvents, MinimapPluginOptions>.constructor
- Defined in plugins/minimap.ts:58

Properties

`Private` container

container: null | HTMLElement = null

`Private` miniWavesurfer

miniWavesurfer: null | default = null

`Private` minimapWrapper

minimapWrapper: HTMLElement

`Protected` options

options: {
    insertPosition?: InsertPosition;
    overlayColor?: string;
} & Partial<WaveSurferOptions> & {
    height: number;
    insertPosition: string;
    overlayColor: string;
}

Type declaration

Optional insertPosition?: InsertPosition
Optional overlayColor?: string

Type declaration

height: number
insertPosition: string
overlayColor: string

`Private` overlay

overlay: HTMLElement

`Protected` subscriptions

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

Type declaration

- (): void
- Returns void

`Protected` `Optional` wavesurfer

wavesurfer?: default

Methods

_init

_init(wavesurfer): void
Do not call directly, only called by WavesSurfer internally
Parameters
- wavesurfer: default
Returns void
Inherited from BasePlugin._init
- Defined in base-plugin.ts:28

destroy

destroy(): void
Unmount

Returns void
Overrides BasePlugin.destroy
- Defined in plugins/minimap.ts:249

`Protected` emit

emit<EventName>(eventName, ...args): void
Emit an event
Type Parameters
- EventName extends "click" | "dblclick" | "drag" | "dragend" | "dragstart" | "seeking" | "timeupdate" | "init" | "decode" | "ready" | "redraw" | "redrawcomplete" | "audioprocess" | "interaction" | "destroy"
Parameters
- eventName: EventName
- Rest ...args: MinimapPluginEvents[EventName]
Returns void
Inherited from BasePlugin.emit
- Defined in event-emitter.ts:64

`Private` getOverlayWidth

getOverlayWidth(): number
Returns number
- Defined in plugins/minimap.ts:214

`Private` initMinimap

initMinimap(): void
Returns void
- Defined in plugins/minimap.ts:124

`Private` initMinimapWrapper

initMinimapWrapper(): HTMLElement
Returns HTMLElement
- Defined in plugins/minimap.ts:95

`Private` initOverlay

initOverlay(): HTMLElement
Returns HTMLElement
- Defined in plugins/minimap.ts:104

`Private` initWaveSurferEvents

initWaveSurferEvents(): void
Returns void
- Defined in plugins/minimap.ts:230

on

on<EventName>(event, listener, options?): (() => void)
Subscribe to an event. Returns an unsubscribe function.
Type Parameters
- EventName extends "click" | "dblclick" | "drag" | "dragend" | "dragstart" | "seeking" | "timeupdate" | "init" | "decode" | "ready" | "redraw" | "redrawcomplete" | "audioprocess" | "interaction" | "destroy"
Parameters
- event: EventName
- listener: EventListener<MinimapPluginEvents, EventName>
- Optional options: {
  once?: boolean;
  }
  - Optional once?: boolean
Returns (() => void)
- - (): void
  - Subscribe to an event. Returns an unsubscribe function.
    
    Returns void
Inherited from BasePlugin.on
- Defined in event-emitter.ts:20

onInit

onInit(): void
Called by wavesurfer, don't call manually

Returns void
Overrides BasePlugin.onInit
- Defined in plugins/minimap.ts:71

`Private` onRedraw

onRedraw(): void
Returns void
- Defined in plugins/minimap.ts:219

`Private` onScroll

onScroll(startTime): void
Parameters
- startTime: number
Returns void
- Defined in plugins/minimap.ts:224

once

once<EventName>(event, listener): (() => void)
Subscribe to an event only once
Type Parameters
- EventName extends "click" | "dblclick" | "drag" | "dragend" | "dragstart" | "seeking" | "timeupdate" | "init" | "decode" | "ready" | "redraw" | "redrawcomplete" | "audioprocess" | "interaction" | "destroy"
Parameters
- event: EventName
- listener: EventListener<MinimapPluginEvents, EventName>
Returns (() => void)
- - (): void
  - Subscribe to an event only once
    
    Returns void
Inherited from BasePlugin.once
- Defined in event-emitter.ts:51

un

un<EventName>(event, listener): void
Unsubscribe from an event
Type Parameters
- EventName extends "click" | "dblclick" | "drag" | "dragend" | "dragstart" | "seeking" | "timeupdate" | "init" | "decode" | "ready" | "redraw" | "redrawcomplete" | "audioprocess" | "interaction" | "destroy"
Parameters
- event: EventName
- listener: EventListener<MinimapPluginEvents, EventName>
Returns void
Inherited from BasePlugin.un
- Defined in event-emitter.ts:43

unAll

unAll(): void
Clear all events

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

`Static` create

create(options): default
Parameters
- options: MinimapPluginOptions
Returns default
- Defined in plugins/minimap.ts:66

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: MinimapPluginOptions

Returns default

Properties

Private container

Private miniWavesurfer

Private minimapWrapper

Protected options

Type declaration

Optional insertPosition?: InsertPosition

Optional overlayColor?: string

Type declaration

height: number

insertPosition: string

overlayColor: string

Private overlay

Protected subscriptions

Type declaration

Returns void

Protected Optional wavesurfer

Methods

_init

Parameters

wavesurfer: default

Returns void

destroy

Returns void

Protected emit

Type Parameters

EventName extends "click" | "dblclick" | "drag" | "dragend" | "dragstart" | "seeking" | "timeupdate" | "init" | "decode" | "ready" | "redraw" | "redrawcomplete" | "audioprocess" | "interaction" | "destroy"

Parameters

eventName: EventName

Rest ...args: MinimapPluginEvents[EventName]

Returns void

Private getOverlayWidth

Returns number

Private initMinimap

Returns void

Private initMinimapWrapper

Returns HTMLElement

Private initOverlay

Returns HTMLElement

Private initWaveSurferEvents

Returns void

on

Type Parameters

EventName extends "click" | "dblclick" | "drag" | "dragend" | "dragstart" | "seeking" | "timeupdate" | "init" | "decode" | "ready" | "redraw" | "redrawcomplete" | "audioprocess" | "interaction" | "destroy"

Parameters

event: EventName

listener: EventListener<MinimapPluginEvents, EventName>

Optional options: { once?: boolean; }

Optional once?: boolean

Returns (() => void)

Returns void

onInit

Returns void

Private onRedraw

Returns void

Private onScroll

Parameters

startTime: number

Returns void

once

Type Parameters

EventName extends "click" | "dblclick" | "drag" | "dragend" | "dragstart" | "seeking" | "timeupdate" | "init" | "decode" | "ready" | "redraw" | "redrawcomplete" | "audioprocess" | "interaction" | "destroy"

Parameters

event: EventName

listener: EventListener<MinimapPluginEvents, EventName>

Returns (() => void)

Returns void

un

Type Parameters

`Private` container

`Private` miniWavesurfer

`Private` minimapWrapper

`Protected` options

`Optional` insertPosition?: InsertPosition

`Optional` overlayColor?: string

`Private` overlay

`Protected` subscriptions

`Protected` `Optional` wavesurfer

`Protected` emit

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

`Private` getOverlayWidth

`Private` initMinimap

`Private` initMinimapWrapper

`Private` initOverlay

`Private` initWaveSurferEvents

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

`Optional` once?: boolean

`Private` onRedraw

`Private` onScroll

`Static` create