agora::rtc::AudioRecordingConfiguration Struct Reference

#include <IAgoraRtcEngine.h>

Public Member Functions
	AudioRecordingConfiguration ()
	AudioRecordingConfiguration (const char *path, AUDIO_RECORDING_QUALITY_TYPE quality, AUDIO_RECORDING_POSITION position, int sampleRate, int channel)

Public Attributes
const char *	filePath
AUDIO_RECORDING_QUALITY_TYPE	recordingQuality
AUDIO_RECORDING_POSITION	recordingPosition
int	recordingSampleRate
int	recordingChannel

Detailed Description

Recording configuration, which is set in startAudioRecording.

Since

v3.4.0

Constructor & Destructor Documentation

AudioRecordingConfiguration() [1/2]

agora::rtc::AudioRecordingConfiguration::AudioRecordingConfiguration ( )

inline

AudioRecordingConfiguration() [2/2]

agora::rtc::AudioRecordingConfiguration::AudioRecordingConfiguration ( const char *  path, AUDIO_RECORDING_QUALITY_TYPE  quality, AUDIO_RECORDING_POSITION  position, int  sampleRate, int  channel  )

inline

Member Data Documentation

filePath

const char* agora::rtc::AudioRecordingConfiguration::filePath

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.

recordingQuality

AUDIO_RECORDING_QUALITY_TYPE agora::rtc::AudioRecordingConfiguration::recordingQuality

Audio recording quality. See AUDIO_RECORDING_QUALITY_TYPE.

Note

This parameter applies to AAC files only.

recordingPosition

AUDIO_RECORDING_POSITION agora::rtc::AudioRecordingConfiguration::recordingPosition

Recording content. See AUDIO_RECORDING_POSITION.

recordingSampleRate

int agora::rtc::AudioRecordingConfiguration::recordingSampleRate

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.

recordingChannel

int agora::rtc::AudioRecordingConfiguration::recordingChannel

Since

v3.6.2

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.