Class default

Hierarchy

BasePlugin<SpectrogramPluginEvents, SpectrogramPluginOptions>
- default

Index

Constructors

Properties

options subscriptions wavesurfer?

Methods

_init createCanvas createWrapper destroy drawSpectrogram emit freqType getFrequencies loadFrequenciesData loadLabels on onInit once render resample un unAll unitType create

Constructors

constructor

new default(options): default
Parameters
- options: SpectrogramPluginOptions
Returns default
Overrides BasePlugin<SpectrogramPluginEvents, SpectrogramPluginOptions>.constructor
- Defined in plugins/spectrogram.ts:271

Properties

`Protected` options

options: SpectrogramPluginOptions

`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

`Private` createCanvas

createCanvas(): void
Returns void
- Defined in plugins/spectrogram.ts:378

`Private` createWrapper

createWrapper(): void
Returns void
- Defined in plugins/spectrogram.ts:349

destroy

destroy(): void
Returns void
Overrides BasePlugin.destroy
- Defined in plugins/spectrogram.ts:326

`Private` drawSpectrogram

drawSpectrogram(frequenciesData): void
Parameters
- frequenciesData: any
Returns void
- Defined in plugins/spectrogram.ts:407

`Protected` emit

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

`Private` freqType

freqType(freq): string | number
Parameters
- freq: any
Returns string | number
- Defined in plugins/spectrogram.ts:528

`Private` getFrequencies

getFrequencies(buffer): number[]
Parameters
- buffer: AudioBuffer
Returns number[]
- Defined in plugins/spectrogram.ts:481

loadFrequenciesData

loadFrequenciesData(url): Promise<void>
Parameters
- url: string | URL
Returns Promise<void>
- Defined in plugins/spectrogram.ts:340

`Private` loadLabels

loadLabels(bgFill, fontSizeFreq, fontSizeUnit, fontType, textColorFreq, textColorUnit, textAlign, container, channels): void
Parameters
- bgFill: any
- fontSizeFreq: any
- fontSizeUnit: any
- fontType: any
- textColorFreq: any
- textColorUnit: any
- textAlign: any
- container: any
- channels: any
Returns void
- Defined in plugins/spectrogram.ts:536

on

on<EventName>(event, listener, options?): (() => void)
Subscribe to an event. Returns an unsubscribe function.
Type Parameters
- EventName extends "click" | "ready" | "destroy"
Parameters
- event: EventName
- listener: EventListener<SpectrogramPluginEvents, 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
Returns void
Overrides BasePlugin.onInit
- Defined in plugins/spectrogram.ts:312

once

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

`Private` render

render(): void
Returns void
- Defined in plugins/spectrogram.ts:396

`Private` resample

resample(oldMatrix): Uint8Array[]
Parameters
- oldMatrix: any
Returns Uint8Array[]
- Defined in plugins/spectrogram.ts:610

un

un<EventName>(event, listener): void
Unsubscribe from an event
Type Parameters
- EventName extends "click" | "ready" | "destroy"
Parameters
- event: EventName
- listener: EventListener<SpectrogramPluginEvents, 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

`Private` unitType

unitType(freq): "KHz" | "Hz"
Parameters
- freq: any
Returns "KHz" | "Hz"
- Defined in plugins/spectrogram.ts:532

`Static` create

create(options?): default
Parameters
- Optional options: SpectrogramPluginOptions
Returns default
- Defined in plugins/spectrogram.ts:267

Generated using TypeDoc