Class default

Hierarchy

BasePlugin<SpectrogramPluginEvents, SpectrogramPluginOptions>
- default

Constructors

constructor

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

Properties

`Private` alpha

alpha: undefined | number

`Private` canvas

canvas: HTMLCanvasElement

`Private` colorMap

colorMap: undefined | number[][] | "gray" | "igray" | "roseus"

`Private` container

container: HTMLElement

`Private` fftSamples

fftSamples: undefined | number

`Private` `Optional` frequenciesDataUrl

frequenciesDataUrl?: string

`Private` frequencyMax

frequencyMax: undefined | number

`Private` frequencyMin

frequencyMin: undefined | number

`Private` gainDB

gainDB: undefined | number

`Private` height

height: undefined | number

`Private` labelsEl

labelsEl: HTMLCanvasElement

`Private` noverlap

noverlap: undefined | number

`Private` numBarkFilters

numBarkFilters: number

`Private` numErbFilters

numErbFilters: number

`Private` numLogFilters

numLogFilters: number

`Private` numMelFilters

numMelFilters: number

`Protected` options

options: SpectrogramPluginOptions

`Private` rangeDB

rangeDB: undefined | number

`Private` scale

`Private` spectrCc

spectrCc: CanvasRenderingContext2D

`Protected` subscriptions

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

Type declaration

- (): void
- Returns void

`Protected` `Optional` wavesurfer

wavesurfer?: default

`Private` windowFunc

`Private` wrapper

wrapper: HTMLElement

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` applyFilterBank

applyFilterBank(fftPoints, filterBank): Float32Array
Parameters
- fftPoints: Float32Array
- filterBank: number[][]
Returns Float32Array
- Defined in plugins/spectrogram.ts:640

`Private` barkToHz

barkToHz(bark): number
Parameters
- bark: number
Returns number
- Defined in plugins/spectrogram.ts:611

`Private` createBarkFilterBank

createBarkFilterBank(numBarkFilters, sampleRate): number[][]
Parameters
- numBarkFilters: number
- sampleRate: number
Returns number[][]
- Defined in plugins/spectrogram.ts:622

`Private` createCanvas

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

`Private` createErbFilterBank

createErbFilterBank(numErbFilters, sampleRate): number[][]
Parameters
- numErbFilters: number
- sampleRate: number
Returns number[][]
- Defined in plugins/spectrogram.ts:636

`Private` createFilterBank

createFilterBank(numFilters, sampleRate, hzToScale, scaleToHz): number[][]
Parameters
- numFilters: number
- sampleRate: number
- hzToScale: ((hz) => number)
  - - (hz): number
    - Parameters
      
      hz: number
      
      Returns number
- scaleToHz: ((scale) => number)
  - - (scale): number
    - Parameters
      
      scale: number
      
      Returns number
Returns number[][]
- Defined in plugins/spectrogram.ts:561

`Private` createLogFilterBank

createLogFilterBank(numLogFilters, sampleRate): number[][]
Parameters
- numLogFilters: number
- sampleRate: number
Returns number[][]
- Defined in plugins/spectrogram.ts:595

`Private` createMelFilterBank

createMelFilterBank(numMelFilters, sampleRate): number[][]
Parameters
- numMelFilters: number
- sampleRate: number
Returns number[][]
- Defined in plugins/spectrogram.ts:587

`Private` createWrapper

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

destroy

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

`Private` drawSpectrogram

drawSpectrogram(frequenciesData): void
Parameters
- frequenciesData: Uint8Array[][]
Returns void
- Defined in plugins/spectrogram.ts:491

`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` erbToHz

erbToHz(erb): number
Parameters
- erb: number
Returns number
- Defined in plugins/spectrogram.ts:631

`Private` freqType

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

`Private` getFrequencies

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

`Private` getLabelFrequency

getLabelFrequency(index, labelIndex, hzToScale, scaleToHz): number
Parameters
- index: number
- labelIndex: number
- hzToScale: ((hz) => number)
  - - (hz): number
    - Parameters
      
      hz: number
      
      Returns number
- scaleToHz: ((scale) => number)
  - - (scale): number
    - Parameters
      
      scale: number
      
      Returns number
Returns number
- Defined in plugins/spectrogram.ts:738

`Private` getWidth

getWidth(): number
Returns number
- Defined in plugins/spectrogram.ts:651

`Private` hzToBark

hzToBark(hz): number
Parameters
- hz: number
Returns number
- Defined in plugins/spectrogram.ts:599

`Private` hzToErb

hzToErb(hz): number
Parameters
- hz: number
Returns number
- Defined in plugins/spectrogram.ts:626

`Private` hzToLog

hzToLog(hz): number
Parameters
- hz: number
Returns number
- Defined in plugins/spectrogram.ts:591

`Private` hzToMel

hzToMel(hz): number
Parameters
- hz: number
Returns number
- Defined in plugins/spectrogram.ts:583

loadFrequenciesData

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

`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:749

