Inherits <NSObject>, and <AgoraBaseDelegate>.
◆ rtcEngine:didJoinChannel:withUid:elapsed:
| - (void) rtcEngine: |
|
(AgoraRtcEngineKit *_Nonnull) |
engine |
| didJoinChannel: |
|
(NSString *_Nonnull) |
channelId |
| withUid: |
|
(NSString *_Nonnull) |
userId |
| elapsed: |
|
(NSInteger) |
elapsed |
|
|
| |
|
optional |
Event of the user joined the channel.
- Parameters
-
| engine | The engine kit |
| channel | The channel name |
| userId | The remote user id |
| elapsed | The elapsed time (ms) from session beginning |
◆ rtcEngine:didRejoinChannel:withUid:elapsed:
| - (void) rtcEngine: |
|
(AgoraRtcEngineKit *_Nonnull) |
engine |
| didRejoinChannel: |
|
(NSString *_Nonnull) |
channelId |
| withUid: |
|
(NSString *_Nonnull) |
userId |
| elapsed: |
|
(NSInteger) |
elapsed |
|
|
| |
|
optional |
Event of the user rejoined the channel
- Parameters
-
| engine | The engine kit |
| channel | The channel name |
| userId | The user id |
| elapsed | The elapsed time (ms) from session beginning |
◆ rtcEngine:didJoinedOfUid:elapsed:
| - (void) rtcEngine: |
|
(AgoraRtcEngineKit *_Nonnull) |
engine |
| didJoinedOfUid: |
|
(NSString *_Nonnull) |
userId |
| elapsed: |
|
(NSInteger) |
elapsed |
|
|
| |
|
optional |
Event of remote user joined
- Parameters
-
| engine | The engine kit |
| userId | The remote user id |
| elapsed | The elapsed time(ms) from the beginning of the session. |
◆ rtcEngine:didOfflineOfUid:reason:
Event of remote user offlined
- Parameters
-
| engine | The engine kit |
| userId | The remote user id |
| reason | Reason of user offline, quit, drop or became audience |
◆ rtcEngine:localAudioStateChanged:error:
This callback indicates local audio stream state has changed.
- Parameters
-
| engine | The engine kit |
| state | Stopped: The initial state Recording: The capturer starts successfully Encoding: The first video frame is successfully encoded Failed: The local video fails to start |
| error | OK: The local audio is normal Failure: No specified reason for the local audio failure. DeviceNoPermission: No permission to use the local audio device DeviceBusy: The microphone is in use RecordFailure: The local audio recording fails. Check whether the recording device is working properly EncodeFailure: The local audio encoding fails |
◆ rtcEngine:remoteAudioStateChangedOfUid:state:reason:elapsed:
This callback indicates remote audio stream state has changed.
- Parameters
-
| engine | The engine kit |
| userId | The user id |
| state | Stopped // The remote audio stopped, default state, audio is started or remote user disabled/muted audio stream. Starting // The first remote audio packet is received. Decoding // The remote audio stream is decoded and plays normally. Frozen // The remote audio is frozen. Failed // The remote audio fails to start. |
| reason | Interal // Internal reasons. NetworkCongestion // Network congestion. NetworkRecovery // Network recovery. LocalMuted // The local user stops receiving the remote audio stream or disables the audio module. LocalUnmuted // The local user resumes receiving the remote audio stream or enables the audio module. RemoteMuted // The remote user stops sending the audio stream or disables the audio module. RemoteUnmuted // The remote user resumes sending the audio stream or enables the audio module. Offline // The remote user leaves the channel. |
| elapsed | The elapsed time(ms) from the beginning of the session. |
◆ rtcEngine:localVideoStateChangedOfState:error:
Occurs when the local video stream state changes
This callback indicates the state of the local video stream, including camera capturing and video encoding, and allows you to troubleshoot issues when exceptions occur.
- Note
- For some device models, the SDK will not trigger this callback when the state of the local video changes while the local video capturing device is in use, so you have to make your own timeout judgment.
- Parameters
-
◆ rtcEngine:remoteVideoStateChangedOfUid:state:reason:elapsed:
| - (void) rtcEngine: |
|
(AgoraRtcEngineKit *_Nonnull) |
engine |
| remoteVideoStateChangedOfUid: |
|
(NSString *_Nonnull) |
userId |
| state: |
|
(AgoraVideoRemoteState) |
state |
| reason: |
|
(AgoraVideoRemoteReason) |
reason |
| elapsed: |
|
(NSInteger) |
elapsed |
|
|
| |
|
optional |
This callback indicates remote video stream state has changed.
- Parameters
-
| engine | The engine kit |
| userId | The user id |
| state | Stopped // Default state, video is started or remote user disabled/muted video stream Running // Running state, remote video can be displayed normally Frozen // Remote video is frozen, probably due to network issue. |
| reason | Interal // Internal reasons. NetworkCongestion // Network congestion. NetworkRecovery // Network recovery. LocalMuted // The local user stops receiving the remote audio stream or disables the audio module. LocalUnmuted // The local user resumes receiving the remote audio stream or enables the audio module. RemoteMuted // The remote user stops sending the audio stream or disables the audio module. RemoteUnmuted // The remote user resumes sending the audio stream or enables the audio module. Offline // The remote user leaves the channel. AudioFallback //The remote media stream falls back to the audio-only stream due to poor network conditions. AudioFallbackRecovery // The remote media stream switches back to the video stream after the network conditions improve. |
| elapsed | The time elapsed (ms) from the local user calling ref "joinChannel" until this callback is triggered. |
◆ rtcEngine:publishingRequestReceivedFromUid:
| - (void) rtcEngine: |
|
(AgoraRtcEngineKit *_Nonnull) |
engine |
| publishingRequestReceivedFromUid: |
|
(NSString *_Nonnull) |
userId |
|
|
| |
|
optional |
◆ rtcEngine:publishingRequestAnsweredByOwner:accepted:error:
| - (void) rtcEngine: |
|
(AgoraRtcEngineKit *_Nonnull) |
engine |
| publishingRequestAnsweredByOwner: |
|
(NSString *_Nonnull) |
userId |
| accepted: |
|
(BOOL) |
accepted |
| error: |
|
(AgoraErrorCode) |
error |
|
|
| |
|
optional |
◆ rtcEngine:unpublishingRequestReceivedFromOwner:
| - (void) rtcEngine: |
|
(AgoraRtcEngineKit *_Nonnull) |
engine |
| unpublishingRequestReceivedFromOwner: |
|
(NSString *_Nonnull) |
userId |
|
|
| |
|
optional |
◆ rtcEngineIntraRequestReceived:
Intra request received.
- Parameters
-
◆ rtcEngine:bandwidthEstimationUpdate:
Target bitrate updated.
- Parameters
-
| engine | The AgoraRtcEngineKit object. |
| networkInfo | The suggested network info, including target bitrate bps. |
◆ rtcEngine:connectionStateChanged:reason:
Occurs when the connection state of the SDK to the server is changed.
- Parameters
-
◆ 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 |
|
|
| |
|
optionalinherited |
Event of API call executed
- Parameters
-
| engine | The engine kit |
| api | The API description |
| error | The error code |
◆ 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: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 |
|
|
| |
|
optionalinherited |
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:errorCode:
| - (void) rtcEngine: |
|
(AgoraRtcEngineKit *_Nonnull) |
engine |
| audioMixingStateChanged: |
|
(AgoraAudioMixingStateType) |
state |
| errorCode: |
|
(AgoraAudioMixingErrorType) |
errorCode |
|
|
| |
|
optionalinherited |
Audio mixing state changed.
- Parameters
-
| engine | The AgoraRtcEngineKit object. |
| state | AgoraAudioMixingStateType |
| errorCode | AgoraAudioMixingErrorType |
◆ 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:streamStateChanged:state:errCode: