Agora RTC Objective-C API Reference  Refactor
AgoraRtcEngineDelegate2.h
Go to the documentation of this file.
1 //
2 // AgoraRtcEngineKit2.h
3 // AgoraRtcEngineKit
4 //
5 // Created by Sting Feng on 2015-8-11.
6 // Copyright (c) 2015 Agora. All rights reserved.
7 //
8 
9 #import "AgoraBaseDelegate.h"
10 #import "AgoraEnumerates.h"
11 
12 @class AgoraRtcEngineKit;
13 
15 @optional
16 
17 #pragma mark Local user common delegates
18 
26 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didJoinChannel:(NSString * _Nonnull)channelId withUid:(NSString * _Nonnull)userId elapsed:(NSInteger) elapsed;
27 
36 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didRejoinChannel:(NSString * _Nonnull)channelId withUid:(NSString * _Nonnull)userId elapsed:(NSInteger) elapsed;
37 
46 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine networkQuality:(NSString * _Nonnull)userId txQuality:(AgoraNetworkQuality)txQuality rxQuality:(AgoraNetworkQuality)rxQuality;
47 
48 #pragma mark Remote user common delegates
49 
56 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didJoinedOfUid:(NSString * _Nonnull)userId elapsed:(NSInteger)elapsed;
57 
65 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didOfflineOfUid:(NSString * _Nonnull)userId reason:(AgoraUserOfflineReason)reason;
66 
75 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine receiveStreamMessageFromUid:(NSString * _Nonnull)userId streamId:(NSInteger)streamId data:(NSData * _Nonnull)data;
76 
87 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didOccurStreamMessageErrorFromUid:(NSString * _Nonnull)userId streamId:(NSInteger)streamId error:(NSInteger)error missed:(NSInteger)missed cached:(NSInteger)cached;
88 
89 #pragma mark Local user audio delegates
90 
106 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine localAudioStateChanged:(AgoraAudioLocalState)state error:(AgoraAudioLocalError)error;
107 
108 #pragma mark Remote user audio delegates
109 
116 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine firstRemoteAudioFrameOfUid:(NSString * _Nonnull)userId elapsed:(NSInteger)elapsed;
117 
136 - (void)rtcEngine:(AgoraRtcEngineKit* _Nonnull)engine firstRemoteAudioFrameDecodedOfUid:(NSString * _Nonnull)uid elapsed:(NSInteger)elapsed;
137 
138 
159 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine remoteAudioStateChangedOfUid:(NSString * _Nonnull)userId state:(AgoraAudioRemoteState)state reason:(AgoraAudioRemoteReason)reason elapsed:(NSInteger)elapsed;
160 
167 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine activeSpeaker:(NSString * _Nonnull)speakerUid;
168 
178 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine audioQualityOfUid:(NSString * _Nonnull)userId quality:(AgoraNetworkQuality)quality delay:(NSUInteger)delay lost:(NSUInteger)lost;
179 
189 - (void)rtcEngine:(AgoraRtcEngineKit *_Nonnull)engine didAudioSubscribeStateChange:(NSString * _Nonnull)channelId
190  uid:(unsigned int)uid
191  oldState:(AgoraStreamSubscribeState)oldState
192  newState:(AgoraStreamSubscribeState)newState
193 elapseSinceLastState:(int)elapseSinceLastState;
194 
203 - (void)rtcEngine:(AgoraRtcEngineKit *_Nonnull)engine didAudioPublishStateChange:(NSString * _Nonnull)channelId
204  oldState:(AgoraStreamPublishState)oldState
205  newState:(AgoraStreamPublishState)newState
206 elapseSinceLastState:(int)elapseSinceLastState;
207 
208 #pragma mark Remote user video delegates
209 
217 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine firstRemoteVideoDecodedOfUid:(NSString * _Nonnull)userId size:(CGSize)size elapsed:(NSInteger)elapsed;
218 
227 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine firstRemoteVideoFrameOfUid:(NSString * _Nonnull)userId size:(CGSize)size elapsed:(NSInteger)elapsed;
228 
237 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine videoSizeChangedOfUid:(NSString * _Nonnull)userId size:(CGSize)size rotation:(NSInteger)rotation;
238 - (void)rtcEngine:(AgoraRtcEngineKit* _Nonnull)engine contentInspectResult:(AgoraContentInspectResult)result;
239 - (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;
251 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine localVideoStateChangedOfState:(AgoraVideoLocalState)state
252  error:(AgoraLocalVideoStreamError)error;
253 
274 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine remoteVideoStateChangedOfUid:(NSString * _Nonnull)userId state:(AgoraVideoRemoteState)state reason:(AgoraVideoRemoteReason)reason elapsed:(NSInteger)elapsed;
275 
283 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didAudioMuted:(BOOL)muted byUid:(NSString * _Nonnull)userId;
284 
292 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didVideoMuted:(BOOL)muted byUid:(NSString * _Nonnull)userId;
293 
301 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didVideoEnabled:(BOOL)enabled byUid:(NSString * _Nonnull)userId;
302 
310 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didLocalVideoEnabled:(BOOL)enabled byUid:(NSString * _Nonnull)userId;
311 
319 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine remoteUserStateChangedOfUid:(NSString * _Nonnull)userId state:(NSUInteger)state;
320 
321 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine publishingRequestReceivedFromUid:(NSString * _Nonnull)userId;
322 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine publishingRequestAnsweredByOwner:(NSString * _Nonnull)userId accepted:(BOOL)accepted error:(AgoraErrorCode)error;
323 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine unpublishingRequestReceivedFromOwner:(NSString * _Nonnull)userId;
324 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine streamInjectedStatusOfUrl:(NSString * _Nonnull)url uid:(NSString * _Nonnull)userId status:(AgoraInjectStreamStatus)status;
325 
329 - (void)rtcEngineIntraRequestReceived:(AgoraRtcEngineKit *_Nonnull)engine;
330 
335 - (void)rtcEngine:(AgoraRtcEngineKit *_Nonnull)engine uplinkNetworkInfoUpdate:(AgoraUplinkNetworkInfo *_Nonnull)bweInfo;
336 
341 - (void)rtcEngine:(AgoraRtcEngineKit *_Nonnull)engine downlinkNetworkInfoUpdate:(AgoraDownlinkNetworkInfo *_Nonnull)networkInfo;
342 
343 #pragma mark Connection state delegates
344 
350 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine connectionStateChanged:(AgoraConnectionState)state reason:(AgoraConnectionChangedReason)reason;
351 
358 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine networkTypeChanged:(AgoraNetworkType)type;
359 
366 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine permissionError:(AgoraPermissionType)type;
367 
376 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
377 channelMediaRelayStateDidChange:(AgoraChannelMediaRelayState)state
378  error:(AgoraChannelMediaRelayError)error;
379 
385 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
386 didReceiveChannelMediaRelayEvent:(AgoraChannelMediaRelayEvent)event;
387 
397 - (void)rtcEngine:(AgoraRtcEngineKit *_Nonnull)engine didVideoSubscribeStateChange:(NSString * _Nonnull)channelId
398  uid:(unsigned int)uid
399  oldState:(AgoraStreamSubscribeState)oldState
400  newState:(AgoraStreamSubscribeState)newState
401 elapseSinceLastState:(int)elapseSinceLastState;
402 
412 - (void)rtcEngine:(AgoraRtcEngineKit *_Nonnull)engine didVideoPublishStateChange:(NSString * _Nonnull)channelId
413  oldState:(AgoraStreamPublishState)oldState
414  newState:(AgoraStreamPublishState)newState
415 elapseSinceLastState:(int)elapseSinceLastState;
416 
417 #pragma mark Rhythm Player Delegates Methods
418 
419 - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didRhythmPlayerStateChanged:(AgoraRhythmPlayerState)state
420  errorCode:(AgoraRhythmPlayerError)errorCode;
421 @end
AgoraLocalVideoStreamError
AgoraLocalVideoStreamError
Definition: AgoraEnumerates.h:813
AgoraRtcEngineKit
Definition: AgoraRtcEngineKit.h:1642
AgoraConnectionChangedReason
AgoraConnectionChangedReason
Definition: AgoraEnumerates.h:1662
AgoraBaseDelegate-p
Definition: AgoraBaseDelegate.h:12
AgoraPermissionType
AgoraPermissionType
Definition: AgoraEnumerates.h:2416
AgoraUserOfflineReason
AgoraUserOfflineReason
Definition: AgoraEnumerates.h:566
AgoraAudioRemoteReason
AgoraAudioRemoteReason
Definition: AgoraEnumerates.h:1018
AgoraEnumerates.h
AgoraRhythmPlayerState
AgoraRhythmPlayerState
Definition: AgoraEnumerates.h:2548
AgoraChannelMediaRelayEvent
AgoraChannelMediaRelayEvent
Definition: AgoraEnumerates.h:2018
AgoraVideoRemoteReason
AgoraVideoRemoteReason
Definition: AgoraEnumerates.h:869
AgoraAudioLocalState
AgoraAudioLocalState
Definition: AgoraEnumerates.h:924
AgoraAudioRemoteState
AgoraAudioRemoteState
Definition: AgoraEnumerates.h:986
AgoraChannelMediaRelayState
AgoraChannelMediaRelayState
Definition: AgoraEnumerates.h:2001
AgoraVideoLocalState
AgoraVideoLocalState
Definition: AgoraEnumerates.h:793
AgoraChannelMediaRelayError
AgoraChannelMediaRelayError
Definition: AgoraEnumerates.h:2059
AgoraRhythmPlayerError
AgoraRhythmPlayerError
Definition: AgoraEnumerates.h:2564
AgoraRtcEngineDelegate2-p
Definition: AgoraRtcEngineDelegate2.h:14
AgoraConnectionState
AgoraConnectionState
Definition: AgoraEnumerates.h:1563
AgoraContentInspectResult
AgoraContentInspectResult
Definition: AgoraEnumerates.h:2495
AgoraBaseDelegate.h
AgoraStreamPublishState
AgoraStreamPublishState
Definition: AgoraEnumerates.h:2111
AgoraNetworkType
AgoraNetworkType
Definition: AgoraEnumerates.h:1587
AgoraAudioLocalError
AgoraAudioLocalError
Definition: AgoraEnumerates.h:946
AgoraNetworkQuality
AgoraNetworkQuality
Definition: AgoraEnumerates.h:689
AgoraStreamSubscribeState
AgoraStreamSubscribeState
Definition: AgoraEnumerates.h:2101