Class EnvelopePlugin

Hierarchy

BasePlugin<EnvelopePluginEvents, EnvelopePluginOptions>
- EnvelopePlugin

Constructors

constructor

new EnvelopePlugin(options): EnvelopePlugin
Parameters
- options: EnvelopePluginOptions
Returns EnvelopePlugin
Overrides BasePlugin<EnvelopePluginEvents, EnvelopePluginOptions>.constructor
- Defined in plugins/envelope.ts:183

Properties

`Private` audioContext

audioContext: null | AudioContext = null

`Private` gainNode

gainNode: null | GainNode = null

`Private` isFadingIn

isFadingIn: boolean = false

`Private` isFadingOut

isFadingOut: boolean = false

`Private` `Readonly` naturalVolumeExponent

naturalVolumeExponent: 1.5 = 1.5

`Protected` options

options: Options

`Private` polyline

polyline: null | Polyline = null

`Protected` subscriptions

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

Type declaration

- (): void
- Returns void

`Private` volume

volume: number = 1

`Protected` `Optional` wavesurfer

wavesurfer?: WaveSurfer

Methods

destroy

destroy(): void
Returns void
Overrides BasePlugin.destroy
- Defined in plugins/envelope.ts:198

`Protected` emit

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

getCurrentVolume

getCurrentVolume(): number
Get the current audio volume

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

init

init(wavesurfer): void
Parameters
- wavesurfer: WaveSurfer
Returns void
Inherited from BasePlugin.init
- Defined in base-plugin.ts:21

`Private` initFadeEffects

initFadeEffects(): void
Returns void
- Defined in plugins/envelope.ts:316

`Private` initSvg

initSvg(): void
Returns void
- Defined in plugins/envelope.ts:226

`Private` initWebAudio

initWebAudio(): undefined | null
Returns undefined | null
- Defined in plugins/envelope.ts:273

`Private` invertNaturalVolume

invertNaturalVolume(value): number
Parameters
- value: number
Returns number
- Defined in plugins/envelope.ts:296

`Private` naturalVolume

naturalVolume(value): number
Parameters
- value: number
Returns number
- Defined in plugins/envelope.ts:303

on

on<EventName>(eventName, listener): (() => void)
Subscribe to an event. Returns an unsubscribe function.
Type Parameters
- EventName extends keyof EnvelopePluginEvents
Parameters
- eventName: EventName
- listener: EventListener<EnvelopePluginEvents, EventName>
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:204

once

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

`Private` renderPolyline

renderPolyline(): void
Returns void
- Defined in plugins/envelope.ts:259

setEndTime

setEndTime(time, moveFadeOutStart?): void
Set the fade-out end time.
Parameters
- time: number
  
  The time (in seconds) to set the fade-out end time to
- moveFadeOutStart: boolean = false
  
  Whether to move the drag point to the new time (default: false)
Returns void
- Defined in plugins/envelope.ts:400

setFadeInEnd

setFadeInEnd(time): void
Set the fade-in end time.
Parameters
- time: number
  
  The time (in seconds) to set the fade-in end time to
Returns void
- Defined in plugins/envelope.ts:414

setFadeOutStart

setFadeOutStart(time): void
Set the fade-out start time.
Parameters
- time: number
  
  The time (in seconds) to set the fade-out start time to
Returns void
- Defined in plugins/envelope.ts:422

`Private` setGainValue

setGainValue(): void
Returns void
- Defined in plugins/envelope.ts:310

setStartTime

setStartTime(time, moveFadeInEnd?): void
Set the fade-in start time.
Parameters
- time: number
  
  The time (in seconds) to set the fade-in start time to
- moveFadeInEnd: boolean = false
  
  Whether to move the drag point to the new time (default: false)
Returns void
- Defined in plugins/envelope.ts:385

setVolume

setVolume(volume): void
Set the volume of the audio
Parameters
- volume: number
Returns void
- Defined in plugins/envelope.ts:428

un

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

unAll

unAll(): void
Clear all events

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

`Static` create

create(options): EnvelopePlugin
Parameters
- options: EnvelopePluginOptions
Returns EnvelopePlugin
- Defined in plugins/envelope.ts:194

Generated using TypeDoc