Agora RTC Objective-C API Reference  Refactor
Data Fields
AudioRecordingConfiguration Struct Reference

Data Fields

const char * filePath
 
bool encode
 
int sampleRate
 
AUDIO_FILE_RECORDING_TYPE fileRecordingType
 
AUDIO_RECORDING_QUALITY_TYPE quality
 
int recordingChannel
 

Detailed Description

The Audio file recording options.

Constructor & Destructor Documentation

◆ AudioRecordingConfiguration() [1/4]

◆ AudioRecordingConfiguration() [2/4]

AudioRecordingConfiguration ( const char *  file_path,
int  sample_rate,
AUDIO_RECORDING_QUALITY_TYPE  quality_type,
int  channel 
)
inline

◆ AudioRecordingConfiguration() [3/4]

AudioRecordingConfiguration ( const char *  file_path,
bool  enc,
int  sample_rate,
AUDIO_FILE_RECORDING_TYPE  type,
AUDIO_RECORDING_QUALITY_TYPE  quality_type,
int  channel 
)
inline

◆ AudioRecordingConfiguration() [4/4]

Field Documentation

◆ filePath

const char* filePath

The path of recording file. The string of the file path is in UTF-8 code.

◆ encode

bool encode

Determines whether to encode audio data.

  • true: Encode the audio data with AAC Encoder.
  • false: (Default) Do not encode the audio data. Save audio data as a wav file.

◆ sampleRate

int sampleRate

The sample rate of audio data. Default is 32000. The optional value is 16000, 32000, 44100, or 48000.

◆ fileRecordingType

AUDIO_FILE_RECORDING_TYPE fileRecordingType

The recording type of audio data.

◆ quality

The recording quality of audio data.

◆ recordingChannel

int recordingChannel

Recording channel. The following values are supported:

  • (Default) 1
  • 2