Class SpectrogramPlugin

Hierarchy

BasePlugin<SpectrogramPluginEvents, SpectrogramPluginOptions>
- SpectrogramPlugin

Index

Constructors

Properties

options subscriptions utils wavesurfer?

Constructors

constructor

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

Properties

`Protected` options

options: SpectrogramPluginOptions

`Protected` subscriptions

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

Type declaration

- (): void
- Returns void

utils

utils: {
style: ((el, styles) => CSSStyleDeclaration & Record<string, string>);
} = ...

Type declaration

style: ((el, styles) => CSSStyleDeclaration & Record<string, string>)
- - (el, styles): CSSStyleDeclaration & Record<string, string>
  - Parameters
    - el: HTMLElement
    - styles: Record<string, string>
    Returns CSSStyleDeclaration & Record<string, string>

`Protected` `Optional` wavesurfer

wavesurfer?: WaveSurfer

Methods

_wrapperClickHandler

_wrapperClickHandler(event): void
Parameters
- event: any
Returns void
- Defined in plugins/spectrogram.ts:378

createCanvas

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

createWrapper

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

destroy

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

drawSpectrogram

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

`Protected` emit

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

freqType

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

getFrequencies

getFrequencies(callback): void
Parameters
- callback: any
Returns void
- Defined in plugins/spectrogram.ts:476

init

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

loadFrequenciesData

loadFrequenciesData(url): Promise<void>
Parameters
- url: any
Returns Promise<void>
- Defined in plugins/spectrogram.ts:524

loadLabels

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

on

on<EventName>(eventName, listener): (() => void)
Subscribe to an event. Returns an unsubscribe function.
Type Parameters
- EventName extends keyof SpectrogramPluginEvents
Parameters
- eventName: EventName
- listener: EventListener<SpectrogramPluginEvents, 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
Returns void
Overrides BasePlugin.onInit
- Defined in plugins/spectrogram.ts:319

once

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

render

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

resample

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

un

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

unitType

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

`Static` create

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

Generated using TypeDoc