Class TimeOverview

This private class visualizes audio wave overview in time domain.

Hierarchy

Visualizer
- TimeOverview

Constructors

constructor

new TimeOverview(sampleRate, channel): 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

`Private` callback

callback: DragCallbackFunction = ...

`Protected` canvas

canvas: null | HTMLCanvasElement = null

`Protected` channel

channel: ChannelNumber

`Protected` context

context: null | CanvasRenderingContext2D = null

`Private` currentDataSize

currentDataSize: number = 0

`Private` currentImageData

currentImageData: null | ImageData = null

`Private` currentSVGElement

currentSVGElement: null | Element = null

`Private` currentTime

currentTime: CurrentTimeStyles = ...

`Private` endTime

endTime: number = 0

`Protected` graphics

graphics: GraphicsApi = ''

`Protected` interval

interval: number = 1000

`Protected` isActive

isActive: boolean = false

`Private` isDown

isDown: boolean = false

`Private` mode

mode: DragMode = 'update'

`Private` offsetX

offsetX: number = 0

`Private` plotInterval

plotInterval: number = 0.0625

`Protected` sampleRate

sampleRate: number

`Private` sprite

sprite: string = 'rgba(255, 255, 255, 0.25)'

`Private` startTime

startTime: number = 0

`Protected` styles

styles: GraphicsStyles = ...

`Protected` svg

svg: null | SVGSVGElement = null

`Private` textInterval

textInterval: number = 60

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

clear

clear(): TimeOverview
Returns TimeOverview
Overrides Visualizer.clear
- Defined in SoundModule/Analyser/TimeOverview.ts:364

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

`Protected` createFontString

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

Returns string
Inherited from Visualizer.createFontString
- Defined in SoundModule/Analyser/Visualizer.ts:491

`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:459

deactivate

deactivate(): TimeOverview
Returns TimeOverview
Overrides Visualizer.deactivate
- Defined in SoundModule/Analyser/TimeOverview.ts:376

drag

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

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

`Private` getOffsetX

getOffsetX(event): number
This method returns X coordinate from instance of MouseEvent or TouchEvent.
Parameters
- event: MouseEvent | TouchEvent
  
  This argument is instance of MouseEvent or TouchEvent.
Returns number
Return value is X coordinate as mouse or touch position.
- Defined in SoundModule/Analyser/TimeOverview.ts:781

`Private` onMouseMove

onMouseMove(event): void
This method is event listener for visualizing rectangle.
Parameters
- event: MouseEvent
  
  This argument is instance of MouseEvent.
Returns void
- Defined in SoundModule/Analyser/TimeOverview.ts:699

`Private` onMouseStart

onMouseStart(event): void
This method is event listener for visualizing rectangle.
Parameters
- event: MouseEvent
  
  This argument is instance of MouseEvent.
Returns void
- Defined in SoundModule/Analyser/TimeOverview.ts:687

`Private` onMouseUp

onMouseUp(event): void
This method is event listener for visualizing rectangle.
Parameters
- event: MouseEvent
  
  This argument is instance of MouseEvent.
Returns void
- Defined in SoundModule/Analyser/TimeOverview.ts:716

`Private` onTouchEnd

onTouchEnd(event): void
This method is event listener for visualizing rectangle.
Parameters
- event: TouchEvent
  
  This argument is instance of TouchEvent.
Returns void
- Defined in SoundModule/Analyser/TimeOverview.ts:764

`Private` onTouchMove

onTouchMove(event): void
This method is event listener for visualizing rectangle.
Parameters
- event: TouchEvent
  
  This argument is instance of TouchEvent.
Returns void
- Defined in SoundModule/Analyser/TimeOverview.ts:744

`Private` onTouchStart

onTouchStart(event): void
This method is event listener for visualizing rectangle.
Parameters
- event: TouchEvent
  
  This argument is instance of TouchEvent.
Returns void
- Defined in SoundModule/Analyser/TimeOverview.ts:732

param

param(params): 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:88
param(params): GraphicsStyles
Parameters
- params: "styles"
Returns GraphicsStyles
Overrides Visualizer.param
- Defined in SoundModule/Analyser/TimeOverview.ts:89
param(params): CurrentTimeStyles
Parameters
- params: "currentTime"
Returns CurrentTimeStyles
Overrides Visualizer.param
- Defined in SoundModule/Analyser/TimeOverview.ts:90
param(params): string
Parameters
- params: "sprite"
Returns string
Overrides Visualizer.param
- Defined in SoundModule/Analyser/TimeOverview.ts:91
param(params): number
Parameters
- params: "plotInterval"
Returns number
Overrides Visualizer.param
- Defined in SoundModule/Analyser/TimeOverview.ts:92
param(params): number
Parameters
- params: "textInterval"
Returns number
Overrides Visualizer.param
- Defined in SoundModule/Analyser/TimeOverview.ts:93
param(params): DragMode
Parameters
- params: "mode"
Returns DragMode
Overrides Visualizer.param
- Defined in SoundModule/Analyser/TimeOverview.ts:94
param(params): TimeOverview
Parameters
- params: TimeOverviewParams
Returns TimeOverview
Overrides Visualizer.param
- Defined in SoundModule/Analyser/TimeOverview.ts:95

setup

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

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

update

update(time): 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:167

`Private` visualize

visualize(event, type, offsetX): void
This method visualizes rectangle for audio current time.
Parameters
- event: MouseEvent | TouchEvent
  
  This argument is instance of MouseEvent or TouchEvent.
- type: MouseEventTypes
  
  This argument is one of 'mousedown', 'mousemove', 'mouseup', 'touchstart', 'touchmove', 'touchend'.
- offsetX: number
  
  This argument is X coordinate on Canvas or SVG from window.
Returns void
- Defined in SoundModule/Analyser/TimeOverview.ts:620

`Protected` visualizeBySVG

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

`Protected` visualizeOnCanvas

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

`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:368

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

Class TimeOverview

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

sampleRate: number

channel: ChannelNumber

Returns TimeOverview

Properties

Private callback

Protected canvas

Protected channel

Protected context

Private currentDataSize

Private currentImageData

Private currentSVGElement

Private currentTime

Private endTime

Protected graphics

Protected interval

Protected isActive

Private isDown

Private mode

Private offsetX

Private plotInterval

Protected sampleRate

Private sprite

Private startTime

Protected styles

Protected svg

Private textInterval

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 TimeOverview

clear

Returns TimeOverview

create

Returns string

Protected createFontString

Returns string

Protected createSVGLinearGradient

Parameters

linearGradientId: string

Returns null | SVGDefsElement

deactivate

Returns TimeOverview

drag

Parameters

Optional callback: DragCallbackFunction

Returns TimeOverview

get

Returns null | HTMLCanvasElement | SVGSVGElement

Private getOffsetX

Parameters

event: MouseEvent | TouchEvent

Returns number

Private onMouseMove

Parameters

event: MouseEvent

Returns void

Private onMouseStart

Parameters

event: MouseEvent

Returns void

Private onMouseUp

Parameters

event: MouseEvent

Returns void

Private onTouchEnd

Parameters

event: TouchEvent

`Private` callback

`Protected` canvas

`Protected` channel

`Protected` context

`Private` currentDataSize

`Private` currentImageData

`Private` currentSVGElement

`Private` currentTime

`Private` endTime

`Protected` graphics

`Protected` interval

`Protected` isActive

`Private` isDown

`Private` mode

`Private` offsetX

`Private` plotInterval

`Protected` sampleRate

`Private` sprite

`Private` startTime

`Protected` styles

`Protected` svg

`Private` textInterval

`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` callback: DragCallbackFunction

`Private` getOffsetX

`Private` onMouseMove

`Private` onMouseStart

`Private` onMouseUp

`Private` onTouchEnd

`Private` onTouchMove

`Private` onTouchStart

`Optional` minDecibels: number

`Optional` maxDecibels: number

`Private` visualize

`Protected` visualizeBySVG

`Optional` _minDecibels: number

`Optional` _maxDecibels: number

`Protected` visualizeOnCanvas

`Optional` _minDecibels: number

`Optional` _maxDecibels: number

`Protected` visualizeTimeDomainFloat32ArrayBySVG