AudioParams

Audio data format.

class AudioParams {
  const AudioParams(
      {this.sampleRate, this.channels, this.mode, this.samplesPerCall});

  @JsonKey(name: 'sample_rate')
  final int? sampleRate;

  @JsonKey(name: 'channels')
  final int? channels;

  @JsonKey(name: 'mode')
  final RawAudioFrameOpModeType? mode;

  @JsonKey(name: 'samples_per_call')
  final int? samplesPerCall;

  factory AudioParams.fromJson(Map<String, dynamic> json) =>
      _$AudioParamsFromJson(json);

  Map<String, dynamic> toJson() => _$AudioParamsToJson(this);
}
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

sampleRate
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 RawAudioFrameOpModeType.
samplesPerCall
The number of samples, such as 1024 for the media push.