CallRecordParameters
Record parameters. The parameters can be passed as arguments to the Call.record method.
Props
dict
dict: | string[]
Transcription dictionary. Array of words are possible values. Note that dict does not limit the transcription to the specific list. Instead, words in the specified list will have a higher chance to be selected. Note that parameter does not matter for the Recorder module because the transcription is not available for it.
expire
expire:
Storage time for recorded files. The default value is 3 months; see possible values in the Voxengine.RecordExpireTime list.
format
format: string
| undefined
Transcription format. Could be specified as "json". In that case the transcription result will be saved in JSON format. The parameter is not available for the Recorder module.
hd_audio
hd_audio: false
| undefined
| true
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.
labels
labels: string[]
An array of two strings. Each string names the label in resulting transcription: the first string names a call/stream that initiated recording, the second string names the other call. If there is only one string in the array or the parameter is not specified at all, the recording's initiate call will be named as "Left" and the second stream will be named as "Right". The parameter requires the 'transcribe: true' parameter. The parameter is not available for the Recorder module.
language
language:
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
lossless: false
| undefined
| true
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.
recordNamePrefix
recordNamePrefix: string
| undefined
This prefix is added to the names of records that are stored in your S3 storage.
secure
secure: false
| undefined
| true
Restrict access to the record without HTTP API authorization (available only in VoxEngine.createRecorder).
stereo
stereo: false
| undefined
| true
False by default. The parameter does not change anything for the Recorder module: it will record stereo with mixed streams in both channels. For the Call.record method it works in another way: 1) if it is False, it will record stereo with mixed streams in both channels 2) If it is True, the Audio stream from a call endpoint to voximplant cloud will be recorded into right channel. Audio stream from voximplant cloud to a call endpoint will be recorded into left channel.
transcribe
transcribe: false
| undefined
| true
Create the call record transcription. Note that transcription is not available for the Recorder module. See the details in the article.
video
video: false
| undefined
| true
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.