Table of Contents

Interface IWebAudio

Namespace
Selenium.WebDriver.BiDi.Cdp.WebAudio
Assembly
Selenium.WebDriver.BiDi.Cdp.dll

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

[Experimental("BIDICDP001")]
public interface IWebAudio

Properties

AudioListenerCreated

Notifies that the construction of an AudioListener has finished.

IEventSource<AudioListenerCreatedEventArgs> AudioListenerCreated { get; }

Property Value

IEventSource<AudioListenerCreatedEventArgs>

Remarks

Event args (AudioListenerCreatedEventArgs):

  • Listener

AudioListenerWillBeDestroyed

Notifies that a new AudioListener has been created.

IEventSource<AudioListenerWillBeDestroyedEventArgs> AudioListenerWillBeDestroyed { get; }

Property Value

IEventSource<AudioListenerWillBeDestroyedEventArgs>

Remarks

Event args (AudioListenerWillBeDestroyedEventArgs):

  • ContextId
  • ListenerId

AudioNodeCreated

Notifies that a new AudioNode has been created.

IEventSource<AudioNodeCreatedEventArgs> AudioNodeCreated { get; }

Property Value

IEventSource<AudioNodeCreatedEventArgs>

Remarks

Event args (AudioNodeCreatedEventArgs):

  • Node

AudioNodeWillBeDestroyed

Notifies that an existing AudioNode has been destroyed.

IEventSource<AudioNodeWillBeDestroyedEventArgs> AudioNodeWillBeDestroyed { get; }

Property Value

IEventSource<AudioNodeWillBeDestroyedEventArgs>

Remarks

Event args (AudioNodeWillBeDestroyedEventArgs):

  • ContextId
  • NodeId

AudioParamCreated

Notifies that a new AudioParam has been created.

IEventSource<AudioParamCreatedEventArgs> AudioParamCreated { get; }

Property Value

IEventSource<AudioParamCreatedEventArgs>

Remarks

Event args (AudioParamCreatedEventArgs):

  • Param

AudioParamWillBeDestroyed

Notifies that an existing AudioParam has been destroyed.

IEventSource<AudioParamWillBeDestroyedEventArgs> AudioParamWillBeDestroyed { get; }

Property Value

IEventSource<AudioParamWillBeDestroyedEventArgs>

Remarks

Event args (AudioParamWillBeDestroyedEventArgs):

  • ContextId
  • NodeId
  • ParamId

ContextChanged

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

IEventSource<ContextChangedEventArgs> ContextChanged { get; }

Property Value

IEventSource<ContextChangedEventArgs>

Remarks

Event args (ContextChangedEventArgs):

  • Context

ContextCreated

Notifies that a new BaseAudioContext has been created.

IEventSource<ContextCreatedEventArgs> ContextCreated { get; }

Property Value

IEventSource<ContextCreatedEventArgs>

Remarks

Event args (ContextCreatedEventArgs):

  • Context

ContextWillBeDestroyed

Notifies that an existing BaseAudioContext will be destroyed.

IEventSource<ContextWillBeDestroyedEventArgs> ContextWillBeDestroyed { get; }

Property Value

IEventSource<ContextWillBeDestroyedEventArgs>

Remarks

Event args (ContextWillBeDestroyedEventArgs):

  • ContextId

NodeParamConnected

Notifies that an AudioNode is connected to an AudioParam.

IEventSource<NodeParamConnectedEventArgs> NodeParamConnected { get; }

Property Value

IEventSource<NodeParamConnectedEventArgs>

Remarks

Event args (NodeParamConnectedEventArgs):

  • ContextId
  • SourceId
  • DestinationId
  • SourceOutputIndex

NodeParamDisconnected

Notifies that an AudioNode is disconnected to an AudioParam.

IEventSource<NodeParamDisconnectedEventArgs> NodeParamDisconnected { get; }

Property Value

IEventSource<NodeParamDisconnectedEventArgs>

Remarks

Event args (NodeParamDisconnectedEventArgs):

  • ContextId
  • SourceId
  • DestinationId
  • SourceOutputIndex

NodesConnected

Notifies that two AudioNodes are connected.

IEventSource<NodesConnectedEventArgs> NodesConnected { get; }

Property Value

IEventSource<NodesConnectedEventArgs>

Remarks

Event args (NodesConnectedEventArgs):

  • ContextId
  • SourceId
  • DestinationId
  • SourceOutputIndex
  • DestinationInputIndex

NodesDisconnected

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

IEventSource<NodesDisconnectedEventArgs> NodesDisconnected { get; }

Property Value

IEventSource<NodesDisconnectedEventArgs>

Remarks

Event args (NodesDisconnectedEventArgs):

  • ContextId
  • SourceId
  • DestinationId
  • SourceOutputIndex
  • DestinationInputIndex

Methods

DisableAsync(string?, CancellationToken)

Disables the WebAudio domain.

Task<DisableResult> DisableAsync(string? session = null, CancellationToken cancellationToken = default)

Parameters

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<DisableResult>

A task representing the asynchronous operation, containing a DisableResult.

EnableAsync(string?, CancellationToken)

Enables the WebAudio domain and starts sending context lifetime events.

Task<EnableResult> EnableAsync(string? session = null, CancellationToken cancellationToken = default)

Parameters

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<EnableResult>

A task representing the asynchronous operation, containing a EnableResult.

GetRealtimeDataAsync(GraphObjectId, string?, CancellationToken)

Fetch the realtime data from the registered contexts.

Task<GetRealtimeDataResult> GetRealtimeDataAsync(GraphObjectId contextId, string? session = null, CancellationToken cancellationToken = default)

Parameters

contextId GraphObjectId
session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<GetRealtimeDataResult>

A task representing the asynchronous operation, containing a GetRealtimeDataResult.