CallRecordParameters
The parameters can be passed as arguments to the Call.record method.
Props
dict
dict: | string[]
Optional. Transcription dictionary. Array of words that are possible values. Note that dict does not limit the transcription to the specific list. Instead, words in the specified list have a higher chance to be selected. Note that the parameter does not affect the Recorder module because the transcription is not available for it.
expire
expire: Optional. Storage time for recorded files. The default value is [RecordExpireTime.THREEMONTHS] (3 months); see possible values in the RecordExpireTime enum.
format
format: string
| undefined
Optional. Transcription format. Could be specified as "json". In that case the transcription result is saved in JSON format. The parameter is not available for the Recorder module.
hd_audio
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.
labels
labels: string[]
Optional. 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 has the "Left" name and the second stream has the "Right" name. The parameter requires the 'transcribe: true' parameter. The parameter is not available for the Recorder module.
language
language: 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
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.
recordNamePrefix
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
secure: false
| undefined
| true
Optional. Whether to restrict access to the record without management API authorization (available only in VoxEngine.createRecorder).
stereo
stereo: false
| undefined
| true
Optional. Whether the sound is stereo. The default value is false. The parameter does not change anything for the Recorder module: it records stereo with mixed streams in both channels. For the Call.record method it works in another way: 1) if it is False, it records stereo with mixed streams in both channels 2) If it is True, the Audio stream from a call endpoint to voximplant cloud is recorded into right channel. Audio stream from voximplant cloud to a call endpoint is recorded into left channel.
transcribe
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
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.