public class | source

Vizualizer

Small library to simplify the creation of audio visualisation

Static Method Summary

Static Public Methods
public static	withArrayBuffer(arrayBuffer: ArrayBuffer, bufferLength: number): Vizualizer Create a new Vizualizer with the specified array buffer
public static	withContextSource(context: AudioContext, source: AudioSourceNode, bufferLength: number): Vizualizer Create a new Vizualizer with the specified audio context and source
public static	withElement(element: Element, bufferLength: number): Vizualizer Create a new Vizualizer with the specified audio element
public static	withMedia(mediaUrl: String, bufferLength: number): Vizualizer Create a new Vizualizer with the specified url of a media

Constructor Summary

Public Constructor
public	constructor Default constructor with null members

Member Summary

Public Members
public	audioAnalyser: AnalyserNode Audio Analyser
public	audioContext: AudioContext Audio Context
public	audioElement: Element Audio Element
public	audioSource: AudioSourceNode Audio Source
public	dataArray: Uint8Array Array of data of the audio
public	effects: Array Array of effects
public	requestId: number The ID value returned by the call to window.requestAnimationFrame()

Method Summary

Public Methods
public	addEffect(effect: EffectVizualizer) Add an effect at the end of the array
public	changeEffect(effectVizualizer: EffectVizualizer, i: number) Change the effect of the vizualizer
public	initializeVisibilityEvent() Initialize the visibilty change event to stop the visualisation when the page is not visible.
public	loadArrayBuffer(arraybuffer: ArrayBuffer) Load the vizualizer with the specified array buffer
public	loadAudioContext(context: AudioContext) Change the audio context
public	loadDataUrl(dataUrl: string) Load the vizualizer with the specified data url
public	loadElement(element: Element) Change the audio element
public	popEffect() Remove the last effect added
public	removeEffect(index: number) Remove the effect specified by the index
public	start() Start the visualisation
public	startRender() Render every effect in the array effects
public	stop() Stop the visualisation

Static Public Methods

public static withArrayBuffer(arrayBuffer: ArrayBuffer, bufferLength: number): Vizualizer source

Create a new Vizualizer with the specified array buffer

Params:

Name	Type	Attribute	Description
arrayBuffer	ArrayBuffer		Array buffer
bufferLength	number	optional default: 1024	The length of the buffer

Return:

Vizualizer

Return a new Vizualizer

Throw:

Error

Web Audio not supported by the browser

public static withContextSource(context: AudioContext, source: AudioSourceNode, bufferLength: number): Vizualizer source

Create a new Vizualizer with the specified audio context and source

Params:

Name	Type	Attribute	Description
context	AudioContext		Audio context
source	AudioSourceNode		Source
bufferLength	number	optional default: 1024	The length of the buffer

Return:

Vizualizer

Return a new Vizualizer

public static withElement(element: Element, bufferLength: number): Vizualizer source

Create a new Vizualizer with the specified audio element

Params:

Name	Type	Attribute	Description
element	Element		Audio element <audio>
bufferLength	number	optional default: 1024	The length of the buffer

Return:

Vizualizer

Return a new Vizualizer

Throw:

Error

Web Audio not supported by the browser

public static withMedia(mediaUrl: String, bufferLength: number): Vizualizer source

Create a new Vizualizer with the specified url of a media

Params:

Name	Type	Attribute	Description
mediaUrl	String		Url of the media
bufferLength	number	optional default: 1024	The length of the buffer

Return:

Vizualizer

Return a new Vizualizer

Throw:

Error

Web Audio not supported by the browser

Public Constructors

public constructor source

Default constructor with null members

Public Members

public audioAnalyser: AnalyserNode source

Audio Analyser

public audioContext: AudioContext source

Audio Context

public audioElement: Element source

Audio Element

public audioSource: AudioSourceNode source

Audio Source

public dataArray: Uint8Array source

Array of data of the audio

public effects: Array source

Array of effects

public requestId: number source

The ID value returned by the call to window.requestAnimationFrame()

Public Methods

public addEffect(effect: EffectVizualizer) source

Add an effect at the end of the array

Params:

Name	Type	Attribute	Description
effect	EffectVizualizer		Effect to add

public changeEffect(effectVizualizer: EffectVizualizer, i: number) source

Change the effect of the vizualizer

Params:

Name	Type	Attribute	Description
effectVizualizer	EffectVizualizer		Effect
i	number	optional default: 0	Index of the effect to change

public initializeVisibilityEvent() source

Initialize the visibilty change event to stop the visualisation when the page is not visible.

public loadArrayBuffer(arraybuffer: ArrayBuffer) source

Load the vizualizer with the specified array buffer

Params:

Name	Type	Attribute	Description
arraybuffer	ArrayBuffer		Array buffer to load

public loadAudioContext(context: AudioContext) source

Change the audio context

Params:

Name	Type	Attribute	Description
context	AudioContext		AudioContext

public loadDataUrl(dataUrl: string) source

Load the vizualizer with the specified data url

Params:

Name	Type	Attribute	Description
dataUrl	string		Url of the data

public loadElement(element: Element) source

Change the audio element

Params:

Name	Type	Attribute	Description
element	Element		Element

public popEffect() source

Remove the last effect added

public removeEffect(index: number) source

Remove the effect specified by the index

Params:

Name	Type	Attribute	Description
index	number		Index of the element that should be remove from the effects array

public start() source

Start the visualisation

public startRender() source

Render every effect in the array effects

public stop() source

Stop the visualisation