Skip to content
Experimental WebAPI

ConvolverNode

Values

addEventListener

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture. Read more on MDN

let addEventListener: (
  WebAudioTypes.convolverNode,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
  ~options: EventTypes.addEventListenerOptions=?,
) => unit

Parameters

WebAudioTypes.convolverNode EventTypes.eventType EventTypes.eventListener option< EventTypes.addEventListenerOptions >

Return type

unit

addEventListenerWithCapture

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture. Read more on MDN

let addEventListenerWithCapture: (
  WebAudioTypes.convolverNode,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
) => unit

Parameters

WebAudioTypes.convolverNode EventTypes.eventType EventTypes.eventListener

Return type

unit

asAudioNode

let asAudioNode: WebAudioTypes.convolverNode => WebAudioTypes.audioNode

Parameters

WebAudioTypes.convolverNode

Return type

WebAudioTypes.audioNode

asEventTarget

let asEventTarget: WebAudioTypes.convolverNode => EventTypes.eventTarget

Parameters

WebAudioTypes.convolverNode

Return type

EventTypes.eventTarget

connect

Read more on MDN

let connect: (
  WebAudioTypes.convolverNode,
  ~destinationNode: WebAudioTypes.audioNode,
  ~output: int=?,
  ~input: int=?,
) => WebAudioTypes.audioNode

Parameters

WebAudioTypes.convolverNode WebAudioTypes.audioNode option< int > option< int >

Return type

WebAudioTypes.audioNode

connect2

Read more on MDN

let connect2: (
  WebAudioTypes.convolverNode,
  ~destinationParam: WebAudioTypes.audioParam,
  ~output: int=?,
) => unit

Parameters

WebAudioTypes.convolverNode WebAudioTypes.audioParam option< int >

Return type

unit

disconnect

Read more on MDN

let disconnect: WebAudioTypes.convolverNode => unit

Parameters

WebAudioTypes.convolverNode

Return type

unit

disconnect2

Read more on MDN

let disconnect2: (WebAudioTypes.convolverNode, int) => unit

Parameters

WebAudioTypes.convolverNode int

Return type

unit

disconnect3

Read more on MDN

let disconnect3: (
  WebAudioTypes.convolverNode,
  WebAudioTypes.audioNode,
) => unit

Parameters

WebAudioTypes.convolverNode WebAudioTypes.audioNode

Return type

unit

disconnect4

Read more on MDN

let disconnect4: (
  WebAudioTypes.convolverNode,
  ~destinationNode: WebAudioTypes.audioNode,
  ~output: int,
) => unit

Parameters

WebAudioTypes.convolverNode WebAudioTypes.audioNode int

Return type

unit

disconnect5

Read more on MDN

let disconnect5: (
  WebAudioTypes.convolverNode,
  ~destinationNode: WebAudioTypes.audioNode,
  ~output: int,
  ~input: int,
) => unit

Parameters

WebAudioTypes.convolverNode WebAudioTypes.audioNode int int

Return type

unit

disconnect6

Read more on MDN

let disconnect6: (
  WebAudioTypes.convolverNode,
  WebAudioTypes.audioParam,
) => unit

Parameters

WebAudioTypes.convolverNode WebAudioTypes.audioParam

Return type

unit

disconnect7

Read more on MDN

let disconnect7: (
  WebAudioTypes.convolverNode,
  ~destinationParam: WebAudioTypes.audioParam,
  ~output: int,
) => unit

Parameters

WebAudioTypes.convolverNode WebAudioTypes.audioParam int

Return type

unit

dispatchEvent

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise. Read more on MDN

let dispatchEvent: (WebAudioTypes.convolverNode, EventTypes.event) => bool

Parameters

WebAudioTypes.convolverNode EventTypes.event

Return type

bool

make

Read more on MDN

let make: (
  ~context: WebAudioTypes.baseAudioContext,
  ~options: WebAudioTypes.convolverOptions=?,
) => WebAudioTypes.convolverNode

Parameters

WebAudioTypes.baseAudioContext option< WebAudioTypes.convolverOptions >

Return type

WebAudioTypes.convolverNode

removeEventListener

Removes the event listener in target's event listener list with the same type, callback, and options. Read more on MDN

let removeEventListener: (
  WebAudioTypes.convolverNode,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
  ~options: EventTypes.eventListenerOptions=?,
) => unit

Parameters

WebAudioTypes.convolverNode EventTypes.eventType EventTypes.eventListener option< EventTypes.eventListenerOptions >

Return type

unit

removeEventListenerUseCapture

Removes the event listener in target's event listener list with the same type, callback, and options. Read more on MDN

let removeEventListenerUseCapture: (
  WebAudioTypes.convolverNode,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
) => unit

Parameters

WebAudioTypes.convolverNode EventTypes.eventType EventTypes.eventListener

Return type

unit