IAudioFrameObserverBase

onEarMonitoringAudioFrame

Gets the in-ear monitoring audio frame.

onEarMonitoringAudioFrame?(audioFrame: AudioFrame): void;

In order to ensure that the obtained in-ear audio data meets the expectations, Agora recommends that you set the in-ear monitoring-ear audio data format as follows: After calling setEarMonitoringAudioFrameParameters to set the audio data format and registerAudioFrameObserver to register the audio frame observer object, the SDK calculates the sampling interval according to the parameters set in the methods, and triggers the onEarMonitoringAudioFrame callback according to the sampling interval.

Parameters

audioFrame: The raw audio data. See AudioFrame.

onMixedAudioFrame

Retrieves the mixed captured and playback audio frame.

  onMixedAudioFrame?(channelId: string, audioFrame: AudioFrame): void;

To ensure that the data format of mixed captured and playback audio frame meets the expectations, Agora recommends that you set the data format as follows: After calling setMixedAudioFrameParameters to set the audio data format and registerAudioFrameObserver to register the audio frame observer object, the SDK calculates the sampling interval according to the parameters set in the methods, and triggers the onMixedAudioFrame callback according to the sampling interval.

Parameters

audioFrame: The raw audio data. See AudioFrame.
channelId: The channel ID.

onPlaybackAudioFrame

Gets the raw audio frame for playback.

  onPlaybackAudioFrame?(channelId: string, audioFrame: AudioFrame): void;

To ensure that the data format of audio frame for playback is as expected, Agora recommends that you set the audio data format as follows: After calling setPlaybackAudioFrameParameters to set the audio data format and registerAudioFrameObserver to register the audio frame observer object, the SDK calculates the sampling interval according to the parameters set in the methods, and triggers the onPlaybackAudioFrame callback according to the sampling interval.

Parameters

audioFrame: The raw audio data. See AudioFrame.
channelId: The channel ID.

onPlaybackAudioFrameBeforeMixing

Retrieves the audio frame before mixing of subscribed remote users.

  onPlaybackAudioFrameBeforeMixing?(
    channelId: string,
    uid: number,
    audioFrame: AudioFrame
  ): void;

Attention: Due to framework limitations, this callback does not support sending processed audio data back to the SDK.

Parameters

channelId: The channel ID.
uid: The ID of subscribed remote users.
audioFrame: The raw audio data. See AudioFrame.

onRecordAudioFrame

Gets the captured audio frame.

onRecordAudioFrame?(channelId: string, audioFrame: AudioFrame): void;

To ensure that the data format of captured audio frame is as expected, Agora recommends that you set the audio data format as follows: After calling setRecordingAudioFrameParameters to set the audio data format, call registerAudioFrameObserver to register the audio observer object, the SDK will calculate the sampling interval according to the parameters set in this method, and triggers the onRecordAudioFrame callback according to the sampling interval.

Parameters

audioFrame: The raw audio data. See AudioFrame.
channelId: The channel ID.