Class TimeOverview

This private class visualizes audio wave overview in time domain.

Hierarchy (View Summary)

Visualizer
- TimeOverview

Constructors

constructor

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

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(): TimeOverview
This method activates visualizer.

Returns TimeOverview
Return value is for method chain.
Inherited from Visualizer.activate
- Defined in SoundModule/Analyser/Visualizer.ts:289

clear

clear(): TimeOverview
This method clears graphics.

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

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

`Protected`createFontString

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

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

deactivate

deactivate(): TimeOverview
This method deactivates visualizer.

Returns TimeOverview
Return value is for method chain.
Inherited from Visualizer.deactivate
- Defined in SoundModule/Analyser/Visualizer.ts:300

drag

drag(callback?: DragCallbackFunction): TimeOverview
This method registers event listener for updating current time or spriting audio by drag.
Parameters
- Optionalcallback: DragCallbackFunction
  This argument is invoked during drag.
Returns TimeOverview
Return value is for method chain.
- Defined in SoundModule/Analyser/TimeOverview.ts:326

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: "interval"): number
This method gets or sets parameters for visualizing audio 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 audio wave if getter. Otherwise, return value is for method chain.
Overrides Visualizer.param
- Defined in SoundModule/Analyser/TimeOverview.ts:82
param(params: "styles"): GraphicsStyles
This method gets or sets parameters for visualizing audio wave. 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 visualizing audio wave if getter. Otherwise, return value is for method chain.
Overrides Visualizer.param
- Defined in SoundModule/Analyser/TimeOverview.ts:83
param(params: "currentTime"): CurrentTimeStyles
This method gets or sets parameters for visualizing audio wave. This method is overloaded for type interface and type check.
Parameters
- params: "currentTime"
  This argument is string if getter. Otherwise, setter.
Returns CurrentTimeStyles
Return value is parameter for visualizing audio wave if getter. Otherwise, return value is for method chain.
Overrides Visualizer.param
- Defined in SoundModule/Analyser/TimeOverview.ts:84
param(params: "sprite"): string
This method gets or sets parameters for visualizing audio wave. This method is overloaded for type interface and type check.
Parameters
- params: "sprite"
  This argument is string if getter. Otherwise, setter.
Returns string
Return value is parameter for visualizing audio wave if getter. Otherwise, return value is for method chain.
Overrides Visualizer.param
- Defined in SoundModule/Analyser/TimeOverview.ts:85
param(params: "plotInterval"): number
This method gets or sets parameters for visualizing audio wave. This method is overloaded for type interface and type check.
Parameters
- params: "plotInterval"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for visualizing audio wave if getter. Otherwise, return value is for method chain.
Overrides Visualizer.param
- Defined in SoundModule/Analyser/TimeOverview.ts:86
param(params: "textInterval"): number
This method gets or sets parameters for visualizing audio wave. This method is overloaded for type interface and type check.
Parameters
- params: "textInterval"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for visualizing audio wave if getter. Otherwise, return value is for method chain.
Overrides Visualizer.param
- Defined in SoundModule/Analyser/TimeOverview.ts:87
param(params: "mode"): DragMode
This method gets or sets parameters for visualizing audio wave. This method is overloaded for type interface and type check.
Parameters
- params: "mode"
  This argument is string if getter. Otherwise, setter.
Returns DragMode
Return value is parameter for visualizing audio wave if getter. Otherwise, return value is for method chain.
Overrides Visualizer.param
- Defined in SoundModule/Analyser/TimeOverview.ts:88
param(params: TimeOverviewParams): TimeOverview
This method gets or sets parameters for visualizing audio wave. This method is overloaded for type interface and type check.
Parameters
- params: TimeOverviewParams
  This argument is string if getter. Otherwise, setter.
Returns TimeOverview
Return value is parameter for visualizing audio wave if getter. Otherwise, return value is for method chain.
Overrides Visualizer.param
- Defined in SoundModule/Analyser/TimeOverview.ts:89

setup

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

start

start(
    data: Float32Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>,
    minDecibels?: number,
    maxDecibels?: number,
): TimeOverview
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 TimeOverview
Return value is for method chain.
Inherited from Visualizer.start
- Defined in SoundModule/Analyser/Visualizer.ts:133

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

update

update(time: number): TimeOverview
This method visualizes audio current time on Canvas or SVG.
Parameters
- time: number
  This argument is audio current time.
Returns TimeOverview
Return value is for method chain.
- Defined in SoundModule/Analyser/TimeOverview.ts:179

`Protected`visualizeBySVG

visualizeBySVG(
    data: Float32Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>,
    _minDecibels?: number,
    _maxDecibels?: number,
): void
This method visualizes audio wave overview to SVG.
Parameters
- data: Float32Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>
  This argument is audio data for visualization.
- Optional_minDecibels: number
- Optional_maxDecibels: number
Returns void
Overrides Visualizer.visualizeBySVG
- Defined in SoundModule/Analyser/TimeOverview.ts:469

`Protected`visualizeOnCanvas

visualizeOnCanvas(
    data: Float32Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>,
    _minDecibels?: number,
    _maxDecibels?: number,
): void
This method visualizes audio wave overview to Canvas.
Parameters
- data: Float32Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>
  This argument is audio data for visualization.
- Optional_minDecibels: number
- Optional_maxDecibels: number
Returns void
Overrides Visualizer.visualizeOnCanvas
- Defined in SoundModule/Analyser/TimeOverview.ts:381

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

Class TimeOverview

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TimeOverview

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 TimeOverview

clear

Returns TimeOverview

create

Returns string

ProtectedcreateFontString

Returns string

ProtectedcreateSVGLinearGradient

Parameters

Returns null | SVGDefsElement

deactivate

Returns TimeOverview

drag

Parameters

Returns TimeOverview

get

Returns null | HTMLCanvasElement | SVGSVGElement

param

Parameters

Returns number

Parameters

Returns GraphicsStyles

Parameters

Returns CurrentTimeStyles

Parameters

Returns string

Parameters

Returns number

Parameters

Returns number

Parameters

Returns DragMode

Parameters

Returns TimeOverview

setup

Parameters

Returns TimeOverview

start

Parameters

Returns TimeOverview

state

Returns boolean

update

Parameters

Returns TimeOverview

ProtectedvisualizeBySVG

Parameters

Returns void

ProtectedvisualizeOnCanvas

Parameters

Returns void

ProtectedvisualizeTimeDomainFloat32ArrayBySVG

Parameters

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

`Protected`visualizeOnCanvas

`Protected`visualizeTimeDomainFloat32ArrayBySVG

`Protected`visualizeTimeDomainFloat32ArrayOnCanvas