Agora RTC Objective-C API Reference  Refactor
AgoraRtcEngineKitEx.h
Go to the documentation of this file.
1 //
2 // AgoraRtcEngineKitEx.h
3 // AgoraRtcEngineKit
4 //
5 // Copyright (c) 2020 Agora. All rights reserved.
6 // Created by LLF on 2020/3/9.
7 //
8 
9 #import "AgoraRtcEngineKit.h"
10 #import "AgoraObjects.h"
11 
12 #if TARGET_OS_IPHONE
13 #import <UIKit/UIKit.h>
14 #elif TARGET_OS_MAC
15 #import <AppKit/AppKit.h>
16 #endif
17 
18 NS_ASSUME_NONNULL_BEGIN
20 
42 - (int)joinChannelExByToken:(NSString* _Nullable)token
43  connection:(AgoraRtcConnection * _Nonnull)connection
44  delegate:(id<AgoraRtcEngineDelegate> _Nullable)delegate
45  mediaOptions:(AgoraRtcChannelMediaOptions* _Nonnull)mediaOptions
46  joinSuccess:(void(^ _Nullable)(NSString* _Nonnull channel, NSUInteger uid, NSInteger elapsed))joinSuccessBlock;
47 
83 - (int)joinChannelExByToken:(NSString* _Nullable)token
84  channelId:(NSString* _Nonnull)channelId
85  userAccount:(NSString* _Nonnull)userAccount
86  delegate:(id<AgoraRtcEngineDelegate> _Nullable)delegate
87  mediaOptions:(AgoraRtcChannelMediaOptions* _Nonnull)mediaOptions
88  joinSuccess:(void(^ _Nullable)(NSString* _Nonnull channel, NSUInteger uid, NSInteger elapsed))joinSuccessBlock;
89 
99 - (int)updateChannelExWithMediaOptions:(AgoraRtcChannelMediaOptions* _Nonnull)mediaOptions
100  connection:(AgoraRtcConnection * _Nonnull)connection;
101 
111 - (int)leaveChannelEx:(AgoraRtcConnection * _Nonnull)connection
112  leaveChannelBlock:(void(^ _Nullable)(AgoraChannelStats* _Nonnull stat))leaveChannelBlock;
113 
126 - (int)muteRemoteAudioStreamEx:(NSUInteger)uid
127  mute:(BOOL)mute
128  connection:(AgoraRtcConnection * _Nonnull)connection;
129 
147 - (int)setVideoEncoderConfigurationEx:(AgoraVideoEncoderConfiguration* _Nonnull)config
148  connection:(AgoraRtcConnection * _Nonnull)connection;
149 
160 - (int)setupRemoteVideoEx:(AgoraRtcVideoCanvas* _Nonnull)remote
161  connection:(AgoraRtcConnection * _Nonnull)connection;
162 
174 - (int)setRemoteRenderModeEx:(NSUInteger)uid
175  mode:(AgoraVideoRenderMode)mode
176  mirror:(AgoraVideoMirrorMode)mirror
177  connection:(AgoraRtcConnection * _Nonnull)connection;
178 
195 - (int)muteRemoteVideoStreamEx:(NSUInteger)uid
196  mute:(BOOL)mute
197  connection:(AgoraRtcConnection * _Nonnull)connection;
198 
213 - (int)enableDualStreamModeEx:(AgoraVideoSourceType)sourceType
214  enabled:(BOOL)enabled
215  streamConfig:(AgoraSimulcastStreamConfig*)streamConfig
216  connection:(AgoraRtcConnection* _Nonnull)connection;
217 
238 - (int)setRemoteVideoStreamEx:(NSUInteger)uid
239  type:(AgoraVideoStreamType)streamType
240  connection:(AgoraRtcConnection * _Nonnull)connection;
241 
260 - (BOOL)pushExternalVideoFrame:(AgoraVideoFrame * _Nonnull)frame connection:(AgoraRtcConnection * _Nonnull)connection;
261 
272 - (AgoraUserInfo* _Nullable)getUserInfoByUserAccountEx:(NSString* _Nonnull)userAccount
273  connection:(AgoraRtcConnection * _Nonnull)connection
274  withError:(AgoraErrorCode* _Nullable)error;
275 
288 - (AgoraUserInfo* _Nullable)getUserInfoByUidEx:(NSUInteger)uid
289  connection:(AgoraRtcConnection * _Nonnull)connection
290  withError:(AgoraErrorCode* _Nullable)error;
291 
299 - (AgoraConnectionState)getConnectionStateEx:(AgoraRtcConnection * _Nonnull)connection;
300 
301 #if (!(TARGET_OS_IPHONE) && (TARGET_OS_MAC))
302 
322 - (int)enableLoopbackRecordingEx:(BOOL)enabled
323  connection:(AgoraRtcConnection * _Nonnull)connection;;
324 #endif
325 
326 - (int)sendCustomReportMessageEx:(NSString * _Nullable)messageId
327  category:(NSString * _Nullable)category
328  event:(NSString * _Nullable)event
329  label:(NSString * _Nullable)label
330  value:(NSInteger)value
331  connection:(AgoraRtcConnection * _Nonnull)connection;
332 
333 - (int)enableAudioVolumeIndicationEx:(NSInteger)interval
334  smooth:(NSInteger)smooth
335  reportVad:(BOOL)reportVad
336  connection:(AgoraRtcConnection* _Nonnull)connection;
337 
362 - (int)setRemoteVoicePositionEx:(NSUInteger)uid
363  pan:(double)pan
364  gain:(double)gain
365  connection:(AgoraRtcConnection * _Nonnull)connection;
366 
383 - (int)setRemoteUserSpatialAudioParamsEx:(NSUInteger)uid
384  params:(AgoraSpatialAudioParams* _Nonnull)params
385  connection:(AgoraRtcConnection* _Nonnull)connection;
386 
413 - (int)addVideoWatermarkEx:(NSURL* _Nonnull)url options:(WatermarkOptions* _Nonnull)options connection:(AgoraRtcConnection * _Nonnull)connection;
414 
421 - (int)clearVideoWatermarkEx:(AgoraRtcConnection * _Nonnull)connection;
422 
447 - (int)createDataStreamEx:(NSInteger * _Nonnull)streamId
448  reliable:(BOOL)reliable
449  ordered:(BOOL)ordered
450  connection:(AgoraRtcConnection * _Nonnull)connection;
461 - (int)createDataStreamEx:(NSInteger * _Nonnull)streamId
462  config:(AgoraDataStreamConfig * _Nonnull)config
463  connection:(AgoraRtcConnection * _Nonnull)connection;
464 
489 - (int)sendStreamMessageEx:(NSInteger)streamId
490  data:(NSData * _Nonnull)data
491  connection:(AgoraRtcConnection * _Nonnull)connection;
492 
511 - (int)addPublishStreamUrlEx:(NSString * _Nonnull)url
512  transcodingEnabled:(BOOL)transcodingEnabled
513  connection:(AgoraRtcConnection * _Nonnull)connection;
514 @end
515 
516 NS_ASSUME_NONNULL_END
AgoraRtcEngineDelegate-p
Definition: AgoraRtcEngineKit.h:566
AgoraRtcChannelMediaOptions
Definition: AgoraObjects.h:124
AgoraVideoFrame
Definition: AgoraObjects.h:1367
AgoraSimulcastStreamConfig
Definition: AgoraObjects.h:1996
WatermarkOptions
Definition: AgoraObjects.h:993
AgoraVideoSourceType
AgoraVideoSourceType
Definition: AgoraEnumerates.h:2183
AgoraRtcEngineKit.h
AgoraDataStreamConfig
Definition: AgoraObjects.h:1743
AgoraUserInfo
Definition: AgoraObjects.h:1707
AgoraVideoRenderMode
AgoraVideoRenderMode
Definition: AgoraEnumerates.h:753
AgoraRtcEngineKit(Ex)
Definition: AgoraRtcEngineKitEx.h:19
AgoraVideoStreamType
AgoraVideoStreamType
Definition: AgoraEnumerates.h:735
AgoraConnectionState
AgoraConnectionState
Definition: AgoraEnumerates.h:1563
AgoraObjects.h
AgoraRtcConnection
Definition: AgoraObjects.h:2080
AgoraRtcVideoCanvas
Definition: AgoraObjects.h:281
AgoraChannelStats
Definition: AgoraObjects.h:686