`Private` logToHz

logToHz(log): number
Parameters
- log: number
Returns number
- Defined in plugins/spectrogram.ts:593

`Private` melToHz

melToHz(mel): number
Parameters
- mel: number
Returns number
- Defined in plugins/spectrogram.ts:585

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:396

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:480

`Private` resample

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

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:734

`Static` create

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

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: SpectrogramPluginOptions

Returns default

Properties

Private alpha

Private canvas

Private colorMap

Private container

Private fftSamples

Private Optional frequenciesDataUrl

Private frequencyMax

Private frequencyMin

Private gainDB

Private height

Private labelsEl

Private noverlap

Private numBarkFilters

Private numErbFilters

Private numLogFilters

Private numMelFilters

Protected options

Private rangeDB

Private scale

Private spectrCc

Protected subscriptions

Type declaration

Returns void

Protected Optional wavesurfer

Private windowFunc

Private wrapper

Methods

_init

Parameters

wavesurfer: default

Returns void

Private applyFilterBank

Parameters

fftPoints: Float32Array

filterBank: number[][]

Returns Float32Array

Private barkToHz

Parameters

bark: number

Returns number

Private createBarkFilterBank

Parameters

numBarkFilters: number

sampleRate: number

Returns number[][]

Private createCanvas

Returns void

Private createErbFilterBank

Parameters

numErbFilters: number

sampleRate: number

Returns number[][]

Private createFilterBank

Parameters

numFilters: number

sampleRate: number

hzToScale: ((hz) => number)

Parameters

hz: number

Returns number

scaleToHz: ((scale) => number)

Parameters

scale: number

Returns number

Returns number[][]

Private createLogFilterBank

Parameters

numLogFilters: number

`Private` alpha

`Private` canvas

`Private` colorMap

`Private` container

`Private` fftSamples

`Private` `Optional` frequenciesDataUrl

`Private` frequencyMax

`Private` frequencyMin

`Private` gainDB

`Private` height

`Private` labelsEl

`Private` noverlap

`Private` numBarkFilters

`Private` numErbFilters

`Private` numLogFilters

`Private` numMelFilters

`Protected` options

`Private` rangeDB

`Private` scale

`Private` spectrCc

`Protected` subscriptions

`Protected` `Optional` wavesurfer

`Private` windowFunc

`Private` wrapper

`Private` applyFilterBank

`Private` barkToHz

`Private` createBarkFilterBank

`Private` createCanvas

`Private` createErbFilterBank

`Private` createFilterBank

`Private` createLogFilterBank

`Private` createMelFilterBank

`Private` createWrapper

`Private` drawSpectrogram

`Protected` emit

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

`Private` erbToHz

`Private` freqType

`Private` getFrequencies

`Private` getLabelFrequency

`Private` getWidth

`Private` hzToBark

`Private` hzToErb

`Private` hzToLog

`Private` hzToMel

`Private` loadLabels