NoiseSuppression

View as Markdown

Methods

addEventListener

Adds a handler for the specified Hush.NoiseSuppressionEvents or Hush.Events event. Use only functions as handlers; anything except a function leads to the error and scenario termination when a handler is called.

addEventListener(event: Hush.NoiseSuppressionEvents | Hush.Events | T, callback: (event: Hush._HushNoiseSuppressionClientEvents[T]) => any): void

Parameters

event
Hush.NoiseSuppressionEvents | Hush.Events | TRequired
callback
(event: Hush._HushNoiseSuppressionClientEvents[T]) => anyRequired

clearMediaBuffer

Clears the NoiseSuppression WebSocket media buffer.

clearMediaBuffer(parameters?: ClearMediaBufferParameters): void

Parameters

parameters
ClearMediaBufferParameters

close

Closes the NoiseSuppression connection (over WebSocket) or connection attempt.

close(): void

id

Returns the NoiseSuppression id.

id(): string

removeEventListener

Removes a handler for the specified Hush.NoiseSuppressionEvents or Hush.Events event.

removeEventListener(event: Hush.NoiseSuppressionEvents | Hush.Events | T, callback?: (event: Hush._HushNoiseSuppressionClientEvents[T]) => any): void

Parameters

event
Hush.NoiseSuppressionEvents | Hush.Events | TRequired
callback
(event: Hush._HushNoiseSuppressionClientEvents[T]) => any

reset

Resets the Hush ONNX streaming state and resampler buffers.

reset(): void

sendMediaTo

Starts sending denoised media from the NoiseSuppression (via WebSocket) to the media unit.

sendMediaTo(mediaUnit: VoxMediaUnit, parameters?: SendMediaParameters): void

Parameters

mediaUnit
VoxMediaUnitRequired
parameters
SendMediaParameters

stop

Stops the noise suppression session on the connector.

stop(): void

stopMediaTo

Stops sending media from the NoiseSuppression (via WebSocket) to the media unit.

stopMediaTo(mediaUnit: VoxMediaUnit): void

Parameters

mediaUnit
VoxMediaUnitRequired

webSocketId

Returns the NoiseSuppression WebSocket id.

webSocketId(): string