Agora RTC Objective-C API Reference
Refactor
|
Inherits <NSObject>.
Instance Methods | |
(BOOL) | - onRecordAudioFrame:channelId: |
(BOOL) | - onPlaybackAudioFrame:channelId: |
(BOOL) | - onMixedAudioFrame:channelId: |
(BOOL) | - onEarMonitoringAudioFrame: |
(BOOL) | - onPlaybackAudioFrameBeforeMixing:channelId:uid: |
(AgoraAudioFramePosition) | - getObservedAudioFramePosition |
The AgoraAudioFrameDelegate protocol enables audio frame callback event notifications to your application.
|
optional |
Occurs when the recorded audio frame is received.
frame | A pointer to the audio frame: AgoraAudioFrame. |
channelId | Unique channel name for the AgoraRTC session in the string format. The string length must be less than 64 bytes. Supported character scopes are:
|
|
optional |
Occurs when the playback audio frame is received.
channelId | Unique channel name for the AgoraRTC session in the string format. The string length must be less than 64 bytes. Supported character scopes are:
|
frame | A pointer to the audio frame: AgoraAudioFrame. |
|
optional |
Occurs when the mixed audio data is received.
frame | The A pointer to the audio frame: AgoraAudioFrame. |
channelId | Unique channel name for the AgoraRTC session in the string format. The string length must be less than 64 bytes. Supported character scopes are:
|
|
optional |
Occurs when the ear monitoring audio frame is received.
frame | A pointer to the audio frame: AgoraAudioFrame. |
|
optional |
Occurs when the before-mixing playback audio frame is received.
channelId | Unique channel name for the AgoraRTC session in the string format. The string length must be less than 64 bytes. Supported character scopes are:
|
uid | ID of the remote user. |
frame | A pointer to the audio frame: AgoraAudioFrame. |
|
optional |
Sets the frame position for the audio observer.
After you successfully register the audio observer, the SDK triggers this callback each time it receives a audio frame. You can determine which position to observe by setting the return value. The SDK provides 4 positions for observer. Each position corresponds to a callback function:
AgoraAudioFramePositionPlayback (1 << 0)
: The position for playback audio frame is received, which corresponds to the onPlaybackFrame callback.AgoraAudioFramePositionRecord (1 << 1)
: The position for record audio frame is received, which corresponds to the onRecordFrame callback.AgoraAudioFramePositionMixed (1 << 2)
: The position for mixed audio frame is received, which corresponds to the onMixedFrame callback.AgoraAudioFramePositionBeforeMixing (1 << 3)
: The position for playback audio frame before mixing is received, which corresponds to the onPlaybackFrameBeforeMixing callback.