Class NoiseGate

A NoiseGate node is intended to sit between a microphone and the outgoing or sending WebRTC connection. It will suppress audio at levels below the adjustable threshold. The NoiseGate node helps remove background noise and reduce the network bandwidth used to send audio. setupHRTF should be called before creating a NoiseGate node.

Example

let noiseGate = new NoiseGate(audioContext);
if (muted) {
    noiseGate.setThreshold(0);
} else {
    noiseGate.setThreshold(-40);
}
let sourceNode = audioContext.createMediaStreamSource(mediaStream);
sourceNode.connect(noiseGate).connect(destinationNode);

Hierarchy

AudioWorkletNode
- NoiseGate

Index

Constructors

constructor

new NoiseGate(audioContext: AudioContext): NoiseGate
Parameters
- audioContext: AudioContext
  
  The AudioContext to use. It should be created with a sample-rate of 48000.
Returns NoiseGate

Overrides AudioWorkletNode.constructor

Properties

channelCount

channelCount: number

channelCountMode

channelCountMode: ChannelCountMode

channelInterpretation

channelInterpretation: ChannelInterpretation

`Readonly` context

context: BaseAudioContext

`Readonly` numberOfInputs

numberOfInputs: number

`Readonly` numberOfOutputs

numberOfOutputs: number

onprocessorerror

onprocessorerror: ((this: AudioWorkletNode, ev: Event) => any)

Type declaration

- (this: AudioWorkletNode, ev: Event): any
- Parameters
  - this: AudioWorkletNode
  - ev: Event
  Returns any

`Readonly` parameters

parameters: AudioParamMap

`Readonly` port

port: MessagePort

Methods

addEventListener

addEventListener<K>(type: K, listener: ((this: AudioWorkletNode, ev: AudioWorkletNodeEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void
Type Parameters
- K extends "processorerror"
Parameters
- type: K
- listener: ((this: AudioWorkletNode, ev: AudioWorkletNodeEventMap[K]) => any)
  - - (this: AudioWorkletNode, ev: AudioWorkletNodeEventMap[K]): any
    - Parameters
      
      this: AudioWorkletNode
      
      ev: AudioWorkletNodeEventMap[K]
      
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void

Inherited from AudioWorkletNode.addEventListener
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void

Inherited from AudioWorkletNode.addEventListener

connect

connect(destinationNode: AudioNode, output?: number, input?: number): AudioNode
Parameters
- destinationNode: AudioNode
- Optional output: number
- Optional input: number
Returns AudioNode

Inherited from AudioWorkletNode.connect
connect(destinationParam: AudioParam, output?: number): void
Parameters
- destinationParam: AudioParam
- Optional output: number
Returns void

Inherited from AudioWorkletNode.connect

disconnect

disconnect(): void
Returns void

Inherited from AudioWorkletNode.disconnect
disconnect(output: number): void
Parameters
- output: number
Returns void

Inherited from AudioWorkletNode.disconnect
disconnect(destinationNode: AudioNode): void
Parameters
- destinationNode: AudioNode
Returns void

Inherited from AudioWorkletNode.disconnect
disconnect(destinationNode: AudioNode, output: number): void
Parameters
- destinationNode: AudioNode
- output: number
Returns void

Inherited from AudioWorkletNode.disconnect
disconnect(destinationNode: AudioNode, output: number, input: number): void
Parameters
- destinationNode: AudioNode
- output: number
- input: number
Returns void

Inherited from AudioWorkletNode.disconnect
disconnect(destinationParam: AudioParam): void
Parameters
- destinationParam: AudioParam
Returns void

Inherited from AudioWorkletNode.disconnect
disconnect(destinationParam: AudioParam, output: number): void
Parameters
- destinationParam: AudioParam
- output: number
Returns void

Inherited from AudioWorkletNode.disconnect

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
- event: Event
Returns boolean

Inherited from AudioWorkletNode.dispatchEvent

removeEventListener

removeEventListener<K>(type: K, listener: ((this: AudioWorkletNode, ev: AudioWorkletNodeEventMap[K]) => any), options?: boolean | EventListenerOptions): void
Type Parameters
- K extends "processorerror"
Parameters
- type: K
- listener: ((this: AudioWorkletNode, ev: AudioWorkletNodeEventMap[K]) => any)
  - - (this: AudioWorkletNode, ev: AudioWorkletNodeEventMap[K]): any
    - Parameters
      
      this: AudioWorkletNode
      
      ev: AudioWorkletNodeEventMap[K]
      
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void

Inherited from AudioWorkletNode.removeEventListener
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void

Inherited from AudioWorkletNode.removeEventListener

setThreshold

setThreshold(value: number): void
Parameters
- value: number
  
  A negative value between -80 and 0 which indicates a minimum decible level for the noise-gate to stop suppressing audio.
Returns void

Class NoiseGate

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

audioContext: AudioContext

Returns NoiseGate

Properties

channelCount

channelCountMode

channelInterpretation

Readonly context

Readonly numberOfInputs

Readonly numberOfOutputs

onprocessorerror

Type declaration

Parameters

this: AudioWorkletNode

ev: Event

Returns any

Readonly parameters

Readonly port

Methods

addEventListener

Type Parameters

K extends "processorerror"

Parameters

type: K

listener: ((this: AudioWorkletNode, ev: AudioWorkletNodeEventMap[K]) => any)

Parameters

this: AudioWorkletNode

ev: AudioWorkletNodeEventMap[K]

Returns any

Optional options: boolean | AddEventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

connect

Parameters

destinationNode: AudioNode

Optional output: number

Optional input: number

Returns AudioNode

Parameters

destinationParam: AudioParam

Optional output: number

Returns void

disconnect

Returns void

Parameters

output: number

Returns void

Parameters

destinationNode: AudioNode

Returns void

Parameters

destinationNode: AudioNode

output: number

Returns void

Parameters

destinationNode: AudioNode

output: number

input: number

Returns void

Parameters

destinationParam: AudioParam

Returns void

Parameters

destinationParam: AudioParam

output: number

Returns void

dispatchEvent

`Readonly` context

`Readonly` numberOfInputs

`Readonly` numberOfOutputs

`Readonly` parameters

`Readonly` port

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: boolean | AddEventListenerOptions

`Optional` output: number

`Optional` input: number

`Optional` output: number

`Optional` options: boolean | EventListenerOptions

`Optional` options: boolean | EventListenerOptions