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 
137 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didRefreshRecordingServiceStatus:(NSInteger)status;
138 
139 #if (!(TARGET_OS_IPHONE) && (TARGET_OS_MAC))
140 
148 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine device:(NSString * _Nonnull) deviceId type:(AgoraMediaDeviceType) deviceType stateChanged:(NSInteger) state;
149 
150 #endif
151 
157 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didOccurEncryptionError:(AgoraEncryptionErrorType)errorType;
164 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine uploadLogResultRequestId:(NSString * _Nonnull)requestId success:(BOOL)success reason:(AgoraUploadErrorReason)reason;
165 
166 #pragma mark Local user common delegates
167 
175 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didClientRoleChanged:(AgoraClientRole)oldRole newRole:(AgoraClientRole)newRole;
176 
184 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didClientRoleChangeFailed:(AgoraClientRoleChangeFailedReason)reason currentRole:(AgoraClientRole)currentRole;
185 
192 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didLeaveChannelWithStats:(AgoraChannelStats * _Nonnull)stats;
193 
194 #pragma mark Local user audio delegates
195 
201 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine firstLocalAudioFramePublished:(NSInteger)elapsed;
202 
210 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine localAudioStats:(AgoraRtcLocalAudioStats * _Nonnull)stats;
211 
218 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didAudioRouteChanged:(AgoraAudioOutputRouting)routing;
219 
225 - (void)rtcEngineLocalAudioMixingDidFinish:(AgoraRtcEngineKit * _Nonnull)engine;
226 
233 - (void)rtcEngine:(AgoraRtcEngineKit *_Nonnull)engine audioMixingStateChanged:(AgoraAudioMixingStateType)state
234  errorCode:(AgoraAudioMixingErrorType)errorCode;
235 
241 - (void)rtcEngineDidAudioEffectFinish:(AgoraRtcEngineKit * _Nonnull)engine soundId:(int)soundId;
242 
243 
244 #pragma mark Local user video delegates
245 
250 - (void)rtcEngineCameraDidReady:(AgoraRtcEngineKit * _Nonnull)engine;
251 
252 #if TARGET_OS_IPHONE
253 
259 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine cameraFocusDidChangedToRect:(CGRect)rect;
260 
266 - (void)rtcEngine:(AgoraRtcEngineKit* _Nonnull)engine cameraExposureDidChangedToRect:(CGRect)rect;
267 
268 #endif
269 
275 - (void)rtcEngineVideoDidStop:(AgoraRtcEngineKit * _Nonnull)engine;
276 
282 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine firstLocalVideoFramePublishedWithElapsed:(NSInteger)elapsed;
283 
291 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine firstLocalVideoFrameWithSize:(CGSize)size elapsed:(NSInteger)elapsed;
292 
299 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine localVideoStats:(AgoraRtcLocalVideoStats * _Nonnull)stats;
300 
301 #pragma mark Remote user audio delegates
302 
310 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine reportAudioVolumeIndicationOfSpeakers:(NSArray<AgoraRtcAudioVolumeInfo *> * _Nonnull)speakers totalVolume:(NSInteger)totalVolume;
311 
317 - (void)rtcEngineRemoteAudioMixingDidStart:(AgoraRtcEngineKit * _Nonnull)engine;
318 
324 - (void)rtcEngineRemoteAudioMixingDidFinish:(AgoraRtcEngineKit * _Nonnull)engine;
325 
332 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine remoteAudioStats:(AgoraRtcRemoteAudioStats * _Nonnull)stats;
333 
334 #pragma mark Remote user video delegates
335 
342 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine remoteVideoStats:(AgoraRtcRemoteVideoStats * _Nonnull)stats;
343 
344 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine rtmpStreamingChangedToState:(NSString * _Nonnull)url
345  state:(AgoraRtmpStreamingState)state
346  errCode:(AgoraRtmpStreamingErrorCode)errCode;
347 
348 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine rtmpStreamingEventWithUrl:(NSString* _Nonnull)url eventCode:(AgoraRtmpStreamingEvent)eventCode;
349 
350 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine streamPublishedWithUrl:(NSString * _Nonnull)url errorCode:(AgoraErrorCode)errorCode;
351 
352 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine streamUnpublishedWithUrl:(NSString * _Nonnull)url;
353 
354 - (void)rtcEngineTranscodingUpdated:(AgoraRtcEngineKit * _Nonnull)engine;
355 
356 #pragma mark Face Detection Delegate Methods
357 
384 - (void)rtcEngine:(AgoraRtcEngineKit* _Nonnull)engine facePositionDidChangeWidth:(int)width previewHeight:(int)height faces:(NSArray<AgoraFacePositionInfo*>* _Nullable)faces NS_SWIFT_NAME(rtcEngine(_:facePositionDidChangeWidth:previewHeight:faces:));
385 
386 @end
387 
388 /*
389 
390 - (int)joinChannelByToken:(NSString * _Nullable)token
391  channelId:(NSString * _Nonnull)channelId
392  info:(NSString * _Nullable)info
393  userId:(NSString * _Nullable)userId;
394 
395 - (int)setRemoteRenderModeWithUid:(NSString * _Nonnull)userId
396  mode:(AgoraVideoRenderMode) mode;
397 
398 - (int)switchView:(NSString * _Nonnull)userId1
399  andAnother:(NSString * _Nonnull)userId2 __deprecated;
400 
401 - (int)muteRemoteAudioStream:(NSString * _Nonnull)userId mute:(BOOL)mute;
402 
403 - (int)setRemoteVideoStream:(NSString * _Nonnull)userId
404  type:(AgoraVideoStreamType)streamType;
405 - (int)muteRemoteVideoStream:(NSString * _Nonnull)userId
406  mute:(BOOL)mute;
407 
408 - (void)setRemoteVideoRenderer:(id<AgoraVideoSinkProtocol> _Nullable)videoRenderer withUserId:(NSString * _Nonnull)userId;
409 
410 - (int)sendPublishingRequestToOwner:(NSString * _Nonnull) userId;
411 - (int)answerPublishingRequestOfUid:(NSString * _Nonnull) userId accepted:(bool)accepted;
412 - (int)sendUnpublishingRequestToUid:(NSString * _Nonnull) userId;
413 
414 - (id<AgoraVideoSinkProtocol> _Nullable)remoteVideoRendererOfUserId:(NSString * _Nonnull)userId;
415 */
AgoraRtcEngineKit
Definition: AgoraRtcEngineKit.h:1642
AgoraFacePositionInfo
Definition: AgoraObjects.h:2193
AgoraRtmpStreamingErrorCode
AgoraRtmpStreamingErrorCode
Definition: AgoraEnumerates.h:1918
AgoraBaseDelegate-p
Definition: AgoraBaseDelegate.h:12
AgoraClientRole
AgoraClientRole
Definition: AgoraEnumerates.h:501
AgoraRtmpStreamingEvent
AgoraRtmpStreamingEvent
Definition: AgoraEnumerates.h:1959
AgoraClientRoleChangeFailedReason
AgoraClientRoleChangeFailedReason
Definition: AgoraEnumerates.h:1751
AgoraRtcRemoteVideoStats
Definition: AgoraObjects.h:484
AgoraRtcRemoteAudioStats
Definition: AgoraObjects.h:579
AgoraUserInfo
Definition: AgoraObjects.h:1707
AgoraRtcAudioVolumeInfo
Definition: AgoraObjects.h:667
AgoraObjects.h
AgoraRtmpStreamingState
AgoraRtmpStreamingState
Definition: AgoraEnumerates.h:1900
AgoraEncryptionErrorType
AgoraEncryptionErrorType
Definition: AgoraEnumerates.h:1979
AgoraUploadErrorReason
AgoraUploadErrorReason
Definition: AgoraEnumerates.h:728
AgoraNetworkQuality
AgoraNetworkQuality
Definition: AgoraEnumerates.h:689
AgoraRtcLocalAudioStats
Definition: AgoraObjects.h:554
AgoraLastmileProbeResult
Definition: AgoraObjects.h:372
AgoraChannelStats
Definition: AgoraObjects.h:686