Inherits <NSObject>.
Inherited by <AgoraRtcEngineDelegate2>.
◆ rtcEngine:didLocalUserRegisteredWithUserId:userAccount:
- (void) rtcEngine: |
|
(AgoraRtcEngineKit *_Nonnull) |
engine |
didLocalUserRegisteredWithUserId: |
|
(NSUInteger) |
uid |
userAccount: |
|
(NSString *_Nonnull) |
userAccount |
|
|
| |
|
optional |
Occurs when the local user successfully registers a user account by calling the This callback reports the user ID and user account of the local user.
- Parameters
-
uid | The ID of the local user. |
userAccount | The user account of the local user. |
◆ rtcEngine:didUserInfoUpdatedWithUserId:userInfo:
Occurs when the SDK gets the user ID and user account of the remote user.
After a remote user joins the channel, the SDK gets the UID and user account of the remote user, caches them in a mapping table object (userInfo
), and triggers this callback on the local client.
- Parameters
-
uid | The ID of the remote user. |
userInfo | The AgoraUserInfo object that contains the user ID and user account of the remote user. |
◆ rtcEngineRequestToken:
when token is enabled, and specified token is invalid or expired, this function will be called. APP should generate a new token and call renewToken() to refresh the token. NOTE: to be compatible with previous version, ERR_TOKEN_EXPIRED and ERR_INVALID_TOKEN are also reported via onError() callback. You should move renew of token logic into this callback.
- Parameters
-
◆ rtcEngineConnectionDidLost:
Event of loss connection with server. This event is reported after the connection is interrupted and exceed the retry period (10 seconds by default). In the mean time SDK automatically tries to reconnect with the server until APP calls leaveChannel.
- Parameters
-
◆ rtcEngine:reportRtcStats:
Statistics of rtc engine status. Updated every two seconds.
- Parameters
-
engine | The engine kit |
stats | The statistics of rtc status, including duration, sent bytes and received bytes |
◆ rtcEngine:lastmileProbeTestResult:
Reports the last-mile network probe result.
The SDK triggers this callback within 30 seconds after the app calls the [startLastmileProbeTest]([AgoraRtcEngineKit startLastmileProbeTest:]) method.
- Parameters
-
◆ rtcEngine:didApiCallExecute:api:result:
- (void) rtcEngine: |
|
(AgoraRtcEngineKit *_Nonnull) |
engine |
didApiCallExecute: |
|
(NSInteger) |
error |
api: |
|
(NSString *_Nonnull) |
api |
result: |
|
(NSString *_Nonnull) |
result |
|
|
| |
|
optional |
Event of API call executed
- Parameters
-
engine | The engine kit |
api | The API description |
error | The error code |
◆ rtcEngine:uploadLogResultRequestId:success:reason:
Reports the user log upload result
- Parameters
-
requestId | RequestId of the upload |
success | Is upload success |
reason | Reason of the upload, 0: OK, 1 Network Error, 2 Server Error. |
◆ rtcEngine:didClientRoleChanged:newRole:
Event of cient role change. only take effect under broadcasting mode
- Parameters
-
engine | The engine kit |
oldRole | the previous role |
newRole | the new role |
◆ rtcEngine:didClientRoleChangeFailed:currentRole:
Event of cient role change. only take effect under broadcasting mode
- Parameters
-
engine | The engine kit |
reason | The reason of the failure of the local user role switches |
currentRole | The current role of the user |
◆ rtcEngine:didLeaveChannelWithStats:
The statistics of the call when leave channel
- Parameters
-
engine | The engine kit |
stats | The statistics of the call, including duration, sent bytes and received bytes |
◆ rtcEngine:firstLocalAudioFramePublished:
- (void) rtcEngine: |
|
(AgoraRtcEngineKit *_Nonnull) |
engine |
firstLocalAudioFramePublished: |
|
(NSInteger) |
elapsed |
|
|
| |
|
optional |
Event of the first audio frame is sent.
- Parameters
-
engine | The engine kit |
elapsed | The elapsed time(ms) from the beginning of the session. |
◆ rtcEngine:localAudioStats:
The statistics of the local audio stream.
Same as [localAudioStatBlock]([AgoraRtcEngineKit localAudioStatBlock:]). The SDK updates the application on the statistics of the local audio stream once every two seconds.
- Parameters
-
◆ rtcEngine:audioMixingStateChanged:reasonCode:
- (void) rtcEngine: |
|
(AgoraRtcEngineKit *_Nonnull) |
engine |
audioMixingStateChanged: |
|
(AgoraAudioMixingStateType) |
state |
reasonCode: |
|
(AgoraAudioMixingReasonCode) |
reasonCode |
|
|
| |
|
optional |
Audio mixing state changed.
- Parameters
-
engine | The AgoraRtcEngineKit object. |
state | AgoraAudioMixingStateType |
reasonCode | AgoraAudioMixingReasonType |
◆ rtcEngine:cameraExposureDidChangedToRect:
- (void) rtcEngine: |
|
(AgoraRtcEngineKit *_Nonnull) |
engine |
cameraExposureDidChangedToRect: |
|
(CGRect) |
rect |
|
|
| |
|
optional |
A camera exposure position changed.
- Parameters
-
◆ rtcEngine:firstLocalVideoFramePublishedWithElapsed:sourceType:
Event of the first local video frame is published.
- Parameters
-
engine | The engine kit |
elapsed | The elapsed time(ms) from the beginning of the session. |
◆ rtcEngine:firstLocalVideoFrameWithSize:elapsed:sourceType:
Event of the first local frame starts rendering on the screen.
- Parameters
-
engine | The engine kit |
size | The size of local video stream |
elapsed | The elapsed time(ms) from the beginning of the session. |
◆ rtcEngine:localVideoStats:sourceType:
The statistics of local video stream. Update every two seconds.
- Parameters
-
engine | The engine kit |
stats | The statistics of local video, including sent bitrate, sent framerate |
◆ rtcEngine:reportAudioVolumeIndicationOfSpeakers:totalVolume:
The sdk reports the volume of a speaker. The interface is disable by default, and it could be enable by API "enableAudioVolumeIndication"
- Parameters
-
◆ rtcEngine:remoteAudioStats:
The statistics of remote audio stream. Update every two seconds.
- Parameters
-
engine | The engine kit |
stats | The statistics of audio video, including user id, delay, resolution, received bitrate, received framerate, audio stream type |
◆ rtcEngine:remoteVideoStats:
The statistics of remote video stream. Update every two seconds.
- Parameters
-
engine | The engine kit |
stats | The statistics of remote video, including user id, delay, resolution, received bitrate, received framerate, video stream type |
◆ rtcEngine:rtmpStreamingChangedToState:state:errCode:
◆ rtcEngine:rtmpStreamingEventWithUrl:eventCode:
◆ rtcEngine:facePositionDidChangeWidth:previewHeight:faces:
Reports the face detection result of the local user. (iOS only)
Since:** v3.0.1.
Once you enable face detection by calling [enableFaceDetection]([AgoraRtcEngineKit enableFaceDetection:]), you can get the following information on the local user in real-time:
- Parameters
-
engine | AgoraRtcEngineKit object. |
width | The width (px) of the local video. |
height | The height (px) of the local video. |
faces | An AgoraFacePositionInfo array, which contains the information of the detected human face. |
The number of the AgoraFacePositionInfo array depends on the number of human faces detected. If the array length is 0, it means that no human face is detected.