import SpectrogramPlugin from 'wavesurfer.js/src/plugin/spectrogram/index.js'

public class | source

SpectrogramPlugin

Extends:

Observer → SpectrogramPlugin

Implements:

PluginClass

Render a spectrogram visualisation of the audio.

Example:

// es6
import SpectrogramPlugin from 'wavesurfer.spectrogram.js';

// commonjs
var SpectrogramPlugin = require('wavesurfer.spectrogram.js');

// if you are using <script> tags
var SpectrogramPlugin = window.WaveSurfer.spectrogram;

// ... initialising wavesurfer with the plugin
var wavesurfer = WaveSurfer.create({
  // wavesurfer options ...
  plugins: [
    SpectrogramPlugin.create({
      // plugin options ...
    })
  ]
});

Static Method Summary

Static Public Methods
public static	create(params: SpectrogramPluginParams): PluginDefinition Spectrogram plugin definition factory

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	alpha: *
public	channels: *
public	colorMap: *
public	container: *
public	drawer: *
public	fftSamples: *
public	frequenciesDataUrl: *
public	frequencyMax: *
public	frequencyMin: *
public	height: *
public	noverlap: *
public	params: *
public	pixelRatio: *
public	spectrCc: *
public	splitChannels: *
public	util: *
public	wavesurfer: *
public	width: *
public	windowFunc: *
public	wrapper: *

Method Summary

Public Methods
public	createCanvas()
public	createWrapper()
public	destroy()
public	drawSpectrogram(frequenciesData: , my: )
public	freqType(freq: ):
public	getFrequencies(callback: *)
public	init()
public	loadFrequenciesData(url: ):
public	loadLabels(bgFill: , fontSizeFreq: , fontSizeUnit: , fontType: , textColorFreq: , textColorUnit: , textAlign: , container: )
public	render()
public	resample(oldMatrix: ):
public	unitType(freq: ):
public	updateCanvasStyle()
public	updateScroll(e: *)

Inherited Summary

From class Observer
public	handlers: *
public	fireEvent(event: string, args: ...any) Manually fire an event
public	on(event: string, fn: function): ListenerDescriptor Attach a handler function for an event.
public	once(event: string, handler: function): ListenerDescriptor Attach a handler to an event.
public	setDisabledEventEmissions(eventNames: string[]) Disable firing a list of events by name.	since 4.0.0
public	un(event: string, fn: function) Remove an event handler.
public	unAll() Remove all event handlers.

Static Public Methods

public static create(params: SpectrogramPluginParams): PluginDefinition source

Spectrogram plugin definition factory

This function must be used to create a plugin definition which can be used by wavesurfer to correctly instantiate the plugin.

Params:

Name	Type	Attribute	Description
params	SpectrogramPluginParams		Parameters used to initialise the plugin

Return:

PluginDefinition

An object representing the plugin.

Public Constructors

public constructor() source

Instantiate Observer

Override:

Observer#constructor

Public Members

public alpha: * source

public channels: * source

public colorMap: * source

public container: * source

public drawer: * source

public fftSamples: * source

public frequenciesDataUrl: * source

public frequencyMax: * source

public frequencyMin: * source

public height: * source

public noverlap: * source

public params: * source

public pixelRatio: * source

public spectrCc: * source

public splitChannels: * source

public util: * source

public wavesurfer: * source

public width: * source

public windowFunc: * source

public wrapper: * source

Public Methods

public createCanvas() source

public createWrapper() source

public destroy() source

public drawSpectrogram(frequenciesData: , my: ) source

Params:

Name	Type	Attribute	Description
frequenciesData	*
my	*

public freqType(freq: ): source

Params:

Name	Type	Attribute	Description
freq	*

Return:

public getFrequencies(callback: *) source

Params:

Name	Type	Attribute	Description
callback	*

public init() source

public loadFrequenciesData(url: ): source

Params:

Name	Type	Attribute	Description
url	*

Return:

public loadLabels(bgFill: , fontSizeFreq: , fontSizeUnit: , fontType: , textColorFreq: , textColorUnit: , textAlign: , container: ) source

Params:

Name	Type	Attribute	Description
bgFill	*
fontSizeFreq	*
fontSizeUnit	*
fontType	*
textColorFreq	*
textColorUnit	*
textAlign	*
container	*

public render() source

public resample(oldMatrix: ): source

Params:

Name	Type	Attribute	Description
oldMatrix	*

Return:

public unitType(freq: ): source

Params:

Name	Type	Attribute	Description
freq	*

Return:

public updateCanvasStyle() source

public updateScroll(e: *) source

Params:

Name	Type	Attribute	Description
e	*

SpectrogramPlugin

Extends:

Implements:

Example:

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Static Public Methods

public static create(params: SpectrogramPluginParams): PluginDefinition source

Params:

Return:

Public Constructors

public constructor() source

Override:

Public Members

public alpha: * source

public channels: * source

public colorMap: * source

public container: * source

public drawer: * source

public fftSamples: * source

public frequenciesDataUrl: * source

public frequencyMax: * source

public frequencyMin: * source

public height: * source

public noverlap: * source

public params: * source

public pixelRatio: * source

public spectrCc: * source

public splitChannels: * source

public util: * source

public wavesurfer: * source

public width: * source

public windowFunc: * source

public wrapper: * source

Public Methods

public createCanvas() source

public createWrapper() source

public destroy() source

public drawSpectrogram(frequenciesData: *, my: *) source

Params:

public freqType(freq: *): * source

Params:

Return:

public getFrequencies(callback: *) source

Params:

public init() source

public loadFrequenciesData(url: *): * source

Params:

Return:

public loadLabels(bgFill: *, fontSizeFreq: *, fontSizeUnit: *, fontType: *, textColorFreq: *, textColorUnit: *, textAlign: *, container: *) source

Params:

public render() source

public resample(oldMatrix: *): * source

Params:

Return:

public unitType(freq: *): * source

Params:

Return:

public updateCanvasStyle() source

public updateScroll(e: *) source

Params:

public drawSpectrogram(frequenciesData: , my: ) source

public freqType(freq: ): source

public loadFrequenciesData(url: ): source

public loadLabels(bgFill: , fontSizeFreq: , fontSizeUnit: , fontType: , textColorFreq: , textColorUnit: , textAlign: , container: ) source

public resample(oldMatrix: ): source

public unitType(freq: ): source