Silero

View as Markdown

Classes

Enums

Functions

createVAD

Creates a Silero.VAD instance.

1createVAD(parameters: VADParameters): Promise<Silero.VAD>

Parameters

parameters
VADParametersRequired

Types

VADParameters

Extends: _WebSocketBasedClientParameters

Silero.VAD parameters. Can be passed as arguments to the Silero.createVAD method.

minSilenceDurationMs
number

optional

Optional. The duration of silence (in milliseconds) to wait for each speech segment before separating it. The default value is 300.

speechPadMs
number

optional

Optional. The padding to add to speech segments to avoid aggressive cutting. The default value is 0.

threshold
number

optional

Optional. The probability threshold above which we detect speech. The default value is 0.5.

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.