View as markdown
Copy for LLM Open in ChatGPT Open in Claude Open in Perplexity

WebAudio

Experimental

This domain allows inspection of Web Audio API. https://webaudio.github.io/web-audio-api/

Commands

WebAudio.enable

Enables the WebAudio domain and starts sending context lifetime events.

WebAudio.disable

Disables the WebAudio domain.

WebAudio.getRealtimeData

Fetch the realtime data from the registered contexts.

Parameters
Name Type Description
contextId GraphObjectId
Return Object
Name Type Description
realtimeData ContextRealtimeData

Events

WebAudio.contextCreated

Notifies that a new BaseAudioContext has been created.

Parameters
Name Type Description
context BaseAudioContext

WebAudio.contextWillBeDestroyed

Notifies that an existing BaseAudioContext will be destroyed.

Parameters
Name Type Description
contextId GraphObjectId

WebAudio.contextChanged

Notifies that existing BaseAudioContext has changed some properties (id stays the same)..

Parameters
Name Type Description
context BaseAudioContext

WebAudio.audioListenerCreated

Notifies that the construction of an AudioListener has finished.

Parameters
Name Type Description
listener AudioListener

WebAudio.audioListenerWillBeDestroyed

Notifies that a new AudioListener has been created.

Parameters
Name Type Description
contextId GraphObjectId
listenerId GraphObjectId

WebAudio.audioNodeCreated

Notifies that a new AudioNode has been created.

Parameters
Name Type Description
node AudioNode

WebAudio.audioNodeWillBeDestroyed

Notifies that an existing AudioNode has been destroyed.

Parameters
Name Type Description
contextId GraphObjectId
nodeId GraphObjectId

WebAudio.audioParamCreated

Notifies that a new AudioParam has been created.

Parameters
Name Type Description
param AudioParam

WebAudio.audioParamWillBeDestroyed

Notifies that an existing AudioParam has been destroyed.

Parameters
Name Type Description
contextId GraphObjectId
nodeId GraphObjectId
paramId GraphObjectId

WebAudio.nodesConnected

Notifies that two AudioNodes are connected.

Parameters
Name Type Description
contextId GraphObjectId
sourceId GraphObjectId
destinationId GraphObjectId
sourceOutputIndex (optional) number
destinationInputIndex (optional) number

WebAudio.nodesDisconnected

Notifies that AudioNodes are disconnected. The destination can be null, and it means all the outgoing connections from the source are disconnected.

Parameters
Name Type Description
contextId GraphObjectId
sourceId GraphObjectId
destinationId GraphObjectId
sourceOutputIndex (optional) number
destinationInputIndex (optional) number

WebAudio.nodeParamConnected

Notifies that an AudioNode is connected to an AudioParam.

Parameters
Name Type Description
contextId GraphObjectId
sourceId GraphObjectId
destinationId GraphObjectId
sourceOutputIndex (optional) number

WebAudio.nodeParamDisconnected

Notifies that an AudioNode is disconnected to an AudioParam.

Parameters
Name Type Description
contextId GraphObjectId
sourceId GraphObjectId
destinationId GraphObjectId
sourceOutputIndex (optional) number

Types

GraphObjectId

(string)

An unique ID for a graph object (AudioContext, AudioNode, AudioParam) in Web Audio API

ContextType

(string)

Enum of BaseAudioContext types

Allowed Values
  • realtime
  • offline

ContextState

(string)

Enum of AudioContextState from the spec

Allowed Values
  • suspended
  • running
  • closed
  • interrupted

NodeType

(string)

Enum of AudioNode types

ChannelCountMode

(string)

Enum of AudioNode::ChannelCountMode from the spec

Allowed Values
  • clamped-max
  • explicit
  • max

ChannelInterpretation

(string)

Enum of AudioNode::ChannelInterpretation from the spec

Allowed Values
  • discrete
  • speakers

ParamType

(string)

Enum of AudioParam types

AutomationRate

(string)

Enum of AudioParam::AutomationRate from the spec

Allowed Values
  • a-rate
  • k-rate

ContextRealtimeData

(object)

Fields in AudioContext that change in real-time.

Properties
Name Type Description
currentTime number The current context time in second in BaseAudioContext.
renderCapacity number The time spent on rendering graph divided by render quantum duration,
and multiplied by 100. 100 means the audio renderer reached the full
capacity and glitch may occur.
callbackIntervalMean number A running mean of callback interval.
callbackIntervalVariance number A running variance of callback interval.

BaseAudioContext

(object)

Protocol object for BaseAudioContext

Properties
Name Type Description
contextId GraphObjectId
contextType ContextType
contextState ContextState
realtimeData (optional) ContextRealtimeData
callbackBufferSize number Platform-dependent callback buffer size.
maxOutputChannelCount number Number of output channels supported by audio hardware in use.
sampleRate number Context sample rate.

AudioListener

(object)

Protocol object for AudioListener

Properties
Name Type Description
listenerId GraphObjectId
contextId GraphObjectId

AudioNode

(object)

Protocol object for AudioNode

Properties
Name Type Description
nodeId GraphObjectId
contextId GraphObjectId
nodeType NodeType
numberOfInputs number
numberOfOutputs number
channelCount number
channelCountMode ChannelCountMode
channelInterpretation ChannelInterpretation

AudioParam

(object)

Protocol object for AudioParam

Properties
Name Type Description
paramId GraphObjectId
nodeId GraphObjectId
contextId GraphObjectId
paramType ParamType
rate AutomationRate
defaultValue number
minValue number
maxValue number

Summary