Class default

Hierarchy

BasePlugin<EnvelopePluginEvents, EnvelopePluginOptions>
- default

Index

Constructors

Properties

options points polyline subscriptions throttleTimeout volume wavesurfer?

Methods

_init addPoint addPolyPoint destroy emit emitPoints getCurrentVolume getPoints initPolyline on onInit onTimeUpdate once removePoint setPoints setVolume un unAll create

Constructors

constructor

new default(options): default
Create a new Envelope plugin.
Parameters
- options: EnvelopePluginOptions
Returns default
Overrides BasePlugin<EnvelopePluginEvents, EnvelopePluginOptions>.constructor
- Defined in plugins/envelope.ts:294

Properties

`Protected` options

options: Options

`Private` points

points: EnvelopePoint[]

`Private` polyline

polyline: null | Polyline = null

`Protected` subscriptions

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

Type declaration

- (): void
- Returns void

`Private` throttleTimeout

throttleTimeout: null | number = null

`Private` volume

volume: number = 1

`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

addPoint

addPoint(point): void
Add an envelope point with a given time and volume.
Parameters
- point: EnvelopePoint
Returns void
- Defined in plugins/envelope.ts:313

`Private` addPolyPoint

addPolyPoint(point, duration): void
Parameters
- point: EnvelopePoint
- duration: number
Returns void
- Defined in plugins/envelope.ts:458

destroy

destroy(): void
Destroy the plugin instance.

Returns void
Overrides BasePlugin.destroy
- Defined in plugins/envelope.ts:359

`Protected` emit

emit<EventName>(eventName, ...args): void
Emit an event
Type Parameters
- EventName extends "destroy" | "volume-change" | "points-change"
Parameters
- eventName: EventName
- Rest ...args: EnvelopePluginEvents[EventName]
Returns void
Inherited from BasePlugin.emit
- Defined in event-emitter.ts:64

`Private` emitPoints

emitPoints(): void
Returns void
- Defined in plugins/envelope.ts:409

getCurrentVolume

getCurrentVolume(): number
Get the envelope volume.

Returns number
- Defined in plugins/envelope.ts:367

getPoints

getPoints(): EnvelopePoint[]
Get all envelope points. Should not be modified directly.

Returns EnvelopePoint[]
- Defined in plugins/envelope.ts:344

`Private` initPolyline

initPolyline(): void
Returns void
- Defined in plugins/envelope.ts:418

on

on<EventName>(event, listener, options?): (() => void)
Subscribe to an event. Returns an unsubscribe function.
Type Parameters
- EventName extends "destroy" | "volume-change" | "points-change"
Parameters
- event: EventName
- listener: EventListener<EnvelopePluginEvents, 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/envelope.ts:380

`Private` onTimeUpdate

onTimeUpdate(time): void
Parameters
- time: number
Returns void
- Defined in plugins/envelope.ts:462

once

once<EventName>(event, listener): (() => void)
Subscribe to an event only once
Type Parameters
- EventName extends "destroy" | "volume-change" | "points-change"
Parameters
- event: EventName
- listener: EventListener<EnvelopePluginEvents, EventName>
Returns (() => void)
- - (): void
  - Subscribe to an event only once
    
    Returns void
Inherited from BasePlugin.once
- Defined in event-emitter.ts:51

removePoint

removePoint(point): void
Remove an envelope point.
Parameters
- point: EnvelopePoint
Returns void
- Defined in plugins/envelope.ts:332

setPoints

setPoints(newPoints): void
Set new envelope points.
Parameters
- newPoints: EnvelopePoint[]
Returns void
- Defined in plugins/envelope.ts:351

setVolume

setVolume(floatValue): void
Set the envelope volume. 0..1 (more than 1 will boost the volume).
Parameters
- floatValue: number
Returns void
- Defined in plugins/envelope.ts:374

un

un<EventName>(event, listener): void
Unsubscribe from an event
Type Parameters
- EventName extends "destroy" | "volume-change" | "points-change"
Parameters
- event: EventName
- listener: EventListener<EnvelopePluginEvents, 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: EnvelopePluginOptions
Returns default
- Defined in plugins/envelope.ts:306

Generated using TypeDoc