Class Visualizer`Abstract`

This private class is superclass for visualizer class (TimeOverview, Time, FFT).

Abstract

Implements

Hierarchy

Visualizer

Implements

Statable

Constructors

constructor

new Visualizer(sampleRate, channel): Visualizer
Parameters
- sampleRate: number
  This argument is sample rate.
- channel: ChannelNumber
Returns Visualizer
- Defined in SoundModule/Analyser/Visualizer.ts:105

Properties

`Protected` canvas

canvas: null | HTMLCanvasElement = null

`Protected` channel

channel: ChannelNumber

`Protected` context

context: null | CanvasRenderingContext2D = null

`Protected` graphics

graphics: GraphicsApi = ''

`Protected` interval

interval: number = 1000

`Protected` isActive

isActive: boolean = false

`Protected` sampleRate

sampleRate: number

`Protected` styles

styles: GraphicsStyles = ...

`Protected` svg

svg: null | SVGSVGElement = null

`Static` `Protected` SVG_LINEAR_GRADIENT_ID_FFT

SVG_LINEAR_GRADIENT_ID_FFT: string = 'svg-linear-gradient-fft'

`Static` `Protected` SVG_LINEAR_GRADIENT_ID_TIME

SVG_LINEAR_GRADIENT_ID_TIME: string = 'svg-linear-gradient-time'

`Static` `Protected` SVG_LINEAR_GRADIENT_ID_TIME_OVERVIEW

SVG_LINEAR_GRADIENT_ID_TIME_OVERVIEW: string = 'svg-linear-gradient-time-overview'

`Static` `Readonly` XLINK

XLINK: "http://www.w3.org/1999/xlink" = ...

`Static` `Readonly` XMLNS

XMLNS: "http://www.w3.org/2000/svg" = ...

Methods

activate

activate(): Visualizer
This method activates visualizer.

Returns Visualizer
Return value is for method chain.
Implementation of Statable.activate
- Defined in SoundModule/Analyser/Visualizer.ts:288

clear

clear(): Visualizer
This method clears graphics.

Returns Visualizer
Return value is for method chain.
- Defined in SoundModule/Analyser/Visualizer.ts:222

create

create(): string
This method creates visualized graphics as string (Data URL or SVG).

Returns string
- Defined in SoundModule/Analyser/Visualizer.ts:252

`Protected` createFontString

createFontString(): string
This method creates string for font styles.

Returns string
- Defined in SoundModule/Analyser/Visualizer.ts:515

`Protected` createSVGLinearGradient

createSVGLinearGradient(linearGradientId): null | SVGDefsElement
This method creates elements for SVG linear gradient.
Parameters
- linearGradientId: string
  This argument is id attribute for SVGLinearGradientElement.
Returns null | SVGDefsElement
This value is as instance of SVGDefsElement.
- Defined in SoundModule/Analyser/Visualizer.ts:483

deactivate

deactivate(): Visualizer
This method deactivates visualizer.

Returns Visualizer
Return value is for method chain.
Implementation of Statable.deactivate
- Defined in SoundModule/Analyser/Visualizer.ts:297

get

get(): null | HTMLCanvasElement | SVGSVGElement
This method gets instance of HTMLCanvasElement or SVGSVGElement.

Returns null | HTMLCanvasElement | SVGSVGElement
- Defined in SoundModule/Analyser/Visualizer.ts:202

param

param(params): number
This method gets or sets parameters for visualization. This method is overloaded for type interface and type check.
Parameters
- params: "interval"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for visualization if getter.
- Defined in SoundModule/Analyser/Visualizer.ts:161
param(params): GraphicsStyles
Parameters
- params: "styles"
Returns GraphicsStyles
- Defined in SoundModule/Analyser/Visualizer.ts:162
param(params): void
Parameters
- params: VisualizerParams
Returns void
- Defined in SoundModule/Analyser/Visualizer.ts:163

setup

setup(element): Visualizer
This method sets up for using Canvas or SVG.
Parameters
- element: HTMLCanvasElement | SVGSVGElement
  This argument is either HTMLCanvasElement or SVGSVGElement.
Returns Visualizer
Return value is for method chain.
- Defined in SoundModule/Analyser/Visualizer.ts:115

start

start(data, minDecibels?, maxDecibels?): Visualizer
This method visualizes sound wave to Canvas or SVG. This method conceals difference of API for visualization.
Parameters
- data: Float32Array | Uint8Array
  This argument is sound data for visualization.
- Optional minDecibels: number
  This argument is parameter for spectrum. The default value is -100 dB.
- Optional maxDecibels: number
  This argument is parameter for spectrum. The default value is -30 dB.
Returns Visualizer
Return value is for method chain.
- Defined in SoundModule/Analyser/Visualizer.ts:135

state

state(): boolean
This method gets visualizer state. If returns true, visualizer is active.

Returns boolean
Implementation of Statable.state
- Defined in SoundModule/Analyser/Visualizer.ts:280

`Protected` `Abstract` visualizeBySVG

visualizeBySVG(data, minDecibels?, maxDecibels?): void
Parameters
- data: Float32Array | Uint8Array
- Optional minDecibels: number
- Optional maxDecibels: number
Returns void
Abstract
- Defined in SoundModule/Analyser/Visualizer.ts:525

`Protected` `Abstract` visualizeOnCanvas

visualizeOnCanvas(data, minDecibels?, maxDecibels?): void
Parameters
- data: Float32Array | Uint8Array
- Optional minDecibels: number
- Optional maxDecibels: number
Returns void
Abstract
- Defined in SoundModule/Analyser/Visualizer.ts:522

`Protected` visualizeTimeDomainFloat32ArrayBySVG

visualizeTimeDomainFloat32ArrayBySVG(data, innerWidth, innerHeight, middle, numberOfPlots, linearGradientId): null | SVGPathElement | SVGGElement
This method visualizes time domain data (Float32Array) to SVG.
Parameters
- data: Float32Array
  This argument is time domain data.
- innerWidth: number
  This argument is width of visualization area.
- innerHeight: number
  This argument is height of visualization area.
- middle: number
  This argument is middle of visualization area.
- numberOfPlots: number
  This argument is interval for visualization.
- linearGradientId: string
  This argument is id attribute for SVGLinearGradientElement.
Returns null | SVGPathElement | SVGGElement
This value is instance of SVGPathElement or SVGGElement.
- Defined in SoundModule/Analyser/Visualizer.ts:391

`Protected` visualizeTimeDomainFloat32ArrayOnCanvas

visualizeTimeDomainFloat32ArrayOnCanvas(context, data, innerWidth, innerHeight, middle, numberOfPlots?): void
This method visualizes time domain data (Float32Array) to Canvas.
Parameters
- context: CanvasRenderingContext2D
  This argument is instance of CanvasRenderingContext2D.
- data: Float32Array
  This argument is time domain data.
- innerWidth: number
  This argument is width of visualization area.
- innerHeight: number
  This argument is height of visualization area.
- middle: number
  This argument is middle of visualization area.
- Optional numberOfPlots: number
  This argument is interval for visualization.
Returns void
- Defined in SoundModule/Analyser/Visualizer.ts:311

Class VisualizerAbstract

Abstract

Implements

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

sampleRate: number

channel: ChannelNumber

Returns Visualizer

Properties

Protected canvas

Protected channel

Protected context

Protected graphics

Protected interval

Protected isActive

Protected sampleRate

Protected styles

Protected svg

Static Protected SVG_LINEAR_GRADIENT_ID_FFT

Static Protected SVG_LINEAR_GRADIENT_ID_TIME

Static Protected SVG_LINEAR_GRADIENT_ID_TIME_OVERVIEW

Static Readonly XLINK

Static Readonly XMLNS

Methods

activate

Returns Visualizer

clear

Returns Visualizer

create

Returns string

Protected createFontString

Returns string

Protected createSVGLinearGradient

Parameters

linearGradientId: string

Returns null | SVGDefsElement

deactivate

Returns Visualizer

get

Returns null | HTMLCanvasElement | SVGSVGElement

param

Parameters

params: "interval"

Returns number

Parameters

params: "styles"

Returns GraphicsStyles

Parameters

params: VisualizerParams

Returns void

setup

Parameters

element: HTMLCanvasElement | SVGSVGElement

Returns Visualizer

start

Parameters

data: Float32Array | Uint8Array

Optional minDecibels: number

Optional maxDecibels: number

Returns Visualizer

state

Returns boolean

Protected Abstract visualizeBySVG

Parameters

data: Float32Array | Uint8Array

Optional minDecibels: number

Optional maxDecibels: number

Returns void

Abstract

Protected Abstract visualizeOnCanvas

Parameters

data: Float32Array | Uint8Array

Optional minDecibels: number

Class Visualizer`Abstract`

`Protected` canvas

`Protected` channel

`Protected` context

`Protected` graphics

`Protected` interval

`Protected` isActive

`Protected` sampleRate

`Protected` styles

`Protected` svg

`Static` `Protected` SVG_LINEAR_GRADIENT_ID_FFT

`Static` `Protected` SVG_LINEAR_GRADIENT_ID_TIME

`Static` `Protected` SVG_LINEAR_GRADIENT_ID_TIME_OVERVIEW

`Static` `Readonly` XLINK

`Static` `Readonly` XMLNS

`Protected` createFontString

`Protected` createSVGLinearGradient

`Optional` minDecibels: number

`Optional` maxDecibels: number

`Protected` `Abstract` visualizeBySVG

`Optional` minDecibels: number

`Optional` maxDecibels: number

`Protected` `Abstract` visualizeOnCanvas

`Optional` minDecibels: number

`Optional` maxDecibels: number

`Protected` visualizeTimeDomainFloat32ArrayBySVG

`Protected` visualizeTimeDomainFloat32ArrayOnCanvas

`Optional` numberOfPlots: number