Rate this page:

RecorderParameters

Recorder parameters. The parameters can be passed as arguments to the VoxEngine.createRecorder method.

Props

expire: RecordExpireTime

Storage time for recorded files. The default value is 3 months; see possible values in the Voxengine.RecordExpireTime list.

hd_audio: boolean

If set to false (default), 8 KHz / 32 kbps mp3 file is generated. Otherwise, "wideband audio" 48 KHz / 192 kbps mp3 file is generated. Note that transcription's quality does not depend on this parameter. The property is not compatible with lossless: true property.

language: ASRLanguage

Transcription language. The parameter uses ASRLanguage from the ASR Module as possible values. Note that it is necessary to include ASR module in the scenario to use the language Constants. The parameter is not available for the Recorder module.

lossless: boolean

False by default. If it is true, the record will be saved in flac format. The property is not compatible with hd_audio: true property.

name: string

Name of the recorder. It can be seen in the call history.

provider: Amazon | Deepgram | Google | Microsoft | SmartSpeech | Tinkoff | Yandex | YandexV3

Speech recognition provider

recordNamePrefix: string | undefined

This prefix is added to the names of records that are stored in your S3 storage.

secure: boolean

Restrict access to the record without HTTP API authorization (available only in VoxEngine.createRecorder).

transcribe: boolean

Create the call record transcription. Note that transcription is not available for the Recorder module. See the details in the article.

video: boolean

False by default. For video recording use the Call.record ({video: true}) method call. The parameter is not available for the Recorder module because it could only record an audio.