Hush

View as Markdown

Classes

Enums

Functions

createNoiseSuppression

Creates a Hush.NoiseSuppression instance.

createNoiseSuppression(parameters: NoiseSuppressionParameters): Promise<Hush.NoiseSuppression>

Parameters

parameters
NoiseSuppressionParametersRequired

Types

NoiseSuppressionParameters

Extends: _WebSocketBasedClientParameters

Hush.NoiseSuppression parameters. Can be passed as arguments to the Hush.createNoiseSuppression method.

attenLimDb
number

optional

Optional. Attenuation limit in dB. 0 means no limit. The default value is 0.

Inherited fields

privacy
boolean

_optional, inherited from WebSocketBasedClientParameters

Optional. Whether to enable the privacy functionality.

If privacy is enabled, the logging for the WebSocket connection is disabled.

NOTE: the default value is false.

statistics
boolean

_optional, inherited from WebSocketBasedClientParameters

Optional. Enables statistics functionality.

trace
boolean

_optional, inherited from WebSocketBasedClientParameters

Optional. Whether to enable the tracing functionality.

If tracing is enabled, a URL to the trace file appears in the ‘websocket.created’ message. The file contains all sent and received WebSocket messages in the plain text format. The file is uploaded to the S3 storage.

NOTE: enable this only for diagnostic purposes. You can provide the trace file to our support team to help investigating issues.