setRecordingAudioFrameParameters abstract method

Future<void> setRecordingAudioFrameParameters({
  1. required int sampleRate,
  2. required int channel,
  3. required RawAudioFrameOpModeType mode,
  4. required int samplesPerCall,
})

Sets the format of the captured raw audio data.

Sets the audio format for the onRecordAudioFrame callback. Ensure that you call this method before joining a channel. The SDK calculates the sampling interval based on the samplesPerCall, sampleRate and channel parameters set in this method. Sample interval (sec) = samplePerCall /(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s).

  • sampleRate The sample rate returned in the onRecordAudioFrame callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.
  • channel The number of channels returned in the onRecordAudioFrame callback: 1: Mono. 2: Stereo.
  • mode The use mode of the audio frame. See RawAudioFrameOpModeType.
  • samplesPerCall The number of data samples returned in the onRecordAudioFrame callback, such as 1024 for the Media Push.

Returns When the method call succeeds, there is no return value; when fails, the AgoraRtcException exception is thrown. You need to catch the exception and handle it accordingly. < 0: Failure.

Implementation

Future<void> setRecordingAudioFrameParameters(
    {required int sampleRate,
    required int channel,
    required RawAudioFrameOpModeType mode,
    required int samplesPerCall});