Class AbstractAnalyzer`Abstract`

Abstract analyzer widget.

This class is the basic class to inherit and implement other widgets.

Hierarchy (View Summary)

AbstractAnalyzer

Index

Constructors

Methods

changeAudioSource clear getAudioSource getViewElement pause resize start stop

Constructors

constructor

new AbstractAnalyzer(
    audioSource?: HTMLMediaElement | MediaElementAudioSourceNode,
    viewElement?: HTMLElement,
    options?: IAbstractAnalyzerOptions,
): AbstractAnalyzer
Constructor.
Parameters
- OptionalaudioSource: HTMLMediaElement | MediaElementAudioSourceNode
  Input HTML element with source audio (HTML audio tag) or the instance of MediaElementAudioSourceNode.
- OptionalviewElement: HTMLElement
  The HTML element to render the widget. Will be auto created if it is undefined or null.
- Optionaloptions: IAbstractAnalyzerOptions
  Analyzer options.
Returns AbstractAnalyzer

Methods

changeAudioSource

changeAudioSource(
audioSource?: HTMLMediaElement | MediaElementAudioSourceNode,
): void
Changes the current media source.
Parameters
- OptionalaudioSource: HTMLMediaElement | MediaElementAudioSourceNode
  Input HTML element with source audio (HTML audio tag) or the instance of MediaElementAudioSourceNode.
Returns void

clear

clear(): void
Clears the canvas.

Returns void

getAudioSource

getAudioSource(): IAudioSource
Returns the audio source structure for this instance.

Returns IAudioSource
The audio source structure.

getViewElement

getViewElement(): HTMLElement
Returns the ViewElement for this instance.

Returns HTMLElement

pause

pause(): void
Pauses rendering.

Returns void

resize

resize(): void
Updates the canvas size depended on the [[constructor|viewElement]] size.

Returns void

start

start(): void
Starts rendering.

Returns void

stop

stop(): void
Stops rendering.

Returns void