• Public
  • Public/Protected
  • All

Interface GainNode

A change in volume. It is an AudioNode audio-processing module that causes a given gain to be applied to the input data before its propagation to the output. A GainNode always has exactly one input and one output, both with the same number of channels.





AudioNode: { constructor: any; prototype: AudioNode }

Type declaration

  • constructor: function
    • Returns AudioNode

  • prototype: AudioNode


channelCount: number


channelCountMode: ChannelCountMode


channelInterpretation: ChannelInterpretation

Readonly context

Readonly gain

Readonly numberOfInputs

numberOfInputs: number

Readonly numberOfOutputs

numberOfOutputs: number



  • 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.


    Returns void


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

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

    Returns AudioNode

  • Parameters

    • destinationParam: AudioParam
    • Optional output: number

    Returns void


  • 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(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.


    Returns boolean


Generated using TypeDoc