Agora RTC Objective-C API Reference  Refactor
Instance Methods
<AgoraBaseDelegate> Protocol Reference

Inherits <NSObject>.

Inherited by <AgoraRtcEngineDelegate2>.

Instance Methods

(void) - rtcEngineRequestToken:
 
(void) - rtcEngineConnectionDidLost:
 
(void) - rtcEngine:reportRtcStats:
 
(void) - rtcEngine:lastmileProbeTestResult:
 
(void) - rtcEngine:didApiCallExecute:api:result:
 
(void) - rtcEngine:didClientRoleChanged:newRole:
 
(void) - rtcEngine:didLeaveChannelWithStats:
 
(void) - rtcEngine:firstLocalAudioFramePublished:
 
(void) - rtcEngine:localAudioStats:
 
(void) - rtcEngine:audioMixingStateChanged:errorCode:
 
(void) - rtcEngine:reportAudioVolumeIndicationOfSpeakers:totalVolume:
 
(void) - rtcEngine:remoteAudioStats:
 
(void) - rtcEngine:remoteVideoStats:
 

Method Documentation

◆ rtcEngineRequestToken:

- (void) rtcEngineRequestToken: (AgoraRtcEngineKit *_Nonnull)  engine
optional

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
engineThe engine kit

◆ rtcEngineConnectionDidLost:

- (void) rtcEngineConnectionDidLost: (AgoraRtcEngineKit *_Nonnull)  engine
optional

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
engineThe engine kit

◆ rtcEngine:reportRtcStats:

- (void) rtcEngine: (AgoraRtcEngineKit *_Nonnull)  engine
reportRtcStats: (AgoraChannelStats *_Nonnull)  stats 
optional

Statistics of rtc engine status. Updated every two seconds.

Parameters
engineThe engine kit
statsThe statistics of rtc status, including duration, sent bytes and received bytes

◆ rtcEngine:lastmileProbeTestResult:

- (void) rtcEngine: (AgoraRtcEngineKit *_Nonnull)  engine
lastmileProbeTestResult: (AgoraLastmileProbeResult *_Nonnull)  result 
optional

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
engineAgoraRtcEngineKit object.
resultThe uplink and downlink last-mile network probe test result, see [AgoraLastmileProbeResult](AgoraLastmileProbeResult).

◆ 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
engineThe engine kit
apiThe API description
errorThe error code

◆ rtcEngine:didClientRoleChanged:newRole:

- (void) rtcEngine: (AgoraRtcEngineKit *_Nonnull)  engine
didClientRoleChanged: (AgoraClientRole)  oldRole
newRole: (AgoraClientRole)  newRole 
optional

Event of cient role change. only take effect under broadcasting mode

Parameters
engineThe engine kit
oldRolethe previous role
newRolethe new role

◆ rtcEngine:didLeaveChannelWithStats:

- (void) rtcEngine: (AgoraRtcEngineKit *_Nonnull)  engine
didLeaveChannelWithStats: (AgoraChannelStats *_Nonnull)  stats 
optional

The statistics of the call when leave channel

Parameters
engineThe engine kit
statsThe 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
engineThe engine kit
elapsedThe elapsed time(ms) from the beginning of the session.

◆ rtcEngine:localAudioStats:

- (void) rtcEngine: (AgoraRtcEngineKit *_Nonnull)  engine
localAudioStats: (AgoraRtcLocalAudioStats *_Nonnull)  stats 
optional

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
engineThe AgoraRtcEngineKit object.
statsAgoraRtcLocalAudioStats

◆ rtcEngine:audioMixingStateChanged:errorCode:

- (void) rtcEngine: (AgoraRtcEngineKit *_Nonnull)  engine
audioMixingStateChanged: (AgoraAudioMixingStateType)  state
errorCode: (AgoraAudioMixingErrorType)  errorCode 
optional

Audio mixing state changed.

Parameters
engineThe AgoraRtcEngineKit object.
stateAgoraAudioMixingStateType
errorCodeAgoraAudioMixingErrorType

◆ rtcEngine:reportAudioVolumeIndicationOfSpeakers:totalVolume:

- (void) rtcEngine: (AgoraRtcEngineKit *_Nonnull)  engine
reportAudioVolumeIndicationOfSpeakers: (NSArray< AgoraRtcAudioVolumeInfo * > *_Nonnull)  speakers
totalVolume: (NSInteger)  totalVolume 
optional

The sdk reports the volume of a speaker. The interface is disable by default, and it could be enable by API "enableAudioVolumeIndication"

Parameters
engineThe engine kit
speakersAgoraRtcAudioVolumeInfo array
totalVolumeThe total volume of speakers

◆ rtcEngine:remoteAudioStats:

- (void) rtcEngine: (AgoraRtcEngineKit *_Nonnull)  engine
remoteAudioStats: (AgoraRtcRemoteAudioStats *_Nonnull)  stats 
optional

The statistics of remote audio stream. Update every two seconds.

Parameters
engineThe engine kit
statsThe statistics of audio video, including user id, delay, resolution, received bitrate, received framerate, audio stream type

◆ rtcEngine:remoteVideoStats:

- (void) rtcEngine: (AgoraRtcEngineKit *_Nonnull)  engine
remoteVideoStats: (AgoraRtcRemoteVideoStats *_Nonnull)  stats 
optional

The statistics of remote video stream. Update every two seconds.

Parameters
engineThe engine kit
statsThe statistics of remote video, including user id, delay, resolution, received bitrate, received framerate, video stream type

◆ rtcEngine:streamStateChanged:state:errCode:

- (void) rtcEngine: (AgoraRtcEngineKit *_Nonnull)  engine
streamStateChanged: (NSString *_Nonnull)  url
state: (AgoraRtmpStreamPublishState)  state
errCode: (AgoraRtmpStreamPublishError)  errCode 
optional