Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AudioNode

Package version

A generic interface for representing an audio processing module. Examples include:

Hierarchy

Index

Properties

EventTarget

EventTarget: { constructor: any; prototype: EventTarget }

Type declaration

  • constructor: function
    • Returns EventTarget

  • prototype: EventTarget

channelCount

channelCount: number

channelCountMode

channelCountMode: ChannelCountMode

channelInterpretation

channelInterpretation: ChannelInterpretation

context

numberOfInputs

numberOfInputs: number

numberOfOutputs

numberOfOutputs: number

Methods

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.

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

    Parameters

    Returns void

connect

  • connect(destinationNode: AudioNode, output?: undefined | number, input?: undefined | number): AudioNode
  • connect(destinationParam: AudioParam, output?: undefined | number): void
  • Parameters

    • destinationNode: AudioNode
    • Optional output: undefined | number
    • Optional input: undefined | number

    Returns AudioNode

  • Parameters

    • destinationParam: AudioParam
    • Optional output: undefined | number

    Returns void

disconnect

  • disconnect(): void
  • disconnect(output: number): void
  • disconnect(destinationNode: AudioNode): void
  • disconnect(destinationNode: AudioNode, output: number): void
  • disconnect(destinationNode: AudioNode, output: number, input: number): void
  • disconnect(destinationParam: AudioParam): void
  • disconnect(destinationParam: AudioParam, output: number): void
  • Returns void

  • Parameters

    • output: number

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • destinationNode: AudioNode
    • output: number
    • input: number

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

dispatchEvent

  • dispatchEvent(event: Event): boolean
  • 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.

    Parameters

    Returns boolean

removeEventListener

Generated using TypeDoc