Rate this page:

RecorderParameters

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

Props

expire

Copy URL
expire: 

RecordExpireTime

Optional. Storage time for recorded files. The default value is [RecordExpireTime.THREEMONTHS] (3 months); see possible values in the RecordExpireTime enum.

hd_audio

Copy URL
hd_audio: 

false

|

undefined

|

true

Optional. Whether to use the HD audio. 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

Copy URL
language: 

ASRLanguage

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

lossless

Copy URL
lossless: 

false

|

undefined

|

true

Optional. Whether to save the record in flac format. The default value is false. The property is not compatible with hd_audio: true property.

name

Copy URL
name: 

string

|

undefined

Optional. Name of the recorder for the call history.

provider

Copy URL
provider: 

Amazon

|

Deepgram

|

Google

|

Microsoft

|

SaluteSpeech

|

TBank

|

Yandex

|

YandexV3

Optional. Speech recognition provider.

recordNamePrefix

Copy URL
recordNamePrefix: 

string

|

undefined

Optional. The prefix to add to the record names when storing to your S3 storage. Works only for custom S3-compatible storages.

secure

Copy URL
secure: 

false

|

undefined

|

true

Optional. Whether to restrict access to the record without management API authorization (available only in VoxEngine.createRecorder).

transcribe

Copy URL
transcribe: 

false

|

undefined

|

true

Optional. Whether to create the call record transcription. Note that transcription is not available for the Recorder module. See the details in the article.

video

Copy URL
video: 

false

|

undefined

|

true

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

videoParameters

Copy URL
videoParameters: 

RecorderVideoParameters

Video parameters for the ConferenceRecorder parameters.