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 #import "AgoraObjects.h"
11 
12 @protocol AgoraBaseDelegate <NSObject>
13 @optional
14 #pragma mark SDK common delegates
15 
16 #pragma mark String UID
17 
23 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didLocalUserRegisteredWithUserId:(NSUInteger)uid userAccount:(NSString * _Nonnull)userAccount;
24 
33 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didUserInfoUpdatedWithUserId:(NSUInteger)uid userInfo:(AgoraUserInfo* _Nonnull)userInfo;
34 
41 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didOccurWarning:(AgoraWarningCode)warningCode;
42 
49 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didOccurError:(AgoraErrorCode)errorCode;
50 
56 - (void)rtcEngineMediaEngineDidLoaded:(AgoraRtcEngineKit * _Nonnull)engine;
57 
63 - (void)rtcEngineMediaEngineDidStartCall:(AgoraRtcEngineKit * _Nonnull)engine;
64 
72 - (void)rtcEngineRequestToken:(AgoraRtcEngineKit * _Nonnull)engine;
73 
80 - (void)rtcEngineConnectionDidInterrupted:(AgoraRtcEngineKit * _Nonnull)engine;
81 
88 - (void)rtcEngineConnectionDidLost:(AgoraRtcEngineKit * _Nonnull)engine;
89 
94 - (void)rtcEngineConnectionDidBanned:(AgoraRtcEngineKit * _Nonnull)engine;
95 
102 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine reportRtcStats:(AgoraChannelStats * _Nonnull)stats;
103 
110 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine lastmileQuality:(AgoraNetworkQuality)quality;
111 
120 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine lastmileProbeTestResult:(AgoraLastmileProbeResult * _Nonnull)result;
121 
129 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didApiCallExecute:(NSInteger)error api:(NSString * _Nonnull)api result:(NSString * _Nonnull)result;
130 
131 
132 #if (!(TARGET_OS_IPHONE) && (TARGET_OS_MAC))
133 
141 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine device:(NSString * _Nonnull) deviceId type:(AgoraMediaDeviceType) deviceType stateChanged:(NSInteger) state;
142 
143 #endif
144 
150 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didOccurEncryptionError:(AgoraEncryptionErrorType)errorType;
157 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine uploadLogResultRequestId:(NSString * _Nonnull)requestId success:(BOOL)success reason:(AgoraUploadErrorReason)reason;
158 
159 #pragma mark Local user common delegates
160 
168 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didClientRoleChanged:(AgoraClientRole)oldRole newRole:(AgoraClientRole)newRole;
169 
177 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didClientRoleChangeFailed:(AgoraClientRoleChangeFailedReason)reason currentRole:(AgoraClientRole)currentRole;
178 
185 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didLeaveChannelWithStats:(AgoraChannelStats * _Nonnull)stats;
186 
187 #pragma mark Local user audio delegates
188 
194 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine firstLocalAudioFramePublished:(NSInteger)elapsed;
195 
203 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine localAudioStats:(AgoraRtcLocalAudioStats * _Nonnull)stats;
204 
211 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didAudioRouteChanged:(AgoraAudioOutputRouting)routing;
212 
218 - (void)rtcEngineLocalAudioMixingDidFinish:(AgoraRtcEngineKit * _Nonnull)engine;
219 
226 - (void)rtcEngine:(AgoraRtcEngineKit *_Nonnull)engine audioMixingStateChanged:(AgoraAudioMixingStateType)state
227  reasonCode:(AgoraAudioMixingReasonCode)reasonCode;
228 
234 - (void)rtcEngineDidAudioEffectFinish:(AgoraRtcEngineKit * _Nonnull)engine soundId:(int)soundId;
235 
236 
237 #pragma mark Local user video delegates
238 
243 - (void)rtcEngineCameraDidReady:(AgoraRtcEngineKit * _Nonnull)engine;
244 
245 #if TARGET_OS_IPHONE
246 
252 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine cameraFocusDidChangedToRect:(CGRect)rect;
253 
259 - (void)rtcEngine:(AgoraRtcEngineKit* _Nonnull)engine cameraExposureDidChangedToRect:(CGRect)rect;
260 
261 #endif
262 
268 - (void)rtcEngineVideoDidStop:(AgoraRtcEngineKit * _Nonnull)engine;
269 
275 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine firstLocalVideoFramePublishedWithElapsed:(NSInteger)elapsed
276  sourceType:(AgoraVideoSourceType)source;
277 
285 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine firstLocalVideoFrameWithSize:(CGSize)size elapsed:(NSInteger)elapsed sourceType:(AgoraVideoSourceType)source;
286 
293 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine localVideoStats:(AgoraRtcLocalVideoStats * _Nonnull)stats
294  sourceType:(AgoraVideoSourceType)source;
295 
296 #pragma mark Remote user audio delegates
297 
305 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine reportAudioVolumeIndicationOfSpeakers:(NSArray<AgoraRtcAudioVolumeInfo *> * _Nonnull)speakers totalVolume:(NSInteger)totalVolume;
306 
312 - (void)rtcEngineRemoteAudioMixingDidStart:(AgoraRtcEngineKit * _Nonnull)engine;
313 
319 - (void)rtcEngineRemoteAudioMixingDidFinish:(AgoraRtcEngineKit * _Nonnull)engine;
320 
327 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine remoteAudioStats:(AgoraRtcRemoteAudioStats * _Nonnull)stats;
328 
329 #pragma mark Remote user video delegates
330 
337 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine remoteVideoStats:(AgoraRtcRemoteVideoStats * _Nonnull)stats;
338 
339 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine rtmpStreamingChangedToState:(NSString * _Nonnull)url
340  state:(AgoraRtmpStreamingState)state
341  errCode:(AgoraRtmpStreamingErrorCode)errCode;
342 
343 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine rtmpStreamingEventWithUrl:(NSString* _Nonnull)url eventCode:(AgoraRtmpStreamingEvent)eventCode;
344 
345 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine streamPublishedWithUrl:(NSString * _Nonnull)url errorCode:(AgoraErrorCode)errorCode;
346 
347 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine streamUnpublishedWithUrl:(NSString * _Nonnull)url;
348 
349 - (void)rtcEngineTranscodingUpdated:(AgoraRtcEngineKit * _Nonnull)engine;
350 
351 #pragma mark Face Detection Delegate Methods
352 
379 - (void)rtcEngine:(AgoraRtcEngineKit* _Nonnull)engine facePositionDidChangeWidth:(int)width previewHeight:(int)height faces:(NSArray<AgoraFacePositionInfo*>* _Nullable)faces NS_SWIFT_NAME(rtcEngine(_:facePositionDidChangeWidth:previewHeight:faces:));
380 
381 @end
382 
383 /*
384 
385 - (int)joinChannelByToken:(NSString * _Nullable)token
386  channelId:(NSString * _Nonnull)channelId
387  info:(NSString * _Nullable)info
388  userId:(NSString * _Nullable)userId;
389 
390 - (int)setRemoteRenderModeWithUid:(NSString * _Nonnull)userId
391  mode:(AgoraVideoRenderMode) mode;
392 
393 - (int)switchView:(NSString * _Nonnull)userId1
394  andAnother:(NSString * _Nonnull)userId2 __deprecated;
395 
396 - (int)muteRemoteAudioStream:(NSString * _Nonnull)userId mute:(BOOL)mute;
397 
398 - (int)setRemoteVideoStream:(NSString * _Nonnull)userId
399  type:(AgoraVideoStreamType)streamType;
400 - (int)muteRemoteVideoStream:(NSString * _Nonnull)userId
401  mute:(BOOL)mute;
402 
403 - (void)setRemoteVideoRenderer:(id<AgoraVideoSinkProtocol> _Nullable)videoRenderer withUserId:(NSString * _Nonnull)userId;
404 
405 - (int)sendPublishingRequestToOwner:(NSString * _Nonnull) userId;
406 - (int)answerPublishingRequestOfUid:(NSString * _Nonnull) userId accepted:(bool)accepted;
407 - (int)sendUnpublishingRequestToUid:(NSString * _Nonnull) userId;
408 
409 - (id<AgoraVideoSinkProtocol> _Nullable)remoteVideoRendererOfUserId:(NSString * _Nonnull)userId;
410 */
AgoraRtcEngineKit
Definition: AgoraRtcEngineKit.h:1725
AgoraFacePositionInfo
Definition: AgoraObjects.h:2708
AgoraRtmpStreamingErrorCode
AgoraRtmpStreamingErrorCode
Definition: AgoraEnumerates.h:2087
AgoraBaseDelegate-p
Definition: AgoraBaseDelegate.h:12
AgoraClientRole
AgoraClientRole
Definition: AgoraEnumerates.h:506
AgoraRtmpStreamingEvent
AgoraRtmpStreamingEvent
Definition: AgoraEnumerates.h:2130
AgoraClientRoleChangeFailedReason
AgoraClientRoleChangeFailedReason
Definition: AgoraEnumerates.h:1918
AgoraRtcRemoteVideoStats
Definition: AgoraObjects.h:631
AgoraVideoSourceType
AgoraVideoSourceType
Definition: AgoraEnumerates.h:2372
AgoraRtcRemoteAudioStats
Definition: AgoraObjects.h:730
AgoraUserInfo
Definition: AgoraObjects.h:1954
AgoraRtcAudioVolumeInfo
Definition: AgoraObjects.h:822
AgoraObjects.h
AgoraRtmpStreamingState
AgoraRtmpStreamingState
Definition: AgoraEnumerates.h:2069
AgoraEncryptionErrorType
AgoraEncryptionErrorType
Definition: AgoraEnumerates.h:2150
AgoraUploadErrorReason
AgoraUploadErrorReason
Definition: AgoraEnumerates.h:785
AgoraNetworkQuality
AgoraNetworkQuality
Definition: AgoraEnumerates.h:713
AgoraRtcLocalAudioStats
Definition: AgoraObjects.h:701
AgoraLastmileProbeResult
Definition: AgoraObjects.h:511
AgoraChannelStats
Definition: AgoraObjects.h:841