AgoraRtcEngineDelegate
The SDK uses the AgoraRtcEngineDelegate interface to send event notifications to your app. Your app can get those notifications through methods that inherit this interface.
All methods in this interface have default (empty) implementation. You can choose to inherit events related to your app scenario. In the callbacks, avoid implementing time-consuming tasks or calling APIs that may cause thread blocking (such as sendMessage). Otherwise, the SDK may not work properly.
activeSpeaker
Occurs when the most active speaker is detected.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine activeSpeaker:(NSUInteger)speakerUid;
After a successful call of enableAudioVolumeIndication, the SDK continuously detects which remote user has the loudest volume. During the current period, the remote user, who is detected as the loudest for the most times, is the most active user.
- If the most active speaker remains the same, the SDK triggers the activeSpeaker callback only once.
- If the most active speaker changes to another user, the SDK triggers this callback again and reports the uid of the new active speaker.
Parameters
- engine
- AgoraRtcEngineKit object.
- speakerUid
- The user ID of the most active speaker.
didApiCallExecute
Occurs when a method is executed by the SDK.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
didApiCallExecute:(NSInteger)error
api:(NSString * _Nonnull)api
result:(NSString * _Nonnull)result;
Parameters
- engine
- AgoraRtcEngineKit object.
- error
- The error code returned by the SDK when the method call fails. If the SDK returns 0, then the method call is successful.
- api
- The method executed by the SDK.
- result
- The result of the method call.
rtcEngineDidAudioEffectFinish
Occurs when the playback of the local audio effect file finishes.
- (void)rtcEngineDidAudioEffectFinish:(AgoraRtcEngineKit * _Nonnull)engine soundId:(int)soundId;
This callback occurs when the local audio effect file finishes playing.
Parameters
- engine
- AgoraRtcEngineKit object.
- soundId
- The audio effect ID. The ID of each audio effect file is unique.
rtcEngineLocalAudioMixingDidFinish
Occurs when the playback of the local music file finishes.
- (void)rtcEngineLocalAudioMixingDidFinish:(AgoraRtcEngineKit * _Nonnull)engine;
- Deprecated:
- This method is deprecated as of v2.4.0. Use audioMixingStateChanged instead.
After you call startAudioMixing [2/2] to play a local music file, this callback occurs when the playback finishes. If the call of startAudioMixing [2/2] fails, the callback returns the error code WARN_AUDIO_MIXING_OPEN_ERROR.
Parameters
- engine
- AgoraRtcEngineKit object.
audioMixingStateChanged
Occurs when the playback state of the music file changes.
- (void)rtcEngine:(AgoraRtcEngineKit *_Nonnull)engine audioMixingStateChanged:(AgoraAudioMixingStateType)state
errorCode:(AgoraAudioMixingErrorType)errorCode;
This callback occurs when the playback state of the music file changes, and reports the current state and error code.
Parameters
- state
- The playback state of the music file. For details, see AgoraAudioMixingStateType.
- errorCode
- Error code. For details, see AgoraAudioMixingErrorType.
didAudioPublishStateChange
Occurs when the audio publishing state changes.
- (void)rtcEngine:(AgoraRtcEngineKit *_Nonnull)engine
didAudioPublishStateChange:(NSString * _Nonnull)channelId
oldState:(AgoraStreamPublishState)oldState
newState:(AgoraStreamPublishState)newState
elapseSinceLastState:(int)elapseSinceLastState;
Parameters
- engine
- AgoraRtcEngineKit object.
- channelId
- The name of the channel.
- oldState
- For the previous publishing state, see AgoraStreamPublishState.
- newState
- For the current publishing state, see AgoraStreamPublishState.
- elapseSinceLastState
- The time elapsed (ms) from the previous state to the current state.
audioQualityOfUid
Reports the statistics of the audio stream from each remote user.
- (void)audioQualityBlock:(void (^_Nullable)(NSUInteger uid, AgoraNetworkQuality quality, NSUInteger delay, NSUInteger lost))audioQualityBlock
- Deprecated:
- Deprecated.Please use remoteAudioStats instead.
The SDK triggers this callback once every two seconds to report the audio quality of each remote user/host sending an audio stream. If a channel has multiple users/hosts sending audio streams, the SDK triggers this callback as many times.
Parameters
- engine
- AgoraRtcEngineKit object.
- uid
- The user ID of the remote user sending the audio stream.
- quality
- Audio quality of the user. For details, see AgoraNetworkQuality.
- delay
- The network delay (ms) from the sender to the receiver, including the delay caused by audio sampling pre-processing, network transmission, and network jitter buffering.
- lost
- Packet loss rate (%) of the audio packet sent from the sender to the receiver.
didAudioRouteChanged
Occurs when the local audio route changes.
Parameters
- engine
- AgoraRtcEngineKit object.
- routing
The current audio routing. For details, see AgoraAudioOutputRouting.
didAudioSubscribeStateChange
Occurs when the audio subscribing state changes.
- (void)rtcEngine:(AgoraRtcEngineKit *_Nonnull)engine
didAudioSubscribeStateChange:(NSString * _Nonnull)channelId
uid:(unsigned int)uid
oldState:(AgoraStreamSubscribeState)oldState
newState:(AgoraStreamSubscribeState)newState
elapseSinceLastState:(int)elapseSinceLastState;
Parameters
- engine
- AgoraRtcEngineKit object.
- channelId
- The name of the channel.
- uid
- The ID of the remote user.
- oldState
- The previous subscribing status, see AgoraStreamSubscribeState for details.
- newState
- The current subscribing status, see AgoraStreamSubscribeState for details.
- elapseSinceLastState
- The time elapsed (ms) from the previous state to the current state.
reportAudioVolumeIndicationOfSpeakers
Reports the volume information of users.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
reportAudioVolumeIndicationOfSpeakers:(NSArray<AgoraRtcAudioVolumeInfo *> * _Nonnull)speakers
totalVolume:(NSInteger)totalVolume;
By default, this callback is disabled. You can enable it by calling enableAudioVolumeIndication. Once this callback is enabled and users send streams in the channel, the SDK triggers the enableAudioVolumeIndication callback at the time interval set in reportAudioVolumeIndicationOfSpeakers. The SDK triggers two independent reportAudioVolumeIndicationOfSpeakers callbacks simultaneously, which separately report the volume information of the local user who sends a stream and the remote users (up to three) whose instantaneous volumes are the highest.
- If the local user stops publishing the audio stream, the SDK stops triggering the local user's callback.
- 20 seconds after a remote user whose volume is one of the three highest stops publishing the audio stream, the callback excludes this user's information; 20 seconds after all remote users stop publishing audio streams, the SDK stops triggering the callback for remote users.
Parameters
- engine
- AgoraRtcEngineKit object.
- speakers
- The volume information of the users, see AgoraRtcAudioVolumeInfo. An empty speakers array in the callback indicates that no remote user is in the channel or sending a stream at the moment.
- totalVolume
-
The volume of the speaker. The value range is [0,255].
- In the callback for the local user, totalVolume is the volume of the local user who sends a stream.
- In the callback for remote users, totalVolume is the sum of the volume of all remote users (up to three) whose instantaneous volumes are the highest. If the user calls startAudioMixing [2/2], then totalVolume is the volume after audio mixing.
didReceiveChannelMediaRelayEvent
Reports events during the media stream relay.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didReceiveChannelMediaRelayEvent:(AgoraChannelMediaRelayEvent)event;
Parameters
- engine
- AgoraRtcEngineKit object.
- event
The event code of channel media relay. See AgoraChannelMediaRelayEvent.
channelMediaRelayStateDidChange
Occurs when the state of the media stream relay changes.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
channelMediaRelayStateDidChange:(AgoraChannelMediaRelayState)state
error:(AgoraChannelMediaRelayError)error;
The SDK returns the state of the current media relay with any error message.
Parameters
- engine
- AgoraRtcEngineKit object.
- state
-
The state code. For details, see AgoraChannelMediaRelayState.
- code
-
The error code of the channel media replay. For details, see AgoraChannelMediaRelayError.
didClientRoleChanged
Occurs when the user role switches in the interactive live streaming.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didClientRoleChanged:
(AgoraClientRole)oldRole
newRole:(AgoraClientRole)newRole;
The SDK triggers this callback when the local user switches the user role after joining the channel.
Parameters
- engine
- AgoraRtcEngineKit object.
- oldRole
- Role that the user switches from: AgoraClientRole.
- newRole
- Role that the user switches to: AgoraClientRole.
rtcEngineConnectionDidBanned
Occurs when the connection is banned by the Agora server.
- (void)rtcEngineConnectionDidBanned:(AgoraRtcEngineKit * _Nonnull)engine;
- Deprecated:
- Please use connectionChangedToState instead.
Parameters
- engine
- AgoraRtcEngineKit object.
rtcEngineConnectionDidInterrupted
Occurs when the connection between the SDK and the server is interrupted.
- (void)rtcEngineConnectionDidInterrupted:(AgoraRtcEngineKit * _Nonnull)engine;
- Deprecated:
- Please use connectionChangedToState instead.
- The SDK triggers the rtcEngineConnectionDidInterrupted callback when it loses connection with the server for more than four seconds after it successfully joins the channel.
- The SDK triggers the rtcEngineConnectionDidLost callback when it loses connection with the server for more than 10 seconds, whether or not it joins the channel.
Parameters
- engine
- AgoraRtcEngineKit object.
rtcEngineConnectionDidLost
Occurs when the SDK cannot reconnect to Agora's edge server 10 seconds after its connection to the server is interrupted.
- (void)rtcEngineConnectionDidLost:(AgoraRtcEngineKit * _Nonnull)engine;
The SDK triggers this callback when it cannot connect to the server 10 seconds after calling the joinChannelByToken [2/2] method, regardless of whether it is in the channel. If the SDK fails to rejoin the channel 20 minutes after being disconnected from Agora's edge server, the SDK stops rejoining the channel.
Parameters
- engine
- AgoraRtcEngineKit object.
connectionChangedToState
Occurs when the network connection state changes.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
connectionStateChanged:(AgoraConnectionState)state
reason:(AgoraConnectionChangedReason)reason;
When the network connection state changes, the SDK triggers this callback and reports the current connection state and the reason for the change.
Parameters
- engine
- AgoraRtcEngineKit object.
- state
The current connection state. For details, see AgoraConnectionState.
- reason
The reason for a connection state change. For details, see AgoraConnectionChangedReason.
didOccurEncryptionError
Reports the built-in encryption errors.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
didOccurEncryptionError:(AgoraEncryptionErrorType)errorType;
When encryption is enabled by calling enableEncryption, the SDK triggers this callback if an error occurs in encryption or decryption on the sender or the receiver side.
Parameters
- engine
- AgoraRtcEngineKit object.
- errorType
- For details about the error type, see AgoraEncryptionErrorType.
firstLocalAudioFramePublished
Occurs when the first audio frame is published.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine firstLocalAudioFramePublished:(NSInteger)elapsed;
- The local client enables the audio module and calls joinChannelByToken [2/2] successfully.
- The local client calls muteLocalAudioStream(
YES) and muteLocalAudioStream(NO) in sequence. - The local client calls disableAudio and enableAudio in sequence.
- The local client calls pushExternalAudioFrameNSData to successfully push the audio frame to the SDK.
Parameters
- engine
- AgoraRtcEngineKit object.
- elapsed
- The time elapsed (ms) from the local client calling joinChannelByToken [2/2] until the SDK triggers this callback.
firstLocalVideoFramePublishedWithElapsed
Occurs when the first video frame is published.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
firstLocalVideoFramePublishedWithElapsed:(NSInteger)elapsed;
- The local client enables the video module and calls joinChannelByToken [2/2] successfully.
- The local client calls muteLocalVideoStream(
YES) and muteLocalVideoStream(NO) in sequence. - The local client calls disableVideo and enableVideo in sequence.
- The local client calls pushExternalVideoFrame to successfully push the video frame to the SDK.
Parameters
- engine
- AgoraRtcEngineKit object.
- elapsed
- The time elapsed(ms) from the local client calling joinChannelByToken [2/2] until the SDK triggers this callback.
firstRemoteAudioFrameOfUid
Occurs when the SDK receives the first audio frame from a specific remote user.
- (void)rtcEngine:(AgoraRtcEngineKit* _Nonnull)engine firstRemoteAudioFrameOfUid:(NSUInteger)uid elapsed:(NSInteger)elapsed NS_SWIFT_NAME(rtcEngine(_:firstRemoteAudioFrameOfUid:elapsed:));
- Deprecated:
- Please use remoteAudioStateChangedOfUid instead.
Parameters
- engine
- AgoraRtcEngineKit object.
- uid
- The user ID of the remote user.
- elapsed
- The time elapsed (ms) from the local user calling joinChannelByToken [2/2] until the SDK triggers this callback.
firstRemoteAudioFrameDecodedOfUid
Occurs when the SDK decodes the first remote audio frame for playback.
- (void)rtcEngine:(AgoraRtcEngineKit* _Nonnull)engine firstRemoteAudioFrameDecodedOfUid:(NSUInteger)uid elapsed:(NSInteger)elapsed;
- Deprecated:
- Please use remoteAudioStateChangedOfUid instead.
- The remote user joins the channel and sends the audio stream for the first time.
- The remote user's audio is offline and then goes online to re-send audio. It means the local user cannot receive audio in 15 seconds. Reasons for such an interruption include:
- The remote user leaves channel.
- The remote user drops offline.
- The remote user calls muteLocalAudioStream to stop sending the audio stream.
- The remote user calls disableAudio to disable audio.
Parameters
- engine
- AgoraRtcEngineKit object.
- uid
- The ID of the remote user.
- elapsed
- The time elapsed (ms) from the local user calling joinChannelByToken [2/2] until the SDK triggers this callback.
firstRemoteVideoDecodedOfUid
Occurs when the first remote video frame is received and decoded.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
firstRemoteVideoDecodedOfUid:(NSUInteger)uid size:(CGSize)size elapsed:(NSInteger)elapsed;
- Deprecated:
- Please use the remoteVideoStateChangedOfUid callback with the following parameters:
- AgoraVideoRemoteStateStarting (1).
- AgoraVideoRemoteStateDecoding (2).
- The remote user joins the channel and sends the video stream.
- The remote user stops sending the video stream and re-sends it after 15 seconds. Reasons for such an interruption include:
- The remote user leaves the channel.
- The remote user drops offline.
- The remote user calls muteLocalVideoStream to stop sending the video stream.
- The remote user calls disableVideo to disable video.
Parameters
- uid
- The user ID of the remote user sending the video stream.
- engine
- AgoraRtcEngineKit object.
- size
- Video dimensions.
- elapsed
- The time elapsed (ms) from the local user calling joinChannelByToken [2/2] until the SDK triggers this callback.
firstRemoteVideoFrameOfUid
Occurs when the first remote video frame is rendered.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
firstRemoteVideoFrameOfUid:(NSUInteger)uid size:(CGSize)size elapsed:(NSInteger)elapsed;
The SDK triggers this callback when the first local video frame is displayed/rendered on the local video view. The application can retrieve the time elapsed (the elapsed parameter) from a user joining the channel until the first video frame is displayed.
Parameters
- engine
- AgoraRtcEngineKit object.
- uid
- The user ID of the remote user sending the video stream.
- size
- Video dimensions.
- elapsed
- Time elapsed (ms) from the local user calling joinChannelByToken [2/2] until the SDK triggers this callback.
didJoinChannel
Occurs when a user joins a channel.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
didJoinChannel:(NSString * _Nonnull)channel withUid:(NSUInteger)uid elapsed:(NSInteger) elapsed;
This callback notifies the application that a user joins a specified channel.
Parameters
- engine
- AgoraRtcEngineKit object.
- channel
- The name of the channel.
- uid
- The ID of the user who joins the channel.
- elapsed
- The time elapsed (ms) from the local user calling joinChannelByToken [2/2] until the SDK triggers this callback.
lastmileProbeTestResult
Reports the last mile network probe result.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
lastmileProbeTestResult:(AgoraLastmileProbeResult * _Nonnull)result;
The SDK triggers this callback within 30 seconds after the app calls startLastmileProbeTest.
Parameters
- engine
- AgoraRtcEngineKit object.
- result
- The uplink and downlink last-mile network probe test result. For details, see AgoraLastmileProbeResult.
lastmileQuality
Reports the last-mile network quality of the local user once every two seconds.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine lastmileQuality:(AgoraNetworkQuality)quality;
This callback reports the last-mile network conditions of the local user before the user joins the channel. Last mile refers to the connection between the local device and Agora's edge server.
Before the user joins the channel, this callback is triggered by the SDK once startLastmileProbeTest is called and reports the last-mile network conditions of the local user.
Parameters
- engine
- AgoraRtcEngineKit object.
- quality
- The last mile network quality. See AgoraNetworkQuality.
didLeaveChannelWithStats
Occurs when a user leaves a channel.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
didLeaveChannelWithStats:(AgoraChannelStats * _Nonnull)stats;
This callback notifies the app that the user leaves the channel by calling leaveChannel [1/2]. From this callback, the app can get information such as the call duration and quality statistics.
Parameters
- engine
- AgoraRtcEngineKit object.
- stats
- The statistics of the call, see AgoraChannelStats .
localAudioStateChanged
Occurs when the local audio stream state changes.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
localAudioStateChanged:(AgoraAudioLocalState)state error:(AgoraAudioLocalError)error;
When the state of the local audio stream changes (including the state of the audio capture and encoding), the SDK triggers this callback to report the current state. This callback indicates the state of the local audio stream, and allows you to troubleshoot issues when audio exceptions occur.
Parameters
- engine
- AgoraRtcEngineKit object.
- state
- The state of the local audio. For details, see AgoraAudioLocalState.
- error
- Local audio state error codes. For details, see AgoraAudioLocalError.
localAudioStats
Reports the statistics of the local audio stream.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
localAudioStats:(AgoraRtcLocalAudioStats * _Nonnull)stats;
The SDK triggers this callback once every two seconds.
Parameters
- engine
- AgoraRtcEngineKit object.
- stats
- Local audio statistics. For details, see AgoraRtcLocalAudioStats.
didLocalUserRegisteredWithUserId
Occurs when the local user registers a user account.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didLocalUserRegisteredWithUserId:(NSUInteger)uid userAccount:(NSString * _Nonnull)userAccount;
After the local user successfully calls registerLocalUserAccountWithAppID to register the user account or calls joinChannelByToken [2/2] to join a channel, the SDK triggers the callback and informs the local user's UID and User Account.
Parameters
- engine
- AgoraRtcEngineKit object.
- uid
- The ID of the local user.
- userAccount
- The user account of the local user.
localVideoStateChangedOfState
Occurs when the local video stream state changes.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
localVideoStateChangedOfState:(AgoraVideoLocalState)state
error:(AgoraLocalVideoStreamError)error;
When the state of the local video stream changes (including the state of the video capture and encoding), the SDK triggers this callback to report the current state. 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.
- The app switches to the background, and the system gets the camera resource.
- The camera starts normally, but does not output video for four consecutive seconds.
When the camera outputs the captured video frames, if the video frames are the same for 15 consecutive frames, the SDK triggers the localVideoStateChangedOfState callback with the state code of AgoraVideoLocalStateCapturing and error code of AgoraLocalVideoStreamErrorCaptureFailure. Note that the video frame duplication detection is only available for video frames with a resolution greater than 200 × 200, a frame rate greater than or equal to 10 fps, and a bitrate less than 20 Kbps.
Parameters
- engine
- AgoraRtcEngineKit object.
- state
-
The state of the local video, see AgoraVideoLocalState.
- error
-
The detailed error information, see AgoraLocalVideoStreamError.
localVideoStats
Reports the statistics of the local video stream.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
localVideoStats:(AgoraRtcLocalVideoStats * _Nonnull)stats;
The SDK triggers this callback once every two seconds to report the statistics of the local video stream.
Parameters
- engine
- AgoraRtcEngineKit object.
- stats
- The statistics of the local video stream. For details, see AgoraRtcLocalVideoStats.
rtcEngineMediaEngineDidLoaded
Occurs when the media engine loads.
- (void)rtcEngineMediaEngineDidLoaded:(AgoraRtcEngineKit * _Nonnull)engine;
Parameters
- engine
- AgoraRtcEngineKit object.
rtcEngineMediaEngineDidStartCall
Occurs when the media engine call starts.
- (void)rtcEngineMediaEngineDidStartCall:(AgoraRtcEngineKit * _Nonnull)engine;
Parameters
- engine
- AgoraRtcEngineKit object.
networkQuality
Reports the last mile network quality of each user in the channel.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
networkQuality:(NSUInteger)uid
txQuality:(AgoraNetworkQuality)txQuality
rxQuality:(AgoraNetworkQuality)rxQuality;
This callback reports the last mile network conditions of each user in the channel. Last mile refers to the connection between the local device and Agora's edge server.
The SDK triggers this callback once every two seconds. If a channel includes multiple users, the SDK triggers this callback as many times.
Parameters
- engine
- AgoraRtcEngineKit object.
- uid
-
User ID. The network quality of the user with this user ID is reported.
- txQuality
- Uplink network quality rating of the user in terms of the transmission bit rate, packet loss rate, average RTT (Round-Trip Time) and jitter of the uplink network. This parameter is a quality rating helping you understand how well the current uplink network conditions can support the selected video encoder configuration. For example, a 1000 Kbps uplink network may be adequate for video frames with a resolution of 640 × 480 and a frame rate of 15 fps in the LIVE_BROADCASTING profile, but might be inadequate for resolutions higher than 1280 × 720. For details, see AgoraNetworkQuality.
- rxQuality
- Downlink network quality rating of the user in terms of packet loss rate, average RTT, and jitter of the downlink network. For details, see AgoraNetworkQuality.
networkTypeChangedToType
Occurs when the local network type changes.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine networkTypeChanged:(AgoraNetworkType)type;
This callback occurs when the connection state of the local user changes. You can get the connection state and reason for the state change in this callback. When the network connection is interrupted, this callback indicates whether the interruption is caused by a network type change or poor network conditions.
Parameters
- engine
- AgoraRtcEngineKit object.
- type
The type of the local network connection. For details, see AgoraNetworkType.
permissionError
Occurs when the SDK cannot get the device permission.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine permissionError:(AgoraPermissionType)type;
When the SDK fails to get the device permission, the SDK triggers this callback to report which device permission cannot be got.
Parameters
- engine
- AgoraRtcEngineKit object.
- type
- The type of the device permission. For details, see AgoraPermissionType.
didRejoinChannel
Occurs when a user rejoins the channel.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
didRejoinChannel:(NSString * _Nonnull)channel withUid:(NSUInteger)uid elapsed:(NSInteger) elapsed;
When a user loses connection with the server because of network problems, the SDK automatically tries to reconnect and triggers this callback upon reconnection.
Parameters
- engine
- AgoraRtcEngineKit object.
- channel
- The name of the channel.
- uid
- The ID of the user who rejoins the channel.
- elapsed
- Time elapsed (ms) from starting to reconnect until the SDK triggers this callback.
remoteAudioStateChangedOfUid
Occurs when the remote audio state changes.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
remoteAudioStateChangedOfUid:(NSUInteger)uid state:(AgoraAudioRemoteState)state reason:(AgoraAudioRemoteReason)reason elapsed:(NSInteger)elapsed;
When the audio state of a remote user (in the voice/video call channel) or host (in the live streaming channel) changes, the SDK triggers this callback to report the current state of the remote audio stream.
Parameters
- engine
- AgoraRtcEngineKit object.
- uid
- The ID of the remote user whose audio state changes.
- state
- The state of the remote audio, see AgoraAudioRemoteState.
- reason
- The reason of the remote audio state change, see AgoraAudioRemoteReason.
- elapsed
- Time elapsed (ms) from the local user calling the joinChannelByToken [2/2] method until the SDK triggers this callback.
remoteAudioStats
Reports the transport-layer statistics of each remote audio stream.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
remoteAudioStats:(AgoraRtcRemoteAudioStats * _Nonnull)stats;
The SDK triggers this callback once every two seconds for each remote user who is sending audio streams. If a channel includes multiple remote users, the SDK triggers this callback as many times.
Parameters
- engine
- AgoraRtcEngineKit object.
- stats
- The statistics of the received remote audio streams. See AgoraRtcRemoteAudioStats.
audioTransportStatsOfUid
Reports the transport-layer statistics of each remote audio stream.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
audioTransportStatsOfUid:(NSUInteger)uid
delay:(NSUInteger)delay
lost:(NSUInteger)lost
rxKBitRate:(NSUInteger)rxKBitRate;
- Deprecated:
- Please use remoteAudioStats instead.
This callback reports the transport-layer statistics, such as the packet loss rate and network time delay, once every two seconds after the local user receives an audio packet from a remote user. During a call, when the user receives the audio packet sent by the remote user/host, the callback is triggered every 2 seconds.
Parameters
- engine
- AgoraRtcEngineKit object.
- uid
- The ID of the remote user sending the audio streams.
- delay
- The network delay (ms) from the sender to the receiver.
- lost
- Packet loss rate (%) of the audio packet sent from the sender to the receiver.
- rxKBitrate
- Bitrate of the received audio (Kbps).
remoteVideoStateChangedOfUid
Occurs when the remote video state changes.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
remoteVideoStateChangedOfUid:(NSUInteger)uid state:(AgoraVideoRemoteState)state reason:(AgoraVideoRemoteReason)reason elapsed:(NSInteger)elapsed;
Parameters
- engine
- AgoraRtcEngineKit object.
- uid
- The ID of the remote user whose video state changes.
- state
-
The state of the remote video, see AgoraVideoRemoteState.
- reason
-
The reason for the remote video state change, see AgoraVideoRemoteReason.
- elapsed
- Time elapsed (ms) from the local user calling the joinChannelByToken [2/2] method until the SDK triggers this callback.
remoteVideoStats
Reports the transport-layer statistics of each remote video stream.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
remoteVideoStats:(AgoraRtcRemoteVideoStats * _Nonnull)stats;
Reports the statistics of the video stream from the remote users. The SDK triggers this callback once every two seconds for each remote user. If a channel has multiple users/hosts sending video streams, the SDK triggers this callback as many times.
Parameters
- engine
- AgoraRtcEngineKit object.
- stats
- Statistics of the remote video stream. For details, see AgoraRtcRemoteVideoStats.
videoTransportStatsOfUid
Reports the transport-layer statistics of each remote video stream.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
videoTransportStatsOfUid:(NSUInteger)uid
delay:(NSUInteger)delay
lost:(NSUInteger)lost
rxKBitRate:(NSUInteger)rxKBitRate;
- Deprecated:
- Please use remoteVideoStats instead.
This callback reports the transport-layer statistics, such as the packet loss rate and network time delay, once every two seconds after the local user receives a video packet from a remote user.
During a call, when the user receives the video packet sent by the remote user/host, the callback is triggered every 2 seconds.
Parameters
- engine
- AgoraRtcEngineKit object.
- uid
- The ID of the remote user sending the video packets.
- delay
- The network delay (ms) from the sender to the receiver.
- lost
- The packet loss rate (%) of the video packet sent from the remote user.
- rxKBitRate
- The bitrate of the received video (Kbps).
rtcEngineRequestToken
Occurs when the token expires.
- (void)rtcEngineRequestToken:(AgoraRtcEngineKit * _Nonnull)engine;
When the token expires during a call, the SDK triggers this callback to remind the app to renew the token.
Once you receive this callback, generate a new token on your app server, and call joinChannelByToken [2/2] to rejoin the channel.
Parameters
- engine
- AgoraRtcEngineKit object.
reportRtcStats
Reports the statistics of the current call.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
reportRtcStats:(AgoraChannelStats * _Nonnull)stats;
The SDK triggers this callback once every two seconds after the user joins the channel.
Parameters
- engine
- AgoraRtcEngineKit object.
- stats
-
Statistics of the RTC engine, see AgoraChannelStats for details.
rtmpStreamingEventWithUrl
Reports events during the media push.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine rtmpStreamingEventWithUrl:(NSString* _Nonnull)url eventCode:(AgoraRtmpStreamingEvent)eventCode;
Parameters
- url
- The URL for media push.
- eventCode
- The event code of media push. See AgoraRtmpStreamingEvent for details.
rtmpStreamingChangedToState
Occurs when the media push state changes.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
rtmpStreamingChangedToState:(NSString * _Nonnull)url
state:(AgoraRtmpStreamPublishState)state
errCode:(AgoraRtmpStreamPublishError)errCode;
When the media push state changes, the SDK triggers this callback to report the current state and the reason why the state has changed. When exceptions occur, you can troubleshoot issues by referring to the detailed error descriptions in the error code parameter.
Parameters
- engine
- AgoraRtcEngineKit object.
- url
The URL address where the state of the media push changes.
- state
- The current state of the media push. See AgoraRtmpStreamingState. When the streaming state is AgoraRtmpStreamingStateFailure (4), you can view the error information in the errorCode parameter.
- errCode
- The detailed error information for the media push. See AgoraRtmpStreamingErrorCode.
snapshotTaken
Reports the result of taking a video snapshot.
- (void)rtcEngine:(AgoraRtcEngineKit* _Nonnull)engine snapshotTaken:(NSString* _Nonnull)channel uid:(NSUInteger)uid filePath:(NSString* _Nonnull)filePath width:(NSInteger)width height:(NSInteger)height errCode:(NSInteger)errCode;
Parameters
- engine
- AgoraRtcEngineKit object.
- channel
- The channel name.
- uid
- The user ID. A uid of 0 indicates the local user.
- filePath
- The local path of the snapshot.
- width
- The width (px) of the snapshot.
- height
- The height (px) of the snapshot.
- errCode
- The message that confirms success or the reason why the snapshot is not successfully taken:
- 0: Success.
- < 0: Failure:
- -1: The SDK fails to write data to a file or encode a JPEG image.
- -2: The SDK does not find the video stream of the specified user within one second after the takeSnapshot method call succeeds.
receiveStreamMessageFromUid
Occurs when the local user receives the data stream from the remote user.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
receiveStreamMessageFromUid:(NSUInteger)uid
streamId:(NSInteger)streamId
data:(NSData * _Nonnull)data;
The SDK triggers this callback when the local user receives the stream message that the remote user sends by calling the sendStreamMessage method.
Parameters
- engine
- AgoraRtcEngineKit object.
- uid
- The ID of the remote user sending the message.
- streamId
- The stream ID of the received message.
- data
- The data received.
didOccurStreamMessageErrorFromUid
Occurs when the local user does not receive the data stream from the remote user.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
didOccurStreamMessageErrorFromUid:(NSUInteger)uid
streamId:(NSInteger)streamId
error:(NSInteger)error
missed:(NSInteger)missed
cached:(NSInteger)cached;
The SDK triggers this callback when the local user fails to receive the stream message that the remote user sends by calling the sendStreamMessage method.
Parameters
- engine
- AgoraRtcEngineKit object.
- uid
- The ID of the remote user sending the message.
- streamId
- The stream ID of the received message.
- error
- The error code.
- missed
- The number of lost messages.
- cached
- Number of incoming cached messages when the data stream is interrupted.
streamPublishedWithUrl
Occurs when an RTMP or RTMPS stream is published.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
streamPublishedWithUrl:(NSString * _Nonnull)url
errorCode:(AgoraErrorCode)errorCode;
- Deprecated:
- Please use rtmpStreamingChangedToState instead.
Reports the result of publishing an RTMP or RTMPS stream.
Parameters
- engine
- AgoraRtcEngineKit object.
- url
- The CDN streaming URL.
- errorCode
-
Error codes of the RTMP or RTMPS streaming.
ERR_OK(0): The publishing succeeds.ERR_FAILED(1): The publishing fails.ERR_INVALID_ARGUMENT(-2): Invalid argument used. If you do not call setLiveTranscoding to configure AgoraLiveTranscoding before calling addPublishStreamUrl, the SDK reportsERR_INVALID_ARGUMENT.ERR_TIMEDOUT(10): The publishing timed out.ERR_ALREADY_IN_USE(19): The chosen URL address is already in use for CDN live streaming.ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH(130): You cannot publish an encrypted stream.ERR_PUBLISH_STREAM_CDN_ERROR(151): CDN related error. Remove the original URL address and add a new one by calling the removePublishStreamUrl and addPublishStreamUrl methods.ERR_PUBLISH_STREAM_NUM_REACH_LIMIT(152): The host manipulates more than 10 URLs. Delete the unnecessary URLs before adding new ones.ERR_PUBLISH_STREAM_NOT_AUTHORIZED(153): The host manipulates other hosts' URLs. Please check your app logic.ERR_PUBLISH_STREAM_INTERNAL_SERVER_ERROR(154): An error occurs in Agora's streaming server. Call the removePublishStreamUrl method to publish the streaming again.ERR_PUBLISH_STREAM_FORMAT_NOT_SUPPORTED(156): The format of the CDN streaming URL is not supported. Check whether the URL format is correct.
streamUnpublishedWithUrl
Occurs when the media push stops.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
streamUnpublishedWithUrl:(NSString * _Nonnull)url;
- Deprecated:
- Please use rtmpStreamingChangedToState instead.
Parameters
- engine
- AgoraRtcEngineKit object.
- url
- Removes an RTMP or RTMPS URL of the media push.
tokenPrivilegeWillExpire
Occurs when the token expires in 30 seconds.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
tokenPrivilegeWillExpire:(NSString *_Nonnull)token;
When the token is about to expire in 30 seconds, the SDK triggers this callback to remind the app to renew the token.
Upon receiving this callback, generate a new token on your server, and call renewToken to pass the new token to the SDK.
Parameters
- engine
- AgoraRtcEngineKit object.
- token
- The token that expires in 30 seconds.
rtcEngineTranscodingUpdated
Occurs when the publisher's transcoding is updated.
- (void)rtcEngineTranscodingUpdated:(AgoraRtcEngineKit * _Nonnull)engine;
When the AgoraLiveTranscoding class in the setLiveTranscoding method updates, the SDK triggers the rtcEngineTranscodingUpdated callback to report the update information.
Parameters
- engine
- AgoraRtcEngineKit object.
uplinkNetworkInfoUpdate
Occurs when the uplink network information changes.
- (void)rtcEngine:(AgoraRtcEngineKit *_Nonnull)engine
uplinkNetworkInfoUpdate:(AgoraUplinkNetworkInfo *_Nonnull)networkInfo;
The SDK triggers this callback when the uplink network information changes.
Parameters
- engine
- AgoraRtcEngineKit object.
- networkInfo
- The uplink network information. See AgoraUplinkNetworkInfo.
didLocalVideoEnabled
Occurs when a specific remote user enables/disables the local video capturing function.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
didLocalVideoEnabled:(BOOL)enabled
byUid:(NSUInteger)uid
The SDK triggers this callback when the remote user resumes or stops capturing the video stream by calling the enableLocalVideo method.
Parameters
- engine
- AgoraRtcEngineKit object.
- uid
- The user ID of the remote user.
- enabled
-
Whether the specified remote user enables/disables the local video capturing function:
YES: Enable. Other users in the channel can see the video of this remote user.NO: Disable. Other users in the channel can no longer receive the video stream from this remote user, while this remote user can still receive the video streams from other users.
didVideoEnabled
Occurs when a remote user enables/disables the video module.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
didVideoEnabled:(BOOL)enabled
byUid:(NSUInteger)uid
Once the video module is disabled, the user can only use a voice call. The user cannot send or receive any video.
The SDK triggers this callback when a remote user enables or disables the video module by calling the enableVideo or disableVideo method.
Parameters
- engine
- AgoraRtcEngineKit object.
- uid
- The user ID of the remote user.
- enabled
-
YES: Enable.NO: Disable.
didUserInfoUpdatedWithUserId
Occurs when the SDK gets the user ID and user account of the remote user.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didUserInfoUpdatedWithUserId:(NSUInteger)uid userInfo:(AgoraUserInfo* _Nonnull)userInfo;
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, and triggers this callback on the local client.
Parameters
- engine
- AgoraRtcEngineKit object.
- uid
- The ID of the remote user.
- userInfo
- The UserInfo object that contains the user ID and user account of the remote user. See AgoraUserInfo for details.
didJoinedOfUid
Occurs when a remote user (COMMUNICATION)/ host (LIVE_BROADCASTING) joins the channel.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
didJoinedOfUid:(NSUInteger)uid elapsed:(NSInteger)elapsed;
- In a communication channel, this callback indicates that a remote user joins the channel. The SDK also triggers this callback to report the existing users in the channel when a user joins the channel.
- In a live-broadcast channel, this callback indicates that a host joins the channel. The SDK also triggers this callback to report the existing hosts in the channel when a host joins the channel. Agora recommends limiting the number of hosts to 17.
- A remote user/host joins the channel by calling the joinChannelByToken [2/2] method.
- A remote user switches the user role to the host after joining the channel.
- A remote user/host rejoins the channel after a network interruption.
Parameters
- engine
- AgoraRtcEngineKit object.
- uid
- The ID of the user or host who joins the channel.
- elapsed
- Time delay (ms) from the local user calling joinChannelByToken [2/2] until this callback is triggered.
didAudioMuted
Occurs when a remote user (in the communication profile)/ host (in the live streaming profile) joins the channel.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didAudioMuted:(BOOL)muted byUid:(NSUInteger)uid;
The SDK triggers this callback when the remote user stops or resumes sending the audio stream by calling the muteLocalAudioStream method.
Parameters
- uid
- User ID.
- muted
- Whether the remote user's audio stream is muted/unmuted:
YES: Muted.NO: Unmuted.
didVideoMuted
Occurs when a remote user's video stream playback pauses/resumes.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didVideoMuted:(BOOL)muted byUid:(NSUInteger)uid
The SDK triggers this callback when the remote user stops or resumes sending the video stream by calling the muteLocalVideoStream method.
Parameters
- engine
- AgoraRtcEngineKit object.
- uid
- The ID of the remote user.
- muted
- Whether the remote user's video stream playback is paused/resumed:
YES: Paused.NO: Resumed.
didOfflineOfUid
Occurs when a remote user (COMMUNICATION)/ host (LIVE_BROADCASTING) leaves the channel.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
didOfflineOfUid:(NSUInteger)uid
reason:(AgoraUserOfflineReason)reason;
- Leave the channel: When a user/host leaves the channel, the user/host sends a goodbye message. When this message is received, the SDK determines that the user/host leaves the channel.
- Drop offline: When no data packet of the user or host is received for a certain period of time (20 seconds for the communication profile, and more for the live broadcast profile), the SDK assumes that the user/host drops offline. A poor network connection may lead to false detections. It's recommended to use the Agora RTM SDK for reliable offline detection.
Parameters
- engine
- AgoraRtcEngineKit object.
- uid
- The ID of the user who leaves the channel or goes offline.
- reason
Reasons why the user goes offline: AgoraUserOfflineReason.
didVideoPublishStateChange
Occurs when the video publishing state changes.
- (void)rtcEngine:(AgoraRtcEngineKit *_Nonnull)engine
didVideoPublishStateChange:(NSString * _Nonnull)channelId
oldState:(AgoraStreamPublishState)oldState
newState:(AgoraStreamPublishState)newState
elapseSinceLastState:(int)elapseSinceLastState;
Parameters
- engine
- AgoraRtcEngineKit object.
- channelId
- The name of the channel.
- oldState
- For the previous publishing state, see AgoraStreamPublishState.
- newState
- For the current publishing state, see AgoraStreamPublishState.
- elapseSinceLastState
- The time elapsed (ms) from the previous state to the current state.
videoSizeChangedOfUid
Occurs when the video size or rotation of a specified user changes.
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
videoSizeChangedOfUid:(NSUInteger)uid
size:(CGSize)size
rotation:(NSInteger)rotation;
Parameters
- engine
- AgoraRtcEngineKit object.
- uid
- The ID of the user whose video size or rotation changes. uid is 0 for the local user.
- size
- Video dimensions.
- rotation
- The rotation information. The value range is [0,360).
rtcEngineVideoDidStop
Occurs when the video stops playing.
- (void)rtcEngineVideoDidStop:(AgoraRtcEngineKit * _Nonnull)engine;
- Deprecated:
- Please use AgoraVideoLocalStateStopped(0) in the localVideoStateChangedOfState callback instead.
The application can use this callback to change the configuration of the view (for example, displaying other pictures in the view) after the video stops playing.
Parameters
- engine
- AgoraRtcEngineKit object.
didVideoSubscribeStateChange
Occurs when the video subscribing state changes.
- (void)rtcEngine:(AgoraRtcEngineKit *_Nonnull)engine
didVideoSubscribeStateChange:(NSString * _Nonnull)channelId
uid:(unsigned int)uid
oldState:(AgoraStreamSubscribeState)oldState
newState:(AgoraStreamSubscribeState)newState
elapseSinceLastState:(int)elapseSinceLastState;
Parameters
- engine
- AgoraRtcEngineKit object.
- channel
- The name of the channel.
- uid
- The ID of the remote user.
- oldState
- The previous subscribing status, see AgoraStreamSubscribeState for details.
- newState
- The current subscribing status, see AgoraStreamSubscribeState for details.
- elapseSinceLastState
- The time elapsed (ms) from the previous state to the current state.
stateChanged
Occurs when the device state changes.
- (void)rtcEngine:(AgoraRtcEngineKit* _Nonnull)engine device:(NSString* _Nonnull)deviceId
type:(AgoraMediaDeviceType)deviceType
stateChanged:(NSInteger)state;
Parameters
- engine
- AgoraRtcEngineKit object.
- deviceId
- The device ID.
- deviceType
-
The device type, which includes the audio capturing, audio playback, video capturing, or video playback device. See AgoraMediaDeviceType.
- state
- Media device states:
- 0: The device is connected but not in use.
- 8: The device is not connected.
