Home Manual Reference Source 
import VolumeMeter from 'itslanguage/audio/audio-tools.js'
public class | source

VolumeMeter

Static Method Summary

Static Private Methods
private static

_getAverageVolume(array: *): *

Constructor Summary

Public Constructor
public

constructor(audioContext: AudioContext, inputStream: MediaStream)

Represents a volume meter.

Member Summary

Public Members
public
public
public

stream: *

public
public
public

Method Summary

Public Methods
public

getVolumeIndication(callback: Function, args: Array)

Start analysing the audio stream and provide updates to the specified callback function.
public

Start calculating the volume.
public

Stop calculating the volume.
Private Methods
private

Calculate the volume, inform listeners by executing the callback.

Static Private Methods

private static _getAverageVolume(array: *): * source

Params:

NameTypeAttributeDescription
array *

Return:

*

Public Constructors

public constructor(audioContext: AudioContext, inputStream: MediaStream) source

Represents a volume meter.

Params:

NameTypeAttributeDescription
audioContext AudioContext

The WebAudio context.
inputStream MediaStream

The MediaStream to analyze.

Public Members

public analyserNode: * source

public audioContext: * source

public stream: * source

public volumeIndicationCallback: * source

public volumeIndicationCallbackArgs: * source

public willAnimate: boolean source

Public Methods

public getVolumeIndication(callback: Function, args: Array) source

Start analysing the audio stream and provide updates to the specified callback function.

Params:

NameTypeAttributeDescription
callback Function

This function is called when there's a new volume reading is available. First parameter is the volume.
args Array
  • nullable: true

Optional array of parameters to pass to the callback after the volume parameter.

public resumeAnalyser() source

Start calculating the volume.

public stopAnalyser() source

Stop calculating the volume.

Private Methods

private _updateAnalysers() source

Calculate the volume, inform listeners by executing the callback. Repeat indefinitely.