AudioParams
Audio data format.
struct AudioParams {
int sample_rate;
int channels;
rtc::RAW_AUDIO_FRAME_OP_MODE_TYPE mode;
int samples_per_call;
AudioParams() : sample_rate(0), channels(0), mode(rtc::RAW_AUDIO_FRAME_OP_MODE_READ_ONLY), samples_per_call(0) {}
AudioParams(int samplerate, int channel, rtc::RAW_AUDIO_FRAME_OP_MODE_TYPE type, int samplesPerCall) : sample_rate(samplerate), channels(channel), mode(type), samples_per_call(samplesPerCall) {}
};
You can pass the AudioParams object in the following APIs to set the audio data format for the corresponding callback:
- getRecordAudioParams: Sets the audio data format for the onRecordAudioFrame callback.
- getPlaybackAudioParams: Sets the audio data format for the onPlaybackAudioFrame callback.
- getMixedAudioParams: Sets the audio data format for the onMixedAudioFrame callback.
- getEarMonitoringAudioParams: Sets the audio data format for the onEarMonitoringAudioFrame callback.
Attention:
- The SDK calculates the sampling interval through the samplesPerCall, sampleRate, and channel parameters in AudioParams, and triggers the onRecordAudioFrame, onPlaybackAudioFrame, onMixedAudioFrame, and onEarMonitoringAudioFrame callbacks according to the sampling interval.
- Sample interval (sec) = samplePerCall/(sampleRate × channel).
- Ensure that the sample interval ≥ 0.01 (s).
Attributes
- sample_rate
- The audio sample rate (Hz), which can be set as one of the following values:
- 8000.
- (Default) 16000.
- 32000.
- 44100
- 48000
- channels
- The number of audio channels, which can be set as either of the following values:
- 1: (Default) Mono.
- 2: Stereo.
- mode
- The use mode of the audio data. See RAW_AUDIO_FRAME_OP_MODE_TYPE.
- samples_per_call
- The number of samples, such as 1024 for the media push.