Chrome DevTools Protocol

Methods

WebAudio.disable

Disables the WebAudio domain.

WebAudio.enable

Enables the WebAudio domain and starts sending context lifetime events.

WebAudio.getRealtimeData

Fetch the realtime data from the registered contexts.

parameters
contextId
GraphObjectId
Return Object
realtimeData
ContextRealtimeData

Events

WebAudio.audioListenerCreated

Notifies that the construction of an AudioListener has finished.

parameters
listener
AudioListener

WebAudio.audioListenerWillBeDestroyed

Notifies that a new AudioListener has been created.

parameters
contextId
GraphObjectId
listenerId
GraphObjectId

WebAudio.audioNodeCreated

Notifies that a new AudioNode has been created.

parameters
node
AudioNode

WebAudio.audioNodeWillBeDestroyed

Notifies that an existing AudioNode has been destroyed.

parameters
contextId
GraphObjectId
nodeId
GraphObjectId

WebAudio.audioParamCreated

Notifies that a new AudioParam has been created.

parameters
param
AudioParam

WebAudio.audioParamWillBeDestroyed

Notifies that an existing AudioParam has been destroyed.

parameters
contextId
GraphObjectId
nodeId
GraphObjectId
paramId
GraphObjectId

WebAudio.contextChanged

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

parameters
context
BaseAudioContext

WebAudio.contextCreated

Notifies that a new BaseAudioContext has been created.

parameters
context
BaseAudioContext

WebAudio.contextWillBeDestroyed

Notifies that an existing BaseAudioContext will be destroyed.

parameters
contextId
GraphObjectId

WebAudio.nodeParamConnected

Notifies that an AudioNode is connected to an AudioParam.

parameters
contextId
GraphObjectId
sourceId
GraphObjectId
destinationId
GraphObjectId
sourceOutputIndex
number

WebAudio.nodeParamDisconnected

Notifies that an AudioNode is disconnected to an AudioParam.

parameters
contextId
GraphObjectId
sourceId
GraphObjectId
destinationId
GraphObjectId
sourceOutputIndex
number

WebAudio.nodesConnected

Notifies that two AudioNodes are connected.

parameters
contextId
GraphObjectId
sourceId
GraphObjectId
destinationId
GraphObjectId
sourceOutputIndex
number
destinationInputIndex
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
contextId
GraphObjectId
sourceId
GraphObjectId
destinationId
GraphObjectId
sourceOutputIndex
number
destinationInputIndex
number

Types

WebAudio.AudioListener

Protocol object for AudioListner

Type: object

properties
listenerId
GraphObjectId
contextId
GraphObjectId

WebAudio.AudioNode

Protocol object for AudioNode

Type: object

properties
nodeId
GraphObjectId
contextId
GraphObjectId
nodeType
NodeType
numberOfInputs
number
numberOfOutputs
number
channelCount
number
channelCountMode
ChannelCountMode
channelInterpretation
ChannelInterpretation

WebAudio.AudioParam

Protocol object for AudioParam

Type: object

properties
paramId
GraphObjectId
nodeId
GraphObjectId
contextId
GraphObjectId
paramType
ParamType
rate
AutomationRate
defaultValue
number
minValue
number
maxValue
number

WebAudio.AutomationRate

Enum of AudioParam::AutomationRate from the spec

Allowed Values: a-rate, k-rate

Type: string

WebAudio.BaseAudioContext

Protocol object for BaseAudioContext

Type: object

properties
contextId
GraphObjectId
contextType
ContextType
contextState
ContextState
realtimeData
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.

WebAudio.ChannelCountMode

Enum of AudioNode::ChannelCountMode from the spec

Allowed Values: clamped-max, explicit, max

Type: string

WebAudio.ChannelInterpretation

Enum of AudioNode::ChannelInterpretation from the spec

Allowed Values: discrete, speakers

Type: string

WebAudio.ContextRealtimeData

Fields in AudioContext that change in real-time.

Type: object

properties
currentTime
number

The current context time in second in BaseAudioContext.

renderCapacity
number

The time spent on rendering graph divided by render qunatum 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.

WebAudio.ContextState

Enum of AudioContextState from the spec

Allowed Values: suspended, running, closed

Type: string

WebAudio.ContextType

Enum of BaseAudioContext types

Allowed Values: realtime, offline

Type: string

WebAudio.GraphObjectId

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

Type: string

WebAudio.NodeType

Enum of AudioNode types

Type: string

WebAudio.ParamType

Enum of AudioParam types

Type: string