Class Time

This private class visualizes sound wave in time domain.

Hierarchy (view full)

Visualizer
- Time

Constructors

constructor

new Time(sampleRate, channel): Time
Parameters
- sampleRate: number
  This argument is sample rate.
- channel: ChannelNumber
  This argument is channel number (Left: 0, Right: 1 ...).
Returns Time
Overrides Visualizer.constructor
- Defined in SoundModule/Analyser/Time.ts:27

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

`Private` textInterval

textInterval: number = 0.005

`Private` type

type: DataType = 'uint'

`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(): Time
Returns Time
Overrides Visualizer.activate
- Defined in SoundModule/Analyser/Time.ts:105

clear

clear(): Time
Returns Time
Overrides Visualizer.clear
- Defined in SoundModule/Analyser/Time.ts:99

create

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

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

`Protected` createFontString

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

Returns string
Inherited from Visualizer.createFontString
- 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.
Inherited from Visualizer.createSVGLinearGradient
- Defined in SoundModule/Analyser/Visualizer.ts:483

deactivate

deactivate(): Time
Returns Time
Overrides Visualizer.deactivate
- Defined in SoundModule/Analyser/Time.ts:111

get

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

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

param

param(params): number
This method gets or sets parameters for visualizing sound wave. 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 visualizing sound wave if getter. Otherwise, return value is for method chain.
Overrides Visualizer.param
- Defined in SoundModule/Analyser/Time.ts:45
param(params): GraphicsStyles
Parameters
- params: "styles"
Returns GraphicsStyles
Overrides Visualizer.param
- Defined in SoundModule/Analyser/Time.ts:46
param(params): DataType
Parameters
- params: "type"
Returns DataType
Overrides Visualizer.param
- Defined in SoundModule/Analyser/Time.ts:47
param(params): number
Parameters
- params: "textInterval"
Returns number
Overrides Visualizer.param
- Defined in SoundModule/Analyser/Time.ts:48
param(params): Time
Parameters
- params: TimeParams
Returns Time
Overrides Visualizer.param
- Defined in SoundModule/Analyser/Time.ts:49

setup

setup(element): Time
Parameters
- element: HTMLCanvasElement | SVGSVGElement
Returns Time
Overrides Visualizer.setup
- Defined in SoundModule/Analyser/Time.ts:32

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.
Inherited from Visualizer.start
- Defined in SoundModule/Analyser/Visualizer.ts:135

state

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

Returns boolean
Inherited from Visualizer.state
- Defined in SoundModule/Analyser/Visualizer.ts:280

`Protected` visualizeBySVG

visualizeBySVG(data, _minDecibels?, _maxDecibels?): void
This method visualizes sound wave in time domain to SVG.
Parameters
- data: Float32Array | Uint8Array
  This argument is sound data for visualization.
- Optional _minDecibels: number
- Optional _maxDecibels: number
Returns void
Overrides Visualizer.visualizeBySVG
- Defined in SoundModule/Analyser/Time.ts:270

`Protected` visualizeOnCanvas

visualizeOnCanvas(data, _minDecibels?, _maxDecibels?): void
This method visualizes sound wave in time domain to Canvas.
Parameters
- data: Float32Array | Uint8Array
  This argument is sound data for visualization.
- Optional _minDecibels: number
- Optional _maxDecibels: number
Returns void
Overrides Visualizer.visualizeOnCanvas
- Defined in SoundModule/Analyser/Time.ts:121

`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.
Inherited from Visualizer.visualizeTimeDomainFloat32ArrayBySVG
- 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
Inherited from Visualizer.visualizeTimeDomainFloat32ArrayOnCanvas
- Defined in SoundModule/Analyser/Visualizer.ts:311

Class Time

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Time

Properties

Protected canvas

Protected channel

Protected context

Protected graphics

Protected interval

Protected isActive

Protected sampleRate

Protected styles

Protected svg

Private textInterval

Private type

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 Time

clear

Returns Time

create

Returns string

Protected createFontString

Returns string

Protected createSVGLinearGradient

Parameters

Returns null | SVGDefsElement

deactivate

Returns Time

get

Returns null | HTMLCanvasElement | SVGSVGElement

param

Parameters

Returns number

Parameters

Returns GraphicsStyles

Parameters

Returns DataType

Parameters

Returns number

Parameters

Returns Time

setup

Parameters

Returns Time

start

Parameters

Returns Visualizer

state

Returns boolean

Protected visualizeBySVG

Parameters

Returns void

Protected visualizeOnCanvas

Parameters

Returns void

Protected visualizeTimeDomainFloat32ArrayBySVG

Parameters

Returns null | SVGPathElement | SVGGElement

Protected visualizeTimeDomainFloat32ArrayOnCanvas

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

`Protected` canvas

`Protected` channel

`Protected` context

`Protected` graphics

`Protected` interval

`Protected` isActive

`Protected` sampleRate

`Protected` styles

`Protected` svg

`Private` textInterval

`Private` type

`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

`Protected` visualizeBySVG

`Protected` visualizeOnCanvas

`Protected` visualizeTimeDomainFloat32ArrayBySVG

`Protected` visualizeTimeDomainFloat32ArrayOnCanvas