Class Visualizer`Abstract`

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

Hierarchy (View Summary)

Visualizer

Implements

Statable

Constructors

constructor

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

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

`Protected` `Static`SVG_LINEAR_GRADIENT_ID_FFT

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

`Protected` `Static`SVG_LINEAR_GRADIENT_ID_TIME

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

`Protected` `Static`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:289

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

`Protected`createFontString

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

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

`Protected`createSVGLinearGradient

createSVGLinearGradient(linearGradientId: string): 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:488

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

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

setup

setup(element: HTMLCanvasElement | SVGSVGElement): 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:112

start

start(
    data: Float32Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>,
    minDecibels?: number,
    maxDecibels?: number,
): Visualizer
This method visualizes sound wave to Canvas or SVG. This method conceals difference of API for visualization.
Parameters
- data: Float32Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>
  This argument is sound data for visualization.
- OptionalminDecibels: number
  This argument is parameter for spectrum. The default value is -100 dB.
- OptionalmaxDecibels: 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:133

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

`Protected` `Abstract`visualizeBySVG

visualizeBySVG(
    data: Float32Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>,
    minDecibels?: number,
    maxDecibels?: number,
): void
Parameters
- data: Float32Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>
- OptionalminDecibels: number
- OptionalmaxDecibels: number
Returns void
- Defined in SoundModule/Analyser/Visualizer.ts:527

`Protected` `Abstract`visualizeOnCanvas

visualizeOnCanvas(
    data: Float32Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>,
    minDecibels?: number,
    maxDecibels?: number,
): void
Parameters
- data: Float32Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>
- OptionalminDecibels: number
- OptionalmaxDecibels: number
Returns void
- Defined in SoundModule/Analyser/Visualizer.ts:526

`Protected`visualizeTimeDomainFloat32ArrayBySVG

visualizeTimeDomainFloat32ArrayBySVG(
    data: Float32Array,
    innerWidth: number,
    innerHeight: number,
    middle: number,
    numberOfPlots: number,
    linearGradientId: string,
): 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:396

`Protected`visualizeTimeDomainFloat32ArrayOnCanvas

visualizeTimeDomainFloat32ArrayOnCanvas(
    context: CanvasRenderingContext2D,
    data: Float32Array,
    innerWidth: number,
    innerHeight: number,
    middle: number,
    numberOfPlots?: number,
): 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.
- OptionalnumberOfPlots: number
  This argument is interval for visualization.
Returns void
- Defined in SoundModule/Analyser/Visualizer.ts:316

Class VisualizerAbstract

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Visualizer

Properties

Protectedcanvas

Protectedchannel

Protectedcontext

Protectedgraphics

Protectedinterval

ProtectedisActive

ProtectedsampleRate

Protectedstyles

Protectedsvg

Protected StaticSVG_LINEAR_GRADIENT_ID_FFT

Protected StaticSVG_LINEAR_GRADIENT_ID_TIME

Protected StaticSVG_LINEAR_GRADIENT_ID_TIME_OVERVIEW

Static ReadonlyXLINK

Static ReadonlyXMLNS

Methods

activate

Returns Visualizer

clear

Returns Visualizer

create

Returns string

ProtectedcreateFontString

Returns string

ProtectedcreateSVGLinearGradient

Parameters

Returns null | SVGDefsElement

deactivate

Returns Visualizer

get

Returns null | HTMLCanvasElement | SVGSVGElement

param

Parameters

Returns number

Parameters

Returns GraphicsStyles

Parameters

Returns void

setup

Parameters

Returns Visualizer

start

Parameters

Returns Visualizer

state

Returns boolean

Protected AbstractvisualizeBySVG

Parameters

Returns void

Protected AbstractvisualizeOnCanvas

Parameters

Returns void

ProtectedvisualizeTimeDomainFloat32ArrayBySVG

Parameters

Returns null | SVGPathElement | SVGGElement

ProtectedvisualizeTimeDomainFloat32ArrayOnCanvas

Parameters

Returns void

Settings

On This Page

Class Visualizer`Abstract`

`Protected`canvas

`Protected`channel

`Protected`context

`Protected`graphics

`Protected`interval

`Protected`isActive

`Protected`sampleRate

`Protected`styles

`Protected`svg

`Protected` `Static`SVG_LINEAR_GRADIENT_ID_FFT

`Protected` `Static`SVG_LINEAR_GRADIENT_ID_TIME

`Protected` `Static`SVG_LINEAR_GRADIENT_ID_TIME_OVERVIEW

`Static` `Readonly`XLINK

`Static` `Readonly`XMLNS

`Protected`createFontString

`Protected`createSVGLinearGradient

`Protected` `Abstract`visualizeBySVG

`Protected` `Abstract`visualizeOnCanvas

`Protected`visualizeTimeDomainFloat32ArrayBySVG

`Protected`visualizeTimeDomainFloat32ArrayOnCanvas