SIGN UP

RecorderParameters

Recorder parameters. The parameters can be passed as arguments either to the Call.record method or to the Recorder.createRecorder method of Recorder module. There are differences between using the parameters in these methods, see the details in the parameters' descriptions.

Properties

Array dict

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 doesn't matter for the Recorder module because the transcription isn't available for it.

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

String format

Transcription format. Could be specified as "json". In that case the transcription result will be saved in JSON format. The parameter isn't available for the Recorder module.

Boolean hd_audio

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

Array labels

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 isn't available for the Recorder module.

String language

Transcription language. The parameter uses ASRDictionary from ASR Module as possible values. Note that it's necessary to include ASR module in the scenario to use the language Constants. The parameter isn't available for the Recorder module.

Boolean lossless

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.

String name

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

Boolean secure

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

Boolean stereo

False by default. The parameter doesn't change anything for the Recorder module: it will record stereo with mixed streams in both channels. For the Call.record method it work 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.

Boolean transcribe

Create the call record transcription. Note that transcription isn't available for the Recorder module. See the details in the article.

Number transcriptionThreshold

Minimum length, in seconds, of a recording to transcribe. 0 to transcribe recordings of any length. Used to filter out recordings that are too short to be meaningful. The parameter isn't available for the Recorder module.

Boolean video

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