AudioRecordingConfiguration | Voice SDK v3.7.0 API Reference for Electron

Recording configuration, which is set in startAudioRecordingWithConfig.

since: v3.4.2

Hierarchy

AudioRecordingConfiguration

Index

Properties

filePath

filePath: string

The absolute path (including the filename extensions) of the recording file. For example: C:\music\audio.aac.

note: Ensure that the path you specify exists and is writable.

recordingChannel

recordingChannel: number

since

v3.7.0

The recorded audio channel. The following values are supported:

1: (Default) Mono channel.
2: Dual channel.

note

The actual recorded audio channel is related to the audio channel that you capture. If the captured audio is mono and recordingChannel is 2, the recorded audio is the dual-channel data that is copied from mono data, not stereo. If the captured audio is dual channel and recordingChannel is 1, the recorded audio is the mono data that is mixed by dual-channel data. The integration scheme also affects the final recorded audio channel. Therefore, to record in stereo, contact technical support for assistance.

recordingPosition

recordingPosition: AUDIO_RECORDING_POSITION

Recording content. See AUDIO_RECORDING_POSITION.

recordingQuality

recordingQuality: AUDIO_RECORDING_QUALITY_TYPE

Audio recording quality. See AUDIO_RECORDING_QUALITY_TYPE.

note: This parameter applies to AAC files only.

recordingSampleRate

recordingSampleRate: number

Recording sample rate (Hz). The following values are supported:

16000
(Default) 32000
44100
48000

note: If this parameter is set to 44100 or 48000, for better recording effects, Agora recommends recording WAV files or AAC files whose recordingQuality is AUDIO_RECORDING_QUALITY_MEDIUM or AUDIO_RECORDING_QUALITY_HIGH.