Agora RTC Objective-C API Reference  Refactor
AgoraBaseDelegate.h
Go to the documentation of this file.
1 //
2 // AgoraRtcEngineKit.h
3 // AgoraRtcEngineKit
4 //
5 // Created by Sting Feng on 2015-8-11.
6 // Copyright (c) 2015 Agora. All rights reserved.
7 //
8 
9 @class AgoraRtcEngineKit;
10 
11 @protocol AgoraBaseDelegate <NSObject>
12 @optional
13 #pragma mark SDK common delegates
14 
20 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didOccurWarning:(AgoraWarningCode)warningCode;
21 
28 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didOccurError:(AgoraErrorCode)errorCode;
29 
35 - (void)rtcEngineMediaEngineDidLoaded:(AgoraRtcEngineKit * _Nonnull)engine;
36 
42 - (void)rtcEngineMediaEngineDidStartCall:(AgoraRtcEngineKit * _Nonnull)engine;
43 
51 - (void)rtcEngineRequestToken:(AgoraRtcEngineKit * _Nonnull)engine;
52 
59 - (void)rtcEngineConnectionDidInterrupted:(AgoraRtcEngineKit * _Nonnull)engine;
60 
67 - (void)rtcEngineConnectionDidLost:(AgoraRtcEngineKit * _Nonnull)engine;
68 
73 - (void)rtcEngineConnectionDidBanned:(AgoraRtcEngineKit * _Nonnull)engine;
74 
81 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine reportRtcStats:(AgoraChannelStats * _Nonnull)stats;
82 
89 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine lastmileQuality:(AgoraNetworkQuality)quality;
90 
99 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine lastmileProbeTestResult:(AgoraLastmileProbeResult * _Nonnull)result;
100 
108 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didApiCallExecute:(NSInteger)error api:(NSString * _Nonnull)api result:(NSString * _Nonnull)result;
109 
116 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didRefreshRecordingServiceStatus:(NSInteger)status;
117 
118 #if (!(TARGET_OS_IPHONE) && (TARGET_OS_MAC))
119 
127 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine device:(NSString * _Nonnull) deviceId type:(AgoraMediaDeviceType) deviceType stateChanged:(NSInteger) state;
128 
129 #endif
130 
131 #pragma mark Local user common delegates
132 
140 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didClientRoleChanged:(AgoraClientRole)oldRole newRole:(AgoraClientRole)newRole;
141 
148 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didLeaveChannelWithStats:(AgoraChannelStats * _Nonnull)stats;
149 
150 #pragma mark Local user audio delegates
151 
157 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine firstLocalAudioFramePublished:(NSInteger)elapsed;
158 
166 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine localAudioStats:(AgoraRtcLocalAudioStats * _Nonnull)stats;
167 
174 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didAudioRouteChanged:(AgoraAudioOutputRouting)routing;
175 
181 - (void)rtcEngineLocalAudioMixingDidFinish:(AgoraRtcEngineKit * _Nonnull)engine;
182 
189 - (void)rtcEngine:(AgoraRtcEngineKit *_Nonnull)engine audioMixingStateChanged:(AgoraAudioMixingStateType)state
190  errorCode:(AgoraAudioMixingErrorType)errorCode;
191 
197 - (void)rtcEngineDidAudioEffectFinish:(AgoraRtcEngineKit * _Nonnull)engine soundId:(int)soundId;
198 
199 
200 #pragma mark Local user video delegates
201 
206 - (void)rtcEngineCameraDidReady:(AgoraRtcEngineKit * _Nonnull)engine;
207 
208 #if TARGET_OS_IPHONE
209 
215 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine cameraFocusDidChangedToRect:(CGRect)rect;
216 #endif
217 
223 - (void)rtcEngineVideoDidStop:(AgoraRtcEngineKit * _Nonnull)engine;
224 
232 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine firstLocalVideoFrameWithSize:(CGSize)size elapsed:(NSInteger)elapsed;
233 
240 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine localVideoStats:(AgoraRtcLocalVideoStats * _Nonnull)stats;
241 
242 #pragma mark Remote user audio delegates
243 
251 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine reportAudioVolumeIndicationOfSpeakers:(NSArray<AgoraRtcAudioVolumeInfo *> * _Nonnull)speakers totalVolume:(NSInteger)totalVolume;
252 
258 - (void)rtcEngineRemoteAudioMixingDidStart:(AgoraRtcEngineKit * _Nonnull)engine;
259 
265 - (void)rtcEngineRemoteAudioMixingDidFinish:(AgoraRtcEngineKit * _Nonnull)engine;
266 
273 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine remoteAudioStats:(AgoraRtcRemoteAudioStats * _Nonnull)stats;
274 
275 #pragma mark Remote user video delegates
276 
283 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine remoteVideoStats:(AgoraRtcRemoteVideoStats * _Nonnull)stats;
284 
285 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine streamStateChanged:(NSString * _Nonnull)url
286  state:(AgoraRtmpStreamPublishState)state
287  errCode:(AgoraRtmpStreamPublishError)errCode;
288 
289 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine streamPublishedWithUrl:(NSString * _Nonnull)url errorCode:(AgoraErrorCode)errorCode;
290 
291 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine streamUnpublishedWithUrl:(NSString * _Nonnull)url;
292 
293 - (void)rtcEngineTranscodingUpdated:(AgoraRtcEngineKit * _Nonnull)engine;
294 
295 @end
296 
297 /*
298 
299 - (int)joinChannelByToken:(NSString * _Nullable)token
300  channelId:(NSString * _Nonnull)channelId
301  info:(NSString * _Nullable)info
302  userId:(NSString * _Nullable)userId;
303 
304 - (int)setRemoteRenderModeWithUid:(NSString * _Nonnull)userId
305  mode:(AgoraVideoRenderMode) mode;
306 
307 - (int)switchView:(NSString * _Nonnull)userId1
308  andAnother:(NSString * _Nonnull)userId2 __deprecated;
309 
310 - (int)muteRemoteAudioStream:(NSString * _Nonnull)userId mute:(BOOL)mute;
311 
312 - (int)setRemoteVideoStream:(NSString * _Nonnull)userId
313  type:(AgoraVideoStreamType)streamType;
314 - (int)muteRemoteVideoStream:(NSString * _Nonnull)userId
315  mute:(BOOL)mute;
316 
317 - (void)setRemoteVideoRenderer:(id<AgoraVideoSinkProtocol> _Nullable)videoRenderer withUserId:(NSString * _Nonnull)userId;
318 
319 - (int)sendPublishingRequestToOwner:(NSString * _Nonnull) userId;
320 - (int)answerPublishingRequestOfUid:(NSString * _Nonnull) userId accepted:(bool)accepted;
321 - (int)sendUnpublishingRequestToUid:(NSString * _Nonnull) userId;
322 
323 - (id<AgoraVideoSinkProtocol> _Nullable)remoteVideoRendererOfUserId:(NSString * _Nonnull)userId;
324 */
AgoraRtmpStreamPublishError
AgoraRtmpStreamPublishError
Definition: AgoraEnumerates.h:1398
AgoraRtcEngineKit
Definition: AgoraRtcEngineKit.h:920
AgoraBaseDelegate-p
Definition: AgoraBaseDelegate.h:11
AgoraClientRole
AgoraClientRole
Definition: AgoraEnumerates.h:486
AgoraRtcRemoteVideoStats
Definition: AgoraObjects.h:276
AgoraRtmpStreamPublishState
AgoraRtmpStreamPublishState
Definition: AgoraEnumerates.h:1359
AgoraRtcRemoteAudioStats
Definition: AgoraObjects.h:346
AgoraRtcAudioVolumeInfo
Definition: AgoraObjects.h:403
AgoraNetworkQuality
AgoraNetworkQuality
Definition: AgoraEnumerates.h:590
AgoraRtcLocalAudioStats
Definition: AgoraObjects.h:324
AgoraLastmileProbeResult
Definition: AgoraObjects.h:198
AgoraChannelStats
Definition: AgoraObjects.h:415