Class: VisuComponentMono

VisuComponentMono(options)

new VisuComponentMono(options)

VisuComponentMono is an abstraction for mono visualisation component. It must be inherited.

Mono components inherit this class to benefit its node routing and canvas configuration. It is meant to use a single canvas for mono or merged L/R audio channels. This class extends BaseComponent to benefits all shared properties between visualisations.
Parameters:
Name Type Description
options object

The visualizer root options

Properties
Name Type Attributes Default Description
type string

The component type as string
player object

The player to take as processing input (if inputNode is given, player source will be ignored)
renderTo object

The DOM element to render canvas in
fftSize number

The FFT size for analysis. Must be a power of 2. High values may lead to heavy CPU cost
audioContext object <optional>
 null

The audio context to base analysis from
inputNode object <optional>
 null

The audio node to take source instead of player's one
Since:
  • 2020
Author:
  • Arthur Beaulieu
Source:

Extends

Members

(private) _audioCtx :object

The audio context

Type:
  • object
Overrides:
Source:

(private) _canvas :object

The canvas to rendered mono data to

Type:
  • object
Source:

(private) _ctx :object

The canvas associated context

Type:
  • object
Source:

(private) _dom :object

Contains all useful DOM objects

Type:
  • object
Inherited From:
Source:

(private) _fftSize :number

FFT size used to analyse audio stream. Must be a power of 2

Type:
  • number
Overrides:
Source:

(private) _inputNode :object

The source node to chain from ; it will ignore the output of HTML audio player

Type:
  • object
Overrides:
Source:

(private) _isPlaying :boolean

The playing state of the player

Type:
  • boolean
Inherited From:
Source:

(private) _nodes :object

Audio nodes from web audio API to manipulate data with

Type:
  • object
Source:

(private) _parentDimension :object

Save container dimension to restore when closing fullscreen

Type:
  • object
Inherited From:
Source:

(private) _player :object

The audio source (HTML audio player)

Type:
  • object
Overrides:
Source:

(private) _renderTo :object

Target div to render module in

Type:
  • object
Overrides:
Source:

(private) _resizeObserver :object

Resize observable to watch for any resize change

Type:
  • object
Inherited From:
Source:

(private) _type :string

The component type. See supported componenets in AudioVisualizer factory

Type:
  • string
Overrides:
Source:

Methods

(private, static) _buildUI()

Create and configure canvas then append it to given DOM element.
Since:
  • 2020
Author:
  • Arthur Beaulieu
Source:

(private, static) _clearCanvas()

Clear component canvas context from its content.
Since:
  • 2020
Author:
  • Arthur Beaulieu
Source:

(private, static) _fillAttributes(options)

Internal method to fill internal properties from options object sent to constructor.
Parameters:
Name Type Description
options object

The visualizer root options

Properties
Name Type Attributes Default Description
type string

The component type as string
player object

The player to take as processing input (if inputNode is given, player source will be ignored)
renderTo object

The DOM element to render canvas in
fftSize number

The FFT size for analysis. Must be a power of 2. High values may lead to heavy CPU cost
audioContext object <optional>
 null

The audio context to base analysis from
inputNode object <optional>
 null

The audio node to take source instead of player's one
Since:
  • 2020
Author:
  • Arthur Beaulieu
Source:

(private, static) _onResize()

On resize event callback.
Since:
  • 2020
Author:
  • Arthur Beaulieu
Source:

(private, static) _setAudioNodes()

Build audio chain with source -> analyzer -> destination.
Since:
  • 2020
Author:
  • Arthur Beaulieu
Source: