Agora RTC Objective-C API Reference Refactor

AgoraObjects.h
Go to the documentation of this file.
1 //
2 // AgoraObjects.h
3 // AgoraRtcEngineKit
4 //
5 // Copyright (c) 2018 Agora. All rights reserved.
6 //
7
8 #import <CoreMedia/CoreMedia.h>
9 #import <Foundation/Foundation.h>
10 #import "AgoraEnumerates.h"
11
12 #if TARGET_OS_IPHONE
13 #import <UIKit/UIKit.h>
14 typedef UIView VIEW_CLASS;
15 typedef UIColor COLOR_CLASS;
16 typedef UIImage IMAGE_CLASS;
17 #elif TARGET_OS_MAC
18 #import <AppKit/AppKit.h>
19 typedef NSView VIEW_CLASS;
20 typedef NSColor COLOR_CLASS;
21 typedef NSImage IMAGE_CLASS;
22 #endif
23
24 @protocol AgoraRtcMediaPlayerProtocol;
25 @protocol AgoraMediaFilterEventDelegate;
26
34 typedef int(^AgoraRtcMediaPlayerCustomSourceOnReadCallback)(id<AgoraRtcMediaPlayerProtocol> _Nonnull playerKit, unsigned char * _Nullable buffer, int bufferSize);
35
49 typedef long long(^AgoraRtcMediaPlayerCustomSourceOnSeekCallback)(id<AgoraRtcMediaPlayerProtocol> _Nonnull playerKit, long long offset, int whence);
50
51 __attribute__((visibility("default"))) @interface AgoraMediaSource : NSObject
55 @property(copy, nonatomic) NSString *_Nullable url;
59 @property(copy, nonatomic) NSString *_Nullable uri;
63 @property(assign, nonatomic) NSUInteger startPos;
69 @property(assign, nonatomic) BOOL autoPlay;
81 @property(assign, nonatomic) BOOL enableCache;
92 @property(assign, nonatomic) BOOL enableMultiAudioTrack;
98 @property(assign, nonatomic) BOOL isAgoraSource;
104 @property(assign, nonatomic) BOOL isLiveSource;
108 @property(copy, nonatomic) AgoraRtcMediaPlayerCustomSourceOnReadCallback _Nonnull playerOnReadCallback;
109 @property(copy, nonatomic) AgoraRtcMediaPlayerCustomSourceOnSeekCallback _Nonnull playerOnSeekCallback;
110
111 @end
112
113 __attribute__((visibility("default"))) @interface AgoraMediaPlayerCacheStatistics : NSObject
114
115 @property(assign, nonatomic) NSInteger fileSize;
116 @property(assign, nonatomic) NSInteger cacheSize;
117 @property(assign, nonatomic) NSInteger downloadSize;
118
119 @end
120
125 __attribute__((visibility("default"))) @interface AgoraMediaPlayerPlaybackStats : NSObject
129 @property(assign, nonatomic) NSInteger videoFps;
133 @property(assign, nonatomic) NSInteger videoBitrateInKbps;
137 @property(assign, nonatomic) NSInteger audioBitrateInKbps;
141 @property(assign, nonatomic) NSInteger totalBitrateInKbps;
142 @end
143
148 __attribute__((visibility("default"))) @interface AgoraMediaPlayerUpdatedInfo : NSObject
152 @property(copy, nonatomic) NSString *_Nullable internalPlayerUuid;
156 @property(copy, nonatomic) NSString *_Nullable deviceId;
160 @property(assign, nonatomic) NSInteger videoHeight;
164 @property(assign, nonatomic) NSInteger videoWidth;
168 @property(assign, nonatomic) NSInteger audioSampleRate;
172 @property(assign, nonatomic) NSInteger audioChannels;
176 @property(assign, nonatomic) NSInteger audioBitsPerSample;
177 @end
178
183 __attribute__((visibility("default"))) @interface AgoraMediaPlayerSrcInfo : NSObject
187 @property(assign, nonatomic) int bitrateInKbps;
191 @property(copy, nonatomic) NSString *_Nullable name;
192
193 @end
194
195
199 __attribute__((visibility("default"))) @interface AgoraDirectCdnStreamingStats : NSObject
203 @property(assign, nonatomic) NSUInteger videoWidth;
207 @property(assign, nonatomic) NSUInteger videoHeight;
211 @property(assign, nonatomic) NSUInteger fps;
215 @property(assign, nonatomic) NSUInteger videoBitrate;
219 @property(assign, nonatomic) NSUInteger audioBitrate;
220
221 @end
222
226 __attribute__((visibility("default"))) @interface AgoraDirectCdnStreamingMediaOptions : NSObject
232 @property(assign, nonatomic) BOOL publishCameraTrack;
238 @property(assign, nonatomic) BOOL publishMicrophoneTrack;
244 @property(assign, nonatomic) BOOL publishCustomAudioTrack;
250 @property(assign, nonatomic) BOOL publishCustomVideoTrack;
256 @property(assign, nonatomic) BOOL publishMediaPlayerAudioTrack;
261 @property(assign, nonatomic) NSInteger publishMediaPlayerId;
262
266 @property(assign, nonatomic) NSInteger customVideoTrackId;
267
268 @end
269
273 __attribute__((visibility("default"))) @interface AgoraEncodedVideoTrackOptions : NSObject
279 @property(assign, nonatomic) int ccMode;
289 @property(assign, nonatomic) int codecType;
293 @property(assign, nonatomic) int targetBitrate;
294 @end
295
299 __attribute__((visibility("default"))) @interface AgoraRtcChannelMediaOptions : NSObject
305 @property(assign, nonatomic) BOOL publishCameraTrack;
311 @property(assign, nonatomic) BOOL publishSecondaryCameraTrack;
317 @property(assign, nonatomic) BOOL publishMicrophoneTrack;
318
324 @property(assign, nonatomic) BOOL publishScreenCaptureAudio;
325 #if TARGET_OS_IPHONE
326
331 @property(assign, nonatomic) BOOL publishScreenCaptureVideo;
332 #elif TARGET_OS_MAC
333
338 @property(assign, nonatomic) BOOL publishThirdCameraTrack;
344 @property(assign, nonatomic) BOOL publishFourthCameraTrack;
350 @property(assign, nonatomic) BOOL publishScreenTrack;
356 @property(assign, nonatomic) BOOL publishSecondaryScreenTrack;
362 @property(assign, nonatomic) BOOL publishThirdScreenTrack;
368 @property(assign, nonatomic) BOOL publishFourthScreenTrack;
369 #endif
370
375 @property(assign, nonatomic) BOOL publishCustomAudioTrack;
379 @property(assign, nonatomic) NSInteger publishCustomAudioTrackId;
385 @property(assign, nonatomic) BOOL publishCustomVideoTrack;
391 @property(assign, nonatomic) BOOL publishEncodedVideoTrack;
397 @property(assign, nonatomic) BOOL publishMediaPlayerAudioTrack;
403 @property(assign, nonatomic) BOOL publishMediaPlayerVideoTrack;
409 @property(assign, nonatomic) BOOL publishTranscodedVideoTrack;
415 @property(assign, nonatomic) BOOL publishMixedAudioTrack;
421 @property(assign, nonatomic) BOOL publishLipSyncTrack;
427 @property(assign, nonatomic) BOOL autoSubscribeAudio;
433 @property(assign, nonatomic) BOOL autoSubscribeVideo;
439 @property(assign, nonatomic) BOOL enableAudioRecordingOrPlayout;
444 @property(assign, nonatomic) NSInteger publishMediaPlayerId;
449 @property(assign, nonatomic) AgoraClientRole clientRoleType;
454 @property(assign, nonatomic) AgoraAudienceLatencyLevelType audienceLatencyLevel;
459 @property(assign, nonatomic) AgoraVideoStreamType defaultVideoStreamType;
464 @property(assign, nonatomic) AgoraChannelProfile channelProfile;
469 @property(assign, nonatomic) NSInteger audioDelayMs;
474 @property(assign, nonatomic) NSInteger mediaPlayerAudioDelayMs;
478 @property(copy, nonatomic) NSString * _Nullable token;
485 @property(assign, nonatomic) BOOL enableBuiltInMediaEncryption;
486
492 @property(assign, nonatomic) BOOL publishRhythmPlayerTrack;
500 @property(assign, nonatomic) BOOL isInteractiveAudience;
501
505 @property(assign, nonatomic) NSInteger customVideoTrackId;
506
512 @property(assign, nonatomic) BOOL isAudioFilterable;
513
517 @property(copy, nonatomic) NSString * _Nullable parameters;
518
524 @property(assign, nonatomic) BOOL enableMultipath;
525
532 @property(assign, nonatomic) AgoraMultipathMode uplinkMultipathMode;
533
539 @property(assign, nonatomic) AgoraMultipathMode downlinkMultipathMode;
540
548 @property(assign, nonatomic) AgoraMultipathType preferMultipathType;
549
550 @end
551
554 __attribute__((visibility("default"))) @interface AgoraRtcVideoCanvas : NSObject
558 @property(assign, nonatomic) NSUInteger uid;
559
563 @property(assign, nonatomic) NSUInteger subviewUid;
564
573 @property(strong, nonatomic) VIEW_CLASS *_Nullable view;
578 @property(assign, nonatomic) AgoraVideoRenderMode renderMode;
588 @property(assign, nonatomic) AgoraVideoMirrorMode mirrorMode;
593 @property(assign, nonatomic) AgoraVideoViewSetupMode setupMode;
598 @property(nonatomic, assign) AgoraVideoSourceType sourceType;
604 @property(nonatomic, assign) int mediaPlayerId;
610 @property(assign, nonatomic) CGRect cropArea;
611
615 @property(assign, nonatomic) UInt32 backgroundColor;
616
622 @property(assign, nonatomic) BOOL enableAlphaMask;
623
628 @property(assign, nonatomic) AgoraVideoModulePosition position;
629 @end
630
634 __attribute__((visibility("default"))) @interface AgoraLastmileProbeConfig : NSObject
642 @property (assign, nonatomic) BOOL probeUplink;
648 @property (assign, nonatomic) BOOL probeDownlink;
655 @property (assign, nonatomic) NSUInteger expectedUplinkBitrate;
660 @property (assign, nonatomic) NSUInteger expectedDownlinkBitrate;
661 @end
662
666 __attribute__((visibility("default"))) @interface AgoraLastmileProbeOneWayResult : NSObject
670 @property (assign, nonatomic) NSUInteger packetLossRate;
674 @property (assign, nonatomic) NSUInteger jitter;
678 @property (assign, nonatomic) NSUInteger availableBandwidth;
679 @end
680
684 __attribute__((visibility("default"))) @interface AgoraLastmileProbeResult : NSObject
689 @property (assign, nonatomic) AgoraLastmileProbeResultState state;
693 @property (assign, nonatomic) NSUInteger rtt;
699 @property (strong, nonatomic) AgoraLastmileProbeOneWayResult *_Nonnull uplinkReport;
705 @property (strong, nonatomic) AgoraLastmileProbeOneWayResult *_Nonnull downlinkReport;
706 @end
710 __attribute__((visibility("default"))) @interface AgoraRtcLocalVideoStats : NSObject
714 @property(assign, nonatomic) NSUInteger uid;
715
720 @property(assign, nonatomic) NSUInteger sentBitrate;
725 @property(assign, nonatomic) NSUInteger sentFrameRate;
728 @property(assign, nonatomic) NSInteger captureFrameRate;
731 @property(assign, nonatomic) NSInteger captureFrameWidth;
734 @property(assign, nonatomic) NSInteger captureFrameHeight;
738 @property(assign, nonatomic) NSInteger regulatedCaptureFrameRate;
742 @property(assign, nonatomic) NSInteger regulatedCaptureFrameWidth;
746 @property(assign, nonatomic) NSInteger regulatedCaptureFrameHeight;
747
750 @property(assign, nonatomic) NSInteger encoderOutputFrameRate;
753 @property(assign, nonatomic) NSInteger rendererOutputFrameRate;
756 @property(assign, nonatomic) NSInteger targetFrameRate;
758 @property(assign, nonatomic) AgoraVideoQualityAdaptIndication qualityAdaptIndication;
763 @property(assign, nonatomic) NSInteger targetBitrate;
768 @property(assign, nonatomic) NSInteger encodedBitrate;
772 @property(assign, nonatomic) NSInteger encodedFrameWidth;
776 @property(assign, nonatomic) NSInteger encodedFrameHeight;
780 @property(assign, nonatomic) NSInteger encodedFrameCount;
787 @property(assign, nonatomic) AgoraVideoCodecType codecType;
793 @property(assign, nonatomic) AgoraVideoHwEncoderAccelerating hwEncoderAccelerating;
797 @property(assign, nonatomic) NSInteger txPacketLossRate;
801 @property(assign, nonatomic) AgoraCaptureBrightnessLevelType captureBrightnessLevel NS_SWIFT_NAME(captureBrightnessLevel);
805 @property(assign, nonatomic) BOOL dualStreamEnabled;
806 @end
807
809 __attribute__((visibility("default"))) @interface AgoraRtcRemoteVideoStats : NSObject
813 @property(assign, nonatomic) NSUInteger uid;
814
817 @property(assign, nonatomic) NSUInteger delay __deprecated;
820 @property(assign, nonatomic) NSUInteger e2eDelay;
823 @property(assign, nonatomic) NSUInteger width;
826 @property(assign, nonatomic) NSUInteger height;
829 @property(assign, nonatomic) NSUInteger receivedBitrate;
832 @property(assign, nonatomic) AgoraVideoStreamType rxStreamType;
833
836 @property(assign, nonatomic) NSInteger decoderOutputFrameRate;
839 @property(assign, nonatomic) NSInteger rendererOutputFrameRate;
842 @property(assign, nonatomic) NSInteger frameLossRate;
845 @property(assign, nonatomic) NSInteger packetLossRate;
851 @property(assign, nonatomic) NSInteger totalFrozenTime;
856 @property(assign, nonatomic) NSUInteger totalActiveTime;
860 @property(assign, nonatomic) NSInteger publishDuration;
864 @property(assign, nonatomic) NSInteger frozenRate;
869 @property(assign, nonatomic) NSInteger avSyncTimeMs;
877 @property(assign, nonatomic) NSInteger mosValue;
881 @property(assign, nonatomic) NSUInteger rxVideoBytes;
882
883 @end
884
888 __attribute__((visibility("default"))) @interface AgoraRtcLocalAudioStats : NSObject
892 @property(assign, nonatomic) NSUInteger numChannels;
896 @property(assign, nonatomic) NSUInteger sentSampleRate;
900 @property(assign, nonatomic) NSUInteger sentBitrate;
903 @property(assign, nonatomic) NSUInteger internalCodec;
906 @property(assign, nonatomic) NSUInteger txPacketLossRate;
910 @property(assign, nonatomic) NSUInteger audioDeviceDelay;
914 @property(assign, nonatomic) NSUInteger audioPlayoutDelay;
918 @property(assign, nonatomic) NSUInteger earMonitorDelay;
922 @property(assign, nonatomic) NSUInteger aecEstimatedDelay;
923
924 @end
925
929 __attribute__((visibility("default"))) @interface AgoraRtcRemoteAudioStats : NSObject
933 @property(assign, nonatomic) NSUInteger uid;
934
947 @property(assign, nonatomic) NSUInteger quality;
951 @property(assign, nonatomic) NSUInteger networkTransportDelay;
955 @property(assign, nonatomic) NSUInteger jitterBufferDelay;
959 @property(assign, nonatomic) NSUInteger audioLossRate;
963 @property(assign, nonatomic) NSUInteger numChannels;
967 @property(assign, nonatomic) NSUInteger receivedSampleRate;
971 @property(assign, nonatomic) NSUInteger receivedBitrate;
978 @property(assign, nonatomic) NSUInteger totalFrozenTime;
983 @property(assign, nonatomic) NSUInteger totalActiveTime;
987 @property(assign, nonatomic) NSInteger publishDuration;
991 @property(assign, nonatomic) NSUInteger frozenRate;
1009 @property(assign, nonatomic) NSUInteger mosValue;
1014 @property (assign, nonatomic) NSUInteger frozenRateByCustomPlcCount;
1018 @property (assign, nonatomic) NSUInteger plcCount;
1019
1023 @property(assign, nonatomic) AgoraExperienceQuality qoeQuality;
1027 @property(assign, nonatomic) AgoraExperiencePoorReason qualityChangedReason;
1032 @property(assign, nonatomic) NSUInteger rxAudioBytes;
1036 @property(assign, nonatomic) NSInteger e2eDelay;
1037 @end
1038
1041 __attribute__((visibility("default"))) @interface AgoraRtcAudioVolumeInfo : NSObject
1044 @property(assign, nonatomic) NSUInteger uid;
1045
1048 @property(assign, nonatomic) NSUInteger volume;
1049
1050 @property(assign, nonatomic) NSUInteger vad;
1051
1054 @property (assign, nonatomic) double voicePitch;
1055
1056 @end
1057
1061 __attribute__((visibility("default"))) @interface AgoraChannelStats : NSObject
1065 @property(assign, nonatomic) NSUInteger duration;
1069 @property(assign, nonatomic) NSUInteger txBytes;
1073 @property(assign, nonatomic) NSUInteger rxBytes;
1077 @property(assign, nonatomic) NSUInteger txAudioKBitrate;
1081 @property(assign, nonatomic) NSUInteger rxAudioKBitrate;
1085 @property(assign, nonatomic) NSUInteger txVideoKBitrate;
1089 @property(assign, nonatomic) NSUInteger rxVideoKBitrate;
1093 @property(assign, nonatomic) NSUInteger txAudioBytes;
1097 @property(assign, nonatomic) NSUInteger txVideoBytes;
1102 @property(assign, nonatomic) NSUInteger rxAudioBytes;
1106 @property(assign, nonatomic) NSUInteger rxVideoBytes;
1110 @property(assign, nonatomic) NSUInteger lastmileDelay;
1114 @property(assign, nonatomic) NSUInteger userCount;
1117 @property(assign, nonatomic) double cpuAppUsage;
1120 @property(assign, nonatomic) double cpuTotalUsage;
1123 @property(assign, nonatomic) NSInteger gatewayRtt;
1127 @property(assign, nonatomic) double memoryAppUsageRatio;
1131 @property(assign, nonatomic) double memoryTotalUsageRatio;
1135 @property(assign, nonatomic) NSInteger memoryAppUsageInKbytes;
1139 @property(assign, nonatomic) NSInteger connectTimeMs;
1140
1144 @property(assign, nonatomic) NSUInteger txKBitrate;
1148 @property(assign, nonatomic) NSUInteger rxKBitrate;
1149
1152 @property(assign, nonatomic) NSInteger firstAudioPacketDuration;
1155 @property(assign, nonatomic) NSInteger firstVideoPacketDuration;
1158 @property(assign, nonatomic) NSInteger firstVideoKeyFramePacketDuration;
1161 @property(assign, nonatomic) NSInteger packetsBeforeFirstKeyFramePacket;
1165 @property(assign, nonatomic) NSInteger txPacketLossRate;
1169 @property(assign, nonatomic) NSInteger rxPacketLossRate;
1170
1171 @end
1174 __attribute__((visibility("default"))) @interface AgoraAdvancedVideoOptions : NSObject
1178 @property(assign, nonatomic) AgoraEncodingPreference encodingPreference;
1179
1181 @property(assign, nonatomic) AgoraCompressionPreference compressionPreference;
1182
1187 @property(assign, nonatomic) BOOL encodeAlpha;
1188
1189 @end
1190
1191 __attribute__((visibility("default"))) @interface AgoraVideoCodecCapLevels : NSObject
1192
1193 @property(assign, nonatomic) AgoraVideoCodecCapabilityLevel hwDecodingLevel;
1194 @property(assign, nonatomic) AgoraVideoCodecCapabilityLevel swDecodingLevel;
1195
1196 @end
1197
1201 __attribute__((visibility("default"))) @interface AgoraFocalLengthInfo : NSObject
1202
1203 @property(assign, nonatomic) int cameraDirection;
1204
1205 @property(assign, nonatomic) AgoraFocalLength focalLengthType;
1206
1207 @end
1208
1212 __attribute__((visibility("default"))) @interface AgoraVideoCodecCapInfo : NSObject
1213
1215 @property(assign, nonatomic) AgoraVideoCodecType codecType;
1218 @property(assign, nonatomic) NSUInteger codecCapMask;
1219
1221 @property(strong, nonatomic) AgoraVideoCodecCapLevels *_Nonnull codecCapLevels;
1222
1223 @end
1226 __attribute__((visibility("default"))) @interface AgoraVideoEncoderConfiguration : NSObject
1255 @property(assign, nonatomic) CGSize dimensions;
1256
1259 @property(assign, nonatomic) AgoraVideoCodecType codecType;
1260
1263 @property(assign, nonatomic) NSInteger frameRate;
1264
1285 @property(assign, nonatomic) NSInteger bitrate;
1286
1287 @property(assign, nonatomic) NSInteger minBitrate;
1288
1291 @property(assign, nonatomic) AgoraVideoOutputOrientationMode orientationMode;
1292
1295 @property(assign, nonatomic) AgoraVideoMirrorMode mirrorMode;
1296
1304 @property (assign, nonatomic) AgoraDegradationPreference degradationPreference;
1305
1307 @property (strong, nonatomic) AgoraAdvancedVideoOptions *_Nullable advancedVideoOptions;
1308
1319 - (instancetype _Nonnull)initWithSize:(CGSize)size
1320 frameRate:(NSInteger)frameRate
1321 bitrate:(NSInteger)bitrate
1322 orientationMode:(AgoraVideoOutputOrientationMode)orientationMode
1323 mirrorMode:(AgoraVideoMirrorMode)mirrorMode NS_SWIFT_NAME(init(size:frameRate:bitrate:orientationMode:mirrorMode:));
1324
1336 - (instancetype _Nonnull)initWithWidth:(NSInteger)width
1337 height:(NSInteger)height
1338 frameRate:(NSInteger)frameRate
1339 bitrate:(NSInteger)bitrate
1340 orientationMode:(AgoraVideoOutputOrientationMode)orientationMode
1341 mirrorMode:(AgoraVideoMirrorMode)mirrorMode NS_SWIFT_NAME(init(width:height:frameRate:bitrate:orientationMode:mirrorMode:));
1342 @end
1343
1346 __attribute__((visibility("default"))) @interface AgoraLiveTranscodingUser : NSObject
1349 @property(assign, nonatomic) NSUInteger uid;
1352 @property(assign, nonatomic) CGRect rect;
1358 @property(assign, nonatomic) NSInteger zOrder;
1364 @property(assign, nonatomic) double alpha;
1379 @property(assign, nonatomic) NSInteger audioChannel;
1380 @end
1381
1384 __attribute__((visibility("default"))) @interface AgoraLiveStreamAdvancedFeature : NSObject
1385
1391 @property(copy, nonatomic) NSString* _Nullable featureName;
1392
1398 @property(assign, nonatomic) BOOL opened;
1399 @end
1400
1403 __attribute__((visibility("default"))) @interface AgoraImage : NSObject
1406 @property(strong, nonatomic) NSURL *_Nonnull url;
1409 @property(assign, nonatomic) CGRect rect;
1413 @property (assign, nonatomic) NSInteger zOrder;
1421 @property(assign, nonatomic) double alpha;
1422 @end
1423
1426 __attribute__((visibility("default"))) @interface WatermarkOptions : NSObject
1432 @property(assign, nonatomic) BOOL visibleInPreview;
1440 @property(assign, nonatomic) CGRect positionInLandscapeMode;
1448 @property(assign, nonatomic) CGRect positionInPortraitMode;
1449 @end
1450
1453 __attribute__((visibility("default"))) @interface AgoraLiveTranscoding : NSObject
1456 @property(copy, nonatomic) NSArray<AgoraLiveTranscodingUser*>* _Nullable transcodingUsers;
1457
1471 @property(assign, nonatomic) CGSize size;
1478 @property(assign, nonatomic) NSInteger videoBitrate;
1485 @property(assign, nonatomic) NSInteger videoFramerate;
1491 @property(assign, nonatomic) BOOL lowLatency;
1493 @property(assign, nonatomic) NSInteger videoGop;
1500 @property(assign, nonatomic) AgoraVideoCodecProfileType videoCodecProfile;
1501
1506 @property(assign, nonatomic) AgoraVideoCodecTypeForStream videoCodecType;
1507
1510 @property(copy, nonatomic) NSString* _Nullable transcodingExtraInfo;
1511
1515 @property(copy, nonatomic) NSArray<AgoraImage*>* _Nullable watermarkArray;
1516
1520 @property(copy, nonatomic) NSArray<AgoraImage*>* _Nullable backgroundImageArray;
1521
1531 @property(strong, nonatomic) COLOR_CLASS* _Nullable backgroundColor;
1532
1535 @property(assign, nonatomic) AgoraAudioSampleRateType audioSampleRate;
1538 @property(assign, nonatomic) NSInteger audioBitrate;
1549 @property(assign, nonatomic) NSInteger audioChannels;
1555 @property(assign, nonatomic) AgoraAudioCodecProfileType audioCodecProfile;
1556
1561 + (AgoraLiveTranscoding* _Nonnull)defaultTranscoding NS_SWIFT_NAME(default());
1562
1570 - (int)addUser:(AgoraLiveTranscodingUser* _Nonnull)user NS_SWIFT_NAME(add(_:));
1571
1579 - (int)removeUser:(NSUInteger)uid NS_SWIFT_NAME(removeUser(_:));
1580
1590 - (void)setAdvancedFeatures:(NSString* _Nonnull)featureName opened:(BOOL)opened NS_SWIFT_NAME(setAdvancedFeatures(_:opened:));
1591
1595 - (NSArray<AgoraLiveStreamAdvancedFeature*>* _Nullable)getAdvancedFeatures NS_SWIFT_NAME(getAdvancedFeatures());
1596
1597 @end
1598
1601 __attribute__((visibility("default"))) @interface AgoraLiveInjectStreamConfig : NSObject
1605 @property(assign, nonatomic) CGSize size;
1608 @property(assign, nonatomic) NSInteger videoGop;
1611 @property(assign, nonatomic) NSInteger videoFramerate;
1614 @property(assign, nonatomic) NSInteger videoBitrate;
1615
1618 @property(assign, nonatomic) AgoraAudioSampleRateType audioSampleRate;
1621 @property(assign, nonatomic) NSInteger audioBitrate;
1624 @property(assign, nonatomic) NSInteger audioChannels;
1625
1630 + (AgoraLiveInjectStreamConfig *_Nonnull)defaultConfig NS_SWIFT_NAME(defaultConfig());
1631 @end
1632
1633 __deprecated
1634
1637 __attribute__((visibility("default"))) @interface AgoraRtcVideoCompositingRegion
1638 : NSObject
1641 @property(assign, nonatomic) NSUInteger uid;
1644 @property(assign, nonatomic) CGFloat x;
1647 @property(assign, nonatomic) CGFloat y;
1650 @property(assign, nonatomic) CGFloat width;
1653 @property(assign, nonatomic) CGFloat height;
1656 @property(assign, nonatomic) NSInteger zOrder;
1659 @property(assign, nonatomic) CGFloat alpha;
1662 @property(assign, nonatomic) AgoraVideoRenderMode renderMode;
1663 @end
1664
1665 __deprecated
1668 __attribute__((visibility("default"))) @interface AgoraRtcVideoCompositingLayout
1669 : NSObject
1672 @property(assign, nonatomic) NSInteger canvasWidth;
1675 @property(assign, nonatomic) NSInteger canvasHeight;
1678 @property(copy, nonatomic) NSString *_Nullable backgroundColor;
1681 @property(copy, nonatomic) NSArray<AgoraRtcVideoCompositingRegion *> *_Nullable regions;
1684 @property(copy, nonatomic) NSString *_Nullable appData;
1685 @end
1686
1692 __deprecated __attribute__((visibility("default"))) @interface AgoraPublisherConfiguration
1693 : NSObject
1699 @property(assign, nonatomic) BOOL owner;
1700
1703 @property(assign, nonatomic) NSInteger width;
1706 @property(assign, nonatomic) NSInteger height;
1709 @property(assign, nonatomic) NSInteger framerate;
1712 @property(assign, nonatomic) NSInteger bitrate;
1715 @property(assign, nonatomic) NSInteger audiosamplerate;
1718 @property(assign, nonatomic) NSInteger audiobitrate;
1721 @property(assign, nonatomic) NSInteger audiochannels;
1722
1729 @property(assign, nonatomic) NSInteger defaultLayout;
1732 @property(assign, nonatomic) AgoraRtmpStreamLifeCycle lifeCycle;
1733
1736 @property(assign, nonatomic) NSInteger injectStreamWidth;
1737
1740 @property(assign, nonatomic) NSInteger injectStreamHeight;
1741
1744 @property(copy, nonatomic) NSString *_Nullable injectStreamUrl;
1745
1748 @property(copy, nonatomic) NSString *_Nullable publishUrl;
1749
1753 @property(copy, nonatomic) NSString *_Nullable rawStreamUrl;
1754
1757 @property(copy, nonatomic) NSString *_Nullable extraInfo;
1758
1761 - (BOOL)validate NS_SWIFT_NAME(validate());
1762
1763 - (NSString * _Nullable)toJsonString NS_SWIFT_NAME(toJsonString());
1764 @end
1765
1766 #if (!(TARGET_OS_IPHONE) && (TARGET_OS_MAC))
1767
1770 __attribute__((visibility("default"))) @interface AgoraRtcDeviceInfo : NSObject
1771 @property (assign, nonatomic) int __deprecated index;
1772
1775 @property(assign, nonatomic) AgoraMediaDeviceType type;
1776
1779 @property(copy, nonatomic) NSString *_Nullable deviceId;
1780
1783 @property(copy, nonatomic) NSString *_Nullable deviceName;
1784
1787 @property(copy, nonatomic) NSString *_Nullable deviceTypeName;
1788 @end
1789 #endif
1790
1794 __attribute__((visibility("default"))) @interface AgoraColorSpace : NSObject
1797 @property(assign, nonatomic) AgoraColorPrimaryID primaryID;
1800 @property(assign, nonatomic) AgoraColorTransferID transferID;
1803 @property(assign, nonatomic) AgoraColorMatrixID matrixID;
1806 @property(assign, nonatomic) AgoraColorRangeID rangeID;
1807 @end
1808
1811 __attribute__((visibility("default"))) @interface AgoraVideoFrame : NSObject
1824 @property(assign, nonatomic) NSInteger format;
1825
1829 @property(assign, nonatomic) CMTime time; // Time for this frame.
1830
1834 @property(assign, nonatomic) int stride DEPRECATED_MSG_ATTRIBUTE("use strideInPixels instead");
1835
1839 @property(assign, nonatomic) int strideInPixels; // Number of pixels between two consecutive rows.
1840 // Note: in pixel, not byte. Not used for iOS
1841 // textures.
1842
1845 @property(assign, nonatomic) int height; // Number of rows of pixels. Not used for iOS textures.
1846
1849 @property(assign, nonatomic) CVPixelBufferRef _Nullable textureBuf;
1850
1853 @property(strong, nonatomic) IMAGE_CLASS * _Nullable image;
1854
1857 @property(strong, nonatomic) NSData *_Nullable dataBuf; // Raw data buffer. Not used for iOS textures.
1858
1864 @property(strong, nonatomic) NSData *_Nullable alphaBuf;
1874 @property(assign, nonatomic) AgoraAlphaStitchMode alphaStitchMode;
1875
1878 @property(assign, nonatomic) int cropLeft; // Number of pixels to crop on the left boundary.
1881 @property(assign, nonatomic) int cropTop; // Number of pixels to crop on the top boundary.
1884 @property(assign, nonatomic) int cropRight; // Number of pixels to crop on the right boundary.
1887 @property(assign, nonatomic) int cropBottom; // Number of pixels to crop on the bottom boundary.
1891 @property(assign, nonatomic) int rotation; // 0, 90, 180, 270. See document for rotation calculation.
1892
1895 @property(strong, nonatomic) AgoraColorSpace *_Nullable colorSpace;
1896 /* Note
1897 * 1. strideInPixels
1898 * Stride is in pixels, not bytes
1899 * 2. About the frame width and height
1900 * No field is defined for the width. However, it can be deduced by:
1901 * croppedWidth = (strideInPixels - cropLeft - cropRight)
1902 * And
1903 * croppedHeight = (height - cropTop - cropBottom)
1904 * 3. About crop
1905 * _________________________________________________________________.....
1906 * | ^ | ^
1907 * | | | |
1908 * | cropTop | |
1909 * | | | |
1910 * | v | |
1911 * | ________________________________ | |
1912 * | | | | |
1913 * | | | | |
1914 * |<-- cropLeft -->| valid region |<- cropRight ->|
1915 * | | | | height
1916 * | | | |
1917 * | |_____________________________ | | |
1918 * | ^ | |
1919 * | | | |
1920 * | cropBottom | |
1921 * | | | |
1922 * | v | v
1923 * _________________________________________________________________......
1924 * | |
1925 * |<---------------- strideInPixels ----------------------------->|
1926 *
1927 * If your buffer contains garbage data, you can crop them. For example, the frame size is
1928 * 360 x 640, often the buffer stride is 368, that is, there extra 8 pixels on the
1929 * right are for padding, and should be removed. In this case, you can set:
1930 * strideInPixels = 368;
1931 * height = 640;
1932 * cropRight = 8;
1933 * // cropLeft, cropTop, cropBottom are set to a default of 0
1934 */
1935
1938 - (void)fillAlphaData;
1939 @end
1940
1941 __attribute__((visibility("default"))) @interface AgoraLogConfig: NSObject
1953 @property (copy, nonatomic) NSString * _Nullable filePath;
1961 @property (assign, nonatomic) NSInteger fileSizeInKB;
1967 @property (assign, nonatomic) AgoraLogLevel level;
1968 @end
1969
1973 __attribute__((visibility("default"))) @interface AgoraRtcEngineConfig: NSObject
1974
1979 @property (copy, nonatomic) NSString * _Nullable appId;
1980
1984 @property (assign, nonatomic) AgoraChannelProfile channelProfile;
1985
1989 @property (copy, nonatomic) NSString * _Nullable license;
1990
1998 @property (assign, nonatomic) AgoraAudioScenario audioScenario;
2008 @property (assign, nonatomic) AgoraAreaCodeType areaCode;
2009 @property (strong, nonatomic) AgoraLogConfig * _Nullable logConfig;
2015 @property (assign, nonatomic) AgoraThreadPriorityType threadPriority;
2016 @property (weak, nonatomic) id<AgoraMediaFilterEventDelegate> _Nullable eventDelegate;
2022 @property (assign, nonatomic) BOOL domainLimit;
2023
2029 @property (assign, nonatomic) BOOL autoRegisterAgoraExtensions;
2030 @end
2031
2035 __attribute__((visibility("default"))) @interface AgoraAudioFrame : NSObject
2038 @property(assign, nonatomic) NSInteger samplesPerChannel;
2042 @property(assign, nonatomic) NSInteger bytesPerSample;
2049 @property(assign, nonatomic) NSInteger channels;
2052 @property(assign, nonatomic) NSInteger samplesPerSec;
2057 @property(assign, nonatomic) void* _Nullable buffer;
2065 @property(assign, nonatomic) int64_t renderTimeMs;
2068 @property(assign, nonatomic) int64_t presentationMs;
2071 @property(assign, nonatomic) NSInteger avSyncType;
2075 @property(assign, nonatomic) uint32_t rtpTimestamp;
2076 @end
2077
2106 __attribute__((visibility("default"))) @interface AgoraAudioParams : NSObject
2107
2116 @property (assign, nonatomic) NSInteger sampleRate;
2117
2118 /* The number of audio channels, which can be set as either of the following values:
2119
2120 - `1`: Mono (Default)
2121 - `2`: Stereo
2122 */
2123 @property (assign, nonatomic) NSInteger channel;
2124
2125 /* The use mode of the audio data. See AgoraAudioRawFrameOperationMode.
2126 */
2127 @property (assign, nonatomic) AgoraAudioRawFrameOperationMode mode;
2128
2132 @property (assign, nonatomic) NSInteger samplesPerCall;
2133
2134 @end
2135
2139 __attribute__((visibility("default"))) @interface AgoraEncodedAudioFrameInfo: NSObject
2140 @property (assign, nonatomic) NSInteger samplesPerChannel;
2141 @property (assign, nonatomic) NSInteger channels;
2142 @property (assign, nonatomic) NSInteger samplesPerSec;
2143 @property (assign, nonatomic) AgoraAudioCodecType codecType;
2144 @end
2145
2149 __attribute__((visibility("default"))) @interface AgoraUplinkNetworkInfo : NSObject
2153 @property(nonatomic, assign) int videoEncoderTargetBitrateBps;
2154 @end
2155
2159 __attribute__((visibility("default"))) @interface AgoraDownlinkNetworkInfo : NSObject
2163 @property(nonatomic, assign) int lastmileBufferDelayTimeMs;
2167 @property(nonatomic, assign) int bandwidthEstimationBps;
2168 @end
2169
2173 __attribute__((visibility("default"))) @interface AgoraLeaveChannelOptions : NSObject
2179 @property(nonatomic, assign) BOOL stopAudioMixing;
2180
2186 @property(nonatomic, assign) BOOL stopAllEffect;
2187
2193 @property(nonatomic, assign) BOOL unloadAllEffect;
2194
2200 @property(nonatomic, assign) BOOL stopMicrophoneRecording;
2201
2202 @end
2203
2204 __attribute__((visibility("default"))) @interface AgoraOutputVideoFrame : NSObject
2205
2218 @property (nonatomic, assign) NSInteger type;
2222 @property (nonatomic, assign) int width;
2226 @property (nonatomic, assign) int height;
2230 @property (nonatomic, assign) int yStride;
2234 @property (nonatomic, assign) int uStride;
2238 @property (nonatomic, assign) int vStride;
2242 @property (nonatomic, assign) uint8_t* _Nullable yBuffer;
2246 @property (nonatomic, assign) uint8_t* _Nullable uBuffer;
2250 @property (nonatomic, assign) uint8_t* _Nullable vBuffer;
2254 @property (nonatomic, assign) int rotation;
2261 @property (nonatomic, assign) int64_t renderTimeMs;
2265 @property (nonatomic, assign) int avSyncType;
2266
2269 @property(assign, nonatomic) CVPixelBufferRef _Nullable pixelBuffer;
2274 @property (nonatomic, assign) uint8_t* _Nullable alphaBuffer;
2284 @property (nonatomic, assign) AgoraAlphaStitchMode alphaStitchMode;
2285
2289 @property(nonatomic, strong) NSDictionary *_Nonnull metaInfo;
2290
2291 @property(nonatomic, strong) AgoraColorSpace* _Nullable colorSpace;
2292
2293 @end
2294
2297 __attribute__((visibility("default"))) @interface AgoraEncryptionConfig: NSObject
2298
2301 @property (assign, nonatomic) AgoraEncryptionMode encryptionMode;
2302
2309 @property (copy, nonatomic) NSString * _Nullable encryptionKey;
2310 @property (strong, nonatomic) NSData * _Nullable encryptionKdfSalt;
2311 @property (assign, nonatomic) BOOL datastreamEncryptionEnabled;
2312 @end
2313
2316 __attribute__((visibility("default"))) @interface AgoraUserInfo: NSObject
2317
2320 @property(assign, nonatomic) NSUInteger uid;
2321
2324 @property (copy, nonatomic) NSString * _Nullable userAccount;
2325 @end
2326
2329 __attribute__((visibility("default"))) @interface AgoraClientRoleOptions: NSObject
2330
2333 @property (assign, nonatomic) AgoraAudienceLatencyLevelType audienceLatencyLevel;
2334
2335 @end
2336
2339 __attribute__((visibility("default"))) @interface AgoraCameraCapturerConfiguration: NSObject
2345 #if (TARGET_OS_IOS || (defined(TARGET_OS_VISION) && TARGET_OS_VISION))
2346 @property (assign, nonatomic) AgoraCameraDirection cameraDirection;
2347 /*- AgoraFocalLengthDefault:
2348 For iOS, if iPhone/iPad has 3 or 2 back camera, it means combination of triple (wide + ultra wide + telephoto) camera
2349 or dual wide(wide + ultra wide) camera.In this situation, you can apply for ultra wide len by set smaller zoom fator
2350 and bigger zoom fator for telephoto len.Otherwise, it always means wide back/front camera.
2351
2352 - AgoraFocalLengthWide:wide camera
2353 - AgoraFocalLengthUltraWide:ultra wide camera
2354 - AgoraFocalLengthTelephoto:telephoto camera*/
2355 @property(assign, nonatomic) AgoraFocalLength cameraFocalLengthType;
2356 #elif TARGET_OS_MAC
2357
2360 @property (copy, nonatomic) NSString * _Nullable deviceId;
2361 #endif
2362
2366 @property(assign, nonatomic) CGSize dimensions;
2367
2370 @property(assign, nonatomic) int frameRate;
2371
2376 @property(assign, nonatomic) BOOL followEncodeDimensionRatio;
2377
2378 @end
2379
2382 __attribute__((visibility("default"))) @interface AgoraDataStreamConfig: NSObject
2383
2384 @property (assign, nonatomic) BOOL ordered;
2385
2386 @property (assign, nonatomic) BOOL syncWithAudio;
2387 @end
2388
2389
2392 __attribute__((visibility("default"))) @interface AgoraChannelMediaRelayInfo: NSObject
2395 @property (copy, nonatomic) NSString * _Nullable token;
2398 @property (copy, nonatomic) NSString * _Nullable channelName;
2401 @property (assign, nonatomic) NSUInteger uid;
2406 - (instancetype _Nonnull)initWithToken:(NSString *_Nullable)token NS_SWIFT_NAME(init(token:));
2407 @end
2408
2411 __attribute__((visibility("default"))) @interface AgoraChannelMediaRelayConfiguration: NSObject
2421 @property (strong, nonatomic, readonly) NSDictionary<NSString *, AgoraChannelMediaRelayInfo *> *_Nullable destinationInfos;
2431 @property (strong, nonatomic) AgoraChannelMediaRelayInfo *_Nonnull sourceInfo;
2450 - (BOOL)setDestinationInfo:(AgoraChannelMediaRelayInfo *_Nonnull)destinationInfo forChannelName:(NSString *_Nonnull)channelName NS_SWIFT_NAME(setDestinationInfo(_:forChannelName:));
2458 - (BOOL)removeDestinationInfoForChannelName:(NSString *_Nonnull)channelName NS_SWIFT_NAME(removeDestinationInfo(forChannelName:));
2459 @end
2460
2461
2463 __attribute__((visibility("default"))) @interface AgoraBeautyOptions : NSObject
2464
2473 @property(nonatomic, assign) AgoraLighteningContrastLevel lighteningContrastLevel;
2474
2479 @property(nonatomic, assign) float lighteningLevel;
2480
2485 @property(nonatomic, assign) float smoothnessLevel;
2486
2491 @property(nonatomic, assign) float rednessLevel;
2492
2497 @property(nonatomic, assign) float sharpnessLevel;
2498
2499 @end
2500
2505 __attribute__((visibility("default"))) @interface AgoraFaceShapeAreaOptions : NSObject
2524 @property(nonatomic, assign) AgoraFaceShapeArea shapeArea;
2528 @property(nonatomic, assign) int shapeIntensity;
2529
2530 @end
2531
2536 __attribute__((visibility("default"))) @interface AgoraFaceShapeBeautyOptions: NSObject
2544 @property(nonatomic, assign) AgoraFaceShapeStyle shapeStyle;
2549 @property(nonatomic, assign) int styleIntensity;
2550
2551 @end
2552
2555 __attribute__((visibility("default"))) @interface AgoraFilterEffectOptions: NSObject
2570 @property(nonatomic, copy) NSString* _Nullable path NS_SWIFT_NAME(path);
2571
2575 @property(nonatomic, assign) float strength;
2576
2577 @end
2578
2584 __attribute__((visibility("default"))) @interface AgoraVideoDenoiserOptions : NSObject
2585
2588 @property(nonatomic, assign) AgoraVideoDenoiserMode mode;
2589
2592 @property(nonatomic, assign) AgoraVideoDenoiserLevel level;
2593
2594 @end
2595
2601 __attribute__((visibility("default"))) @interface AgoraLowlightEnhanceOptions : NSObject
2602
2604 @property(nonatomic, assign) AgoraLowlightEnhanceMode mode;
2605
2607 @property(nonatomic, assign) AgoraLowlightEnhanceLevel level;
2608
2609 @end
2610
2616 __attribute__((visibility("default"))) @interface AgoraColorEnhanceOptions : NSObject
2617
2619 @property(nonatomic, assign) float strengthLevel;
2620
2622 @property(nonatomic, assign) float skinProtectLevel;
2623
2624 @end
2625
2626
2629 __attribute__((visibility("default"))) @interface AgoraVirtualBackgroundSource : NSObject
2630
2633 @property(nonatomic, assign) AgoraVirtualBackgroundSourceType backgroundSourceType NS_SWIFT_NAME(backgroundSourceType);
2634
2643 @property(nonatomic, assign) NSUInteger color NS_SWIFT_NAME(color);
2644
2651 @property(nonatomic, copy) NSString* _Nullable source NS_SWIFT_NAME(source);
2652
2654 @property(nonatomic, assign) AgoraBlurDegree blurDegree;
2655
2656 @end
2657
2660 __attribute__((visibility("default"))) @interface AgoraSegmentationProperty: NSObject
2661
2662 @property(nonatomic, assign) SegModelType modelType;
2663
2664 @property(nonatomic, assign) float greenCapacity;
2665
2666 @end
2669 __attribute__((visibility("default"))) @interface AgoraTranscodingVideoStream: NSObject
2673 @property (assign, nonatomic) NSUInteger remoteUserUid;
2674
2678 @property (assign, nonatomic) AgoraVideoSourceType sourceType;
2682 @property (copy, nonatomic) NSString * _Nullable imageUrl;
2686 @property(assign, nonatomic) NSUInteger mediaPlayerId;
2690 @property (assign, nonatomic) CGRect rect;
2696 @property (assign, nonatomic) NSInteger zOrder;
2700 @property(assign, nonatomic) double alpha;
2704 @property(assign, nonatomic) BOOL mirror;
2705
2706 @end
2707
2710 __attribute__((visibility("default"))) @interface AgoraMixedAudioStream: NSObject
2714 @property (assign, nonatomic) AgoraAudioSourceType sourceType;
2718 @property (assign, nonatomic) NSUInteger remoteUserUid;
2722 @property (copy, nonatomic) NSString * _Nullable channelId;
2726 @property (assign, nonatomic) NSUInteger trackId;
2727
2728 @end
2729
2732 __attribute__((visibility("default"))) @interface AgoraLocalAudioMixerConfiguration: NSObject
2733
2737 @property(copy, nonatomic) NSArray<AgoraMixedAudioStream *> *_Nullable audioInputStreams;
2738
2744 @property(assign, nonatomic) BOOL syncWithLocalMic;
2745
2746 @end
2747
2750 __attribute__((visibility("default"))) @interface AgoraLocalTranscoderConfiguration: NSObject
2751
2755 @property(copy, nonatomic) NSArray<AgoraTranscodingVideoStream *> *_Nullable videoInputStreams;
2756
2760 @property (strong, nonatomic) AgoraVideoEncoderConfiguration *_Nonnull videoOutputConfiguration;
2761
2767 @property(assign, nonatomic) BOOL syncWithPrimaryCamera;
2768
2769 @end
2770
2773 __attribute__((visibility("default"))) @interface AgoraScreenCaptureParameters: NSObject
2778 @property (assign, nonatomic) CGSize dimensions;
2783 @property (assign, nonatomic) NSInteger frameRate;
2788 @property (assign, nonatomic) NSInteger bitrate;
2789
2795 @property(assign, nonatomic) BOOL captureMouseCursor;
2796
2805 @property(assign, nonatomic) BOOL windowFocus;
2806
2815 @property(copy, nonatomic) NSArray* _Nullable excludeWindowList;
2816
2825 @property(assign, nonatomic) BOOL highLighted;
2831 @property(strong, nonatomic) COLOR_CLASS* _Nullable highLightColor;
2835 @property(assign, nonatomic) NSUInteger highLightWidth;
2836
2837 @property(assign, nonatomic) BOOL captureAudio;
2838
2839 @end
2840
2841 #if (!(TARGET_OS_IPHONE) && (TARGET_OS_MAC))
2842
2844 __attribute__((visibility("default"))) @interface AgoraScreenCaptureConfiguration: NSObject
2850 @property(assign, nonatomic) BOOL isCaptureWindow;
2854 @property(assign, nonatomic) UInt32 displayId;
2860 @property(assign, nonatomic) UInt32 windowId;
2861
2865 @property(strong, nonatomic) AgoraScreenCaptureParameters* _Nonnull params;
2873 @property(assign, nonatomic) CGRect regionRect;
2874
2875 @end
2876 #endif
2877
2878 __attribute__((visibility("default"))) @interface AgoraScreenVideoParameters : NSObject
2879
2910 @property(assign, nonatomic) CGSize dimensions;
2924 @property(assign, nonatomic) NSInteger frameRate;
2978 @property(assign, nonatomic) NSInteger bitrate;
2979
2982 @property(assign, nonatomic) AgoraVideoContentHint contentHint;
2983
2984 @end
2985
2986 __attribute__((visibility("default"))) @interface AgoraScreenAudioParameters : NSObject
2987
2988 @property(assign, nonatomic) NSInteger captureSignalVolume;
2989
2990 @end
2991
2992 __attribute__((visibility("default"))) @interface AgoraScreenCaptureParameters2 : NSObject
2996 @property(assign, nonatomic) BOOL captureAudio;
3000 @property(strong, nonatomic) AgoraScreenAudioParameters* _Nonnull audioParams;
3004 @property(assign, nonatomic) BOOL captureVideo;
3008 @property(strong, nonatomic) AgoraScreenVideoParameters* _Nonnull videoParams;
3009 @end
3010
3014 __attribute__((visibility("default"))) @interface AgoraAudioRecordingConfiguration: NSObject
3019 @property (copy, nonatomic) NSString * _Nullable filePath;
3029 @property (assign, nonatomic) NSUInteger sampleRate;
3033 @property (assign, nonatomic) AgoraAudioFileRecordingType fileRecordOption;
3038 @property (assign, nonatomic) AgoraAudioRecordingQuality quality;
3039
3045 @property (assign, nonatomic) NSInteger recordingChannel;
3046
3047 @end
3048
3051 __attribute__((visibility("default"))) @interface AgoraSimulcastStreamConfig: NSObject
3052
3056 @property (assign, nonatomic) int kBitrate;
3060 @property (assign, nonatomic) int framerate;
3064 @property (assign, nonatomic) CGSize dimensions;
3065 @end
3066
3067 __attribute__((visibility("default"))) @interface AgoraStreamLayerConfig: NSObject
3071 @property (assign, nonatomic) CGSize dimensions;
3075 @property (assign, nonatomic) int framerate;
3079 @property (assign, nonatomic) BOOL enable;
3080 @end
3081
3085 __attribute__((visibility("default"))) @interface AgoraSimulcastConfig: NSObject
3089 @property (copy, nonatomic, readonly) NSArray<AgoraStreamLayerConfig*>* _Nonnull configs;
3090
3091 @end
3092
3096 __attribute__((visibility("default"))) @interface AgoraRtcMediaStreamInfo : NSObject
3098 @property(nonatomic, assign) NSInteger streamIndex;
3100 @property(nonatomic, assign) AgoraMediaStreamType streamType;
3102 @property(nonatomic, copy) NSString *_Nonnull codecName;
3104 @property(nonatomic, copy) NSString *_Nullable language;
3106 @property(nonatomic, assign) NSInteger videoFrameRate;
3108 @property(nonatomic, assign) NSInteger videoBitRate;
3110 @property(nonatomic, assign) NSInteger videoWidth;
3112 @property(nonatomic, assign) NSInteger videoHeight;
3114 @property(nonatomic, assign) NSInteger audioSampleRate;
3116 @property(nonatomic, assign) NSInteger audioChannels;
3118 @property(nonatomic, assign) NSInteger duration;
3120 @property(nonatomic, assign) NSInteger rotation;
3121
3122 @end
3123
3124 __attribute__((visibility("default"))) @interface AgoraAudioSpectrumInfo : NSObject
3125
3127 @property(nonatomic, assign) NSInteger uid;
3128 @property(nonatomic, strong) NSArray<NSNumber *> * _Nullable audioSpectrumData;
3129
3130 @end
3131
3135 __attribute__((visibility("default"))) @interface AgoraAudioEncodedFrameDelegateConfig: NSObject
3139 @property (assign, nonatomic) AgoraAudioEncodedFrameDelegatePosition postionType;
3143 @property (assign, nonatomic) AgoraAudioEncodingType encodingType;
3144 @end
3145
3146 __attribute__((visibility("default"))) @interface AgoraContentInspectModule: NSObject
3147 @property (assign, nonatomic) AgoraContentInspectType type;
3148
3149 @property (assign, nonatomic) NSInteger interval;
3150
3151 @property (assign, nonatomic) AgoraVideoModulePosition position;
3152 @end
3153
3154 __attribute__((visibility("default"))) @interface AgoraContentInspectConfig: NSObject
3155 @property (nonatomic, copy) NSString* _Nullable extraInfo;
3159 @property (nonatomic, copy) NSString* _Nullable serverConfig;
3160 @property(copy, nonatomic) NSArray<AgoraContentInspectModule*>* _Nullable modules;
3161 @end
3162
3163 __attribute__((visibility("default"))) @interface AgoraSnapshotConfig: NSObject
3164 @property (copy, nonatomic) NSString * _Nullable filePath;
3165 @property(assign, nonatomic) AgoraVideoModulePosition position;
3166 @end
3167
3171 __attribute__((visibility("default"))) @interface AgoraRtcConnection: NSObject <NSCopying>
3172
3180 - (instancetype _Nonnull)initWithChannelId:(NSString *_Nonnull)channelId localUid:(NSInteger)localUid;
3181
3182 /* channelId Unique channel name for the AgoraRTC session in the string
3183 * format. The string length must be less than 64 bytes. Supported character
3184 * scopes are:
3185 * - All lowercase English letters: a to z.
3186 * - All uppercase English letters: A to Z.
3187 * - All numeric characters: 0 to 9.
3188 * - The space character.
3189 * - Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".
3190 */
3191 @property (nonatomic, copy) NSString *_Nonnull channelId;
3192
3193 /* uid Local User ID. A 32-bit unsigned integer with a value ranging from 1 to
3194 * (2<sup>32</sup>-1). The `uid` must be unique and not set to 0 . Your app
3195 * must record and maintain the returned `uid` since the SDK does not do so.
3196 */
3197 @property (nonatomic, assign) NSUInteger localUid;
3198
3199 @end
3200
3204 __attribute__((visibility("default"))) @interface AgoraVideoSubscriptionOptions: NSObject
3205
3206 /*
3207 * The type of the video stream to subscribe to.
3208 *
3209 * The default value is `VIDEO_STREAM_HIGH`, which means the high-quality
3210 * video stream.
3211 */
3212 @property (nonatomic, assign) AgoraVideoStreamType type;
3213 /*
3214 * Whether to subscribe to encoded video data only:
3215 * - `YES`: Subscribe to encoded video data only.
3216 * - `NO`: (Default) Subscribe to decoded video data.
3217 */
3218 @property (nonatomic, assign) BOOL encodedFrameOnly;
3219
3220 @end
3221
3225 __attribute__((visibility("default"))) @interface AgoraRecorderStreamInfo: NSObject
3226 /* User ID. A 32-bit unsigned integer with a value ranging from 1 to
3227 * (2<sup>32</sup>-1). The `uid` must be unique and not set to 0 . Your app
3228 * must record and maintain the returned `uid` since the SDK does not do so.
3229 */
3230 @property (nonatomic, nonatomic) NSUInteger uid;
3231
3232 /* The channel ID of the audio/video stream needs to be recorded.
3233 * The string length must be less than 64 bytes. Supported character
3234 * scopes are:
3235 * - All lowercase English letters: a to z.
3236 * - All uppercase English letters: A to Z.
3237 * - All numeric characters: 0 to 9.
3238 * - The space character.
3239 * - Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".
3240 */
3241 @property (nonatomic, copy) NSString *_Nonnull channelId;
3245 @property (assign, nonatomic) AgoraRecorderStreamType type;
3246 @end
3247
3251 __attribute__((visibility("default"))) @interface AgoraEncodedVideoFrameInfo: NSObject
3252
3256 @property (assign, nonatomic) NSInteger uid;
3257
3261 @property (assign, nonatomic) AgoraVideoCodecType codecType;
3265 @property (assign, nonatomic) NSInteger width;
3269 @property (assign, nonatomic) NSInteger height;
3276 @property (assign, nonatomic) NSInteger framesPerSecond;
3280 @property (assign, nonatomic) AgoraVideoFrameType frameType;
3284 @property (assign, nonatomic) NSInteger rotation;
3288 @property (assign, nonatomic) NSInteger trackId; // This can be reserved for multiple video tracks, we need to create different ssrc
3289 // and additional payload for later implementation.
3293 @property (assign, nonatomic) NSInteger captureTimeMs;
3297 @property (assign, nonatomic) NSInteger decodeTimeMs;
3301 @property (assign, nonatomic) AgoraVideoStreamType streamType;
3302 @end
3303
3304 NS_SWIFT_NAME(LogUploadServerInfo) __attribute__((visibility("default"))) @interface LogUploadServerInfo : NSObject
3307 @property(copy, nonatomic) NSString* _Nullable serverDomain;
3310 @property(copy, nonatomic) NSString* _Nullable serverPath;
3313 @property(assign, nonatomic) NSInteger serverPort;
3318 @property(assign, nonatomic) BOOL serverHttps;
3319 @end
3320
3321 NS_SWIFT_NAME(AdvancedConfigInfo) __attribute__((visibility("default"))) @interface AdvancedConfigInfo : NSObject
3324 @property(strong, nonatomic) LogUploadServerInfo* _Nullable logUploadServer;
3325 @end
3326
3327 NS_SWIFT_NAME(AgoraLocalAccessPointConfiguration) __attribute__((visibility("default"))) @interface AgoraLocalAccessPointConfiguration : NSObject
3330 @property(copy, nonatomic) NSArray* _Nullable ipList NS_SWIFT_NAME(ipList);
3333 @property(copy, nonatomic) NSArray* _Nullable domainList NS_SWIFT_NAME(domainList);
3337 @property(copy, nonatomic) NSString* _Nullable verifyDomainName NS_SWIFT_NAME(verifyDomainName);
3340 @property(assign, nonatomic) AgoraLocalProxyMode mode NS_SWIFT_NAME(mode);
3343 @property(strong, nonatomic) AdvancedConfigInfo* _Nullable advancedConfig NS_SWIFT_NAME(advancedConfig);
3349 @property(assign, nonatomic) BOOL disableAut;
3350 @end
3351
3356 __attribute__((visibility("default"))) @interface AgoraRhythmPlayerConfig: NSObject
3362 @property (assign, nonatomic) int beatsPerMeasure;
3363 /*
3364 * The range is 60 to 360.
3365 * The default value is 60,
3366 * which means that the rhythm player plays 60 beats in one minute.
3367 */
3368 @property (assign, nonatomic) int beatsPerMinute;
3369
3370 @end
3371
3374 NS_SWIFT_NAME(AgoraFacePositionInfo) __attribute__((visibility("default"))) @interface AgoraFacePositionInfo : NSObject
3375
3378 @property(assign, nonatomic) NSInteger x NS_SWIFT_NAME(x);
3379
3382 @property(assign, nonatomic) NSInteger y NS_SWIFT_NAME(y);
3383
3386 @property(assign, nonatomic) NSInteger width NS_SWIFT_NAME(width);
3387
3390 @property(assign, nonatomic) NSInteger height NS_SWIFT_NAME(height);
3391
3394 @property(assign, nonatomic) NSInteger distance NS_SWIFT_NAME(distance);
3395 @end
3396
3399 __attribute__((visibility("default"))) @interface AgoraAdvancedAudioOptions: NSObject
3400
3401 @property(assign, nonatomic) AgoraAudioProcessChannels audioProcessingChannels;
3402
3403 @end
3404
3405 __attribute__((visibility("default"))) @interface AgoraImageTrackOptions : NSObject
3406 @property(copy, nonatomic) NSString *_Nullable imageUrl;
3407 @property(assign, nonatomic) int fps;
3408 @property(assign, nonatomic) AgoraVideoMirrorMode mirrorMode;
3409 @end
3410
3415 __attribute__((visibility("default"))) @interface AgoraSpatialAudioParams : NSObject
3419 @property(assign, nonatomic) double speaker_azimuth;
3423 @property(assign, nonatomic) double speaker_elevation;
3427 @property(assign, nonatomic) double speaker_distance;
3431 @property(assign, nonatomic) NSInteger speaker_orientation;
3435 @property(assign, nonatomic) BOOL enable_blur;
3439 @property(assign, nonatomic) BOOL enable_air_absorb;
3443 @property(assign, nonatomic) double speaker_attenuation;
3447 @property(assign, nonatomic) BOOL enable_doppler;
3448 @end
3449
3450 NS_SWIFT_NAME(AgoraEchoTestConfiguration)
3451 __attribute__((visibility("default"))) @interface AgoraEchoTestConfiguration : NSObject
3459 @property(strong, nonatomic) VIEW_CLASS* _Nullable view NS_SWIFT_NAME(view);
3462 @property(assign, nonatomic) BOOL enableAudio NS_SWIFT_NAME(enableAudio);
3465 @property(assign, nonatomic) BOOL enableVideo NS_SWIFT_NAME(enableVideo);
3468 @property(copy, nonatomic) NSString* _Nullable token NS_SWIFT_NAME(token);
3471 @property(copy, nonatomic) NSString* _Nonnull channelId NS_SWIFT_NAME(channelId);
3476 @property(assign, nonatomic) NSInteger intervalInSeconds NS_SWIFT_NAME(intervalInSeconds);
3477 @end
3478
3482 NS_SWIFT_NAME(AgoraWlAccStats) __attribute__((visibility("default"))) @interface AgoraWlAccStats : NSObject
3486 @property(assign, nonatomic) NSInteger e2eDelayPercent NS_SWIFT_NAME(e2eDelayPercent);
3490 @property(assign, nonatomic) NSInteger frozenRatioPercent NS_SWIFT_NAME(frozenRatioPercent);
3494 @property(assign, nonatomic) NSInteger lossRatePercent NS_SWIFT_NAME(lossRatePercent);
3495 @end
3496
3497 __attribute__((visibility("default"))) @interface AgoraMediaRecorderInfo : NSObject
3498
3501 @property(copy, nonatomic) NSString* _Nonnull recorderFileName;
3504 @property(assign, nonatomic) NSUInteger durationMs;
3507 @property(assign, nonatomic) NSUInteger fileSize;
3508
3509 @end
3510
3511 __attribute__((visibility("default"))) @interface AgoraMediaRecorderConfiguration : NSObject
3512
3515 @property(copy, nonatomic) NSString* _Nonnull storagePath;
3518 @property(assign, nonatomic) AgoraMediaRecorderContainerFormat containerFormat;
3521 @property(assign, nonatomic) AgoraMediaRecorderStreamType streamType;
3524 @property(assign, nonatomic) NSUInteger maxDurationMs;
3527 @property(assign, nonatomic) NSUInteger recorderInfoUpdateInterval;
3530 @property(assign, nonatomic) NSUInteger width;
3533 @property(assign, nonatomic) NSUInteger height;
3536 @property(assign, nonatomic) NSUInteger fps;
3539 @property(assign, nonatomic) NSUInteger sample_rate;
3542 @property(assign, nonatomic) NSUInteger channel_num;
3545 @property(assign, nonatomic) AgoraVideoSourceType videoSourceType;
3546 @end
3547
3548 #if (!(TARGET_OS_IPHONE) && (TARGET_OS_MAC))
3549
3553 __attribute__((visibility("default"))) @interface AgoraScreenCaptureSourceInfo : NSObject
3555 @property(assign, nonatomic) AgoraScreenCaptureSourceType type;
3557 @property(assign, nonatomic) CGWindowID sourceId;
3559 @property(copy, nonatomic) NSString* _Nonnull sourceName;
3561 @property(strong, nonatomic) NSImage* _Nonnull thumbImage;
3563 @property(strong, nonatomic) NSImage* _Nullable iconImage;
3565 @property(copy, nonatomic) NSString* _Nonnull processPath;
3567 @property(copy, nonatomic) NSString* _Nonnull sourceTitle;
3569 @property(assign, nonatomic) CGRect position;
3575 @property(assign, nonatomic) BOOL primaryMonitor;
3576
3577 @end
3578
3579 #endif
3580
3581 NS_SWIFT_NAME(AgoraExtensionInfo) __attribute__((visibility("default"))) @interface AgoraExtensionInfo : NSObject
3582
3588 @property (assign, nonatomic) NSUInteger remoteUid NS_SWIFT_NAME(remoteUid);
3592 @property (assign, nonatomic) NSUInteger localUid NS_SWIFT_NAME(localUid);
3593
3597 @property (assign, nonatomic) AgoraMediaSourceType sourceType NS_SWIFT_NAME(sourceType);
3598
3610 @property (copy, nonatomic) NSString *_Nonnull channelId NS_SWIFT_NAME(channelId);
3611
3612 @end
3613
3616 NS_SWIFT_NAME(AgoraAudioTrackConfig) __attribute__((visibility("default"))) @interface AgoraAudioTrackConfig : NSObject
3622 @property (assign, nonatomic) BOOL enableLocalPlayback NS_SWIFT_NAME(enableLocalPlayback);
3628 @property (assign, nonatomic) BOOL enableAudioProcessing NS_SWIFT_NAME(enableAudioProcessing);
3629 @end
3630
3634 __attribute__((visibility("default"))) @interface AgoraVideoLayout: NSObject
3638 @property(copy, nonatomic) NSString* _Nonnull channelId NS_SWIFT_NAME(channelId);
3642 @property (assign, nonatomic) NSUInteger uid NS_SWIFT_NAME(uid);
3646 @property(copy, nonatomic) NSString* _Nullable strUid NS_SWIFT_NAME(strUid);
3651 @property (assign, nonatomic) NSUInteger videoState NS_SWIFT_NAME(videoState);
3655 @property (assign, nonatomic) NSUInteger x NS_SWIFT_NAME(x);
3659 @property (assign, nonatomic) NSUInteger y NS_SWIFT_NAME(y);
3663 @property (assign, nonatomic) NSUInteger width NS_SWIFT_NAME(width);
3667 @property (assign, nonatomic) NSUInteger height NS_SWIFT_NAME(height);
3668 @end
3669
3673 __attribute__((visibility("default"))) @interface AgoraVideoLayoutInfo: NSObject
3677 @property (assign, nonatomic) NSUInteger width NS_SWIFT_NAME(width);
3681 @property (assign, nonatomic) NSUInteger height NS_SWIFT_NAME(height);
3685 @property (assign, nonatomic) NSUInteger layoutCount NS_SWIFT_NAME(layoutCount);
3689 @property(copy, nonatomic) NSArray<AgoraVideoLayout *> *_Nullable layoutList NS_SWIFT_NAME(layoutList);
3690 @end
3691
3695 NS_SWIFT_NAME(AgoraVideoRenderingTracingInfo) __attribute__((visibility("default"))) @interface AgoraVideoRenderingTracingInfo : NSObject
3699 @property (assign, nonatomic) NSInteger elapsedTime NS_SWIFT_NAME(elapsedTime);
3706 @property (assign, nonatomic) NSInteger start2JoinChannel NS_SWIFT_NAME(start2JoinChannel);
3710 @property (assign, nonatomic) NSInteger join2JoinSuccess NS_SWIFT_NAME(join2JoinSuccess);
3718 @property (assign, nonatomic) NSInteger joinSuccess2RemoteJoined NS_SWIFT_NAME(joinSuccess2RemoteJoined);
3726 @property (assign, nonatomic) NSInteger remoteJoined2SetView NS_SWIFT_NAME(remoteJoined2SetView);
3735 @property (assign, nonatomic) NSInteger remoteJoined2UnmuteVideo NS_SWIFT_NAME(remoteJoined2UnmuteVideo);
3744 @property (assign, nonatomic) NSInteger remoteJoined2PacketReceived NS_SWIFT_NAME(remoteJoined2PacketReceived);
3745
3746 @end
3747
3751 NS_SWIFT_NAME(AgoraMetadata) __attribute__((visibility("default"))) @interface AgoraMetadata : NSObject
3755 @property (copy, nonatomic) NSString* _Nonnull channelId NS_SWIFT_NAME(channelId);
3759 @property (assign, nonatomic) NSInteger uid NS_SWIFT_NAME(uid);
3763 @property (strong, nonatomic) NSData* _Nonnull data NS_SWIFT_NAME(data);
3768 @property (assign, nonatomic) NSTimeInterval timestamp NS_SWIFT_NAME(timestamp);
3769 @end
3770
3774 __attribute__((visibility("default"))) @interface AgoraPathStats : NSObject
3775
3779 @property (assign, nonatomic) AgoraMultipathType pathType;
3780
3784 @property (assign, nonatomic) NSUInteger txKBitRate;
3785
3789 @property (assign, nonatomic) NSUInteger rxKBitRate;
3790 @end
3791
3795 __attribute__((visibility("default"))) @interface AgoraMultipathStats : NSObject
3799 @property (assign, nonatomic) NSUInteger lanRxBytes;
3803 @property (assign, nonatomic) NSUInteger lanTxBytes;
3807 @property (assign, nonatomic) NSUInteger wifiRxBytes;
3811 @property (assign, nonatomic) NSUInteger wifiTxBytes;
3815 @property (assign, nonatomic) NSUInteger mobileRxBytes;
3819 @property (assign, nonatomic) NSUInteger mobileTxBytes;
3823 @property (assign, nonatomic) NSUInteger activePathNum;
3827 @property (copy, nonatomic) NSArray<AgoraPathStats *> *_Nullable pathStats NS_SWIFT_NAME(pathStats);
3828 @end
AgoraRecorderStreamInfo
Definition: AgoraObjects.h:3226
AgoraMediaSource
Definition: AgoraObjects.h:52
AgoraLowlightEnhanceLevel
AgoraLowlightEnhanceLevel
Definition: AgoraEnumerates.h:2308
AgoraFacePositionInfo
Definition: AgoraObjects.h:3375
AgoraRtcMediaPlayerCustomSourceOnReadCallback
int(^ AgoraRtcMediaPlayerCustomSourceOnReadCallback)(id< AgoraRtcMediaPlayerProtocol > _Nonnull playerKit, unsigned char *_Nullable buffer, int bufferSize)
The player requests to read the data callback, you need to fill the specified length of data into the...
Definition: AgoraObjects.h:34
AgoraLocalProxyMode
AgoraLocalProxyMode
Definition: AgoraEnumerates.h:3614
AgoraMediaSource::isLiveSource
BOOL isLiveSource
Definition: AgoraObjects.h:104
AgoraDirectCdnStreamingStats
Definition: AgoraObjects.h:200
AgoraAudioSourceType
AgoraAudioSourceType
Definition: AgoraEnumerates.h:3012
AgoraDegradationPreference
AgoraDegradationPreference
Definition: AgoraEnumerates.h:1978
AgoraCameraDirection
AgoraCameraDirection
Definition: AgoraEnumerates.h:2716
AgoraMediaSource::playerOnReadCallback
AgoraRtcMediaPlayerCustomSourceOnReadCallback _Nonnull playerOnReadCallback
Definition: AgoraObjects.h:108
AgoraMediaSource::startPos
NSUInteger startPos
Definition: AgoraObjects.h:63
AgoraEncodedVideoTrackOptions
Definition: AgoraObjects.h:274
AgoraVideoRenderingTracingInfo
Definition: AgoraObjects.h:3696
AgoraScreenAudioParameters
Definition: AgoraObjects.h:2987
AgoraRtcChannelMediaOptions
Definition: AgoraObjects.h:300
AgoraAudioScenario
AgoraAudioScenario
Definition: AgoraEnumerates.h:1307
AgoraStreamLayerConfig
Definition: AgoraObjects.h:3068
AgoraRhythmPlayerConfig
Definition: AgoraObjects.h:3357
AgoraBeautyOptions
Definition: AgoraObjects.h:2464
AgoraVideoCodecCapInfo
Definition: AgoraObjects.h:1213
AgoraVideoSubscriptionOptions
Definition: AgoraObjects.h:3205
AgoraMultipathType
AgoraMultipathType
Defines the types of network paths used in multipath transmission.
Definition: AgoraEnumerates.h:3954
AgoraOutputVideoFrame
Definition: AgoraObjects.h:2205
AgoraAudioTrackConfig
Definition: AgoraObjects.h:3617
AgoraClientRole
AgoraClientRole
Definition: AgoraEnumerates.h:531
AgoraScreenCaptureParameters2
Definition: AgoraObjects.h:2993
AgoraExperiencePoorReason
AgoraExperiencePoorReason
Definition: AgoraEnumerates.h:773
AgoraMediaSource::uri
NSString *_Nullable uri
Definition: AgoraObjects.h:59
AgoraVideoDenoiserMode
AgoraVideoDenoiserMode
Definition: AgoraEnumerates.h:2275
AgoraContentInspectModule
Definition: AgoraObjects.h:3147
AgoraUplinkNetworkInfo
Definition: AgoraObjects.h:2150
AgoraMediaPlayerSrcInfo
The information of the media stream object.
Definition: AgoraObjects.h:184
AgoraFaceShapeAreaOptions
Definition: AgoraObjects.h:2506
AdvancedConfigInfo
Definition: AgoraObjects.h:3322
AgoraMediaSource::url
NSString *_Nullable url
Definition: AgoraObjects.h:55
AgoraVideoLayout
Definition: AgoraObjects.h:3635
AgoraLighteningContrastLevel
AgoraLighteningContrastLevel
Definition: AgoraEnumerates.h:2046
AgoraEnumerates.h
AgoraColorMatrixID
AgoraColorMatrixID
Definition: AgoraEnumerates.h:1888
AgoraVideoFrame
Definition: AgoraObjects.h:1812
AgoraSimulcastStreamConfig
Definition: AgoraObjects.h:3052
AgoraLocalAudioMixerConfiguration
Definition: AgoraObjects.h:2733
AgoraRtcConnection::channelId
NSString *_Nonnull channelId
Definition: AgoraObjects.h:3191
AgoraVideoModulePosition
AgoraVideoModulePosition
Definition: AgoraEnumerates.h:3810
AgoraScreenCaptureParameters
Definition: AgoraObjects.h:2774
AgoraAudioRawFrameOperationMode
AgoraAudioRawFrameOperationMode
Definition: AgoraEnumerates.h:1390
AgoraMediaRecorderInfo
Definition: AgoraObjects.h:3498
AgoraSegmentationProperty
Definition: AgoraObjects.h:2661
AgoraSimulcastConfig
Definition: AgoraObjects.h:3086
AgoraVideoDenoiserLevel
AgoraVideoDenoiserLevel
Definition: AgoraEnumerates.h:2286
AgoraRtcRemoteVideoStats
Definition: AgoraObjects.h:810
AgoraVideoViewSetupMode
AgoraVideoViewSetupMode
Definition: AgoraEnumerates.h:3652
AgoraMediaSource::autoPlay
BOOL autoPlay
Definition: AgoraObjects.h:69
AgoraContentInspectConfig
Definition: AgoraObjects.h:3155
AgoraAudioEncodedFrameDelegateConfig
Definition: AgoraObjects.h:3136
AgoraTranscodingVideoStream
Definition: AgoraObjects.h:2670
AgoraDirectCdnStreamingMediaOptions
Definition: AgoraObjects.h:227
AgoraAudioCodecType
AgoraAudioCodecType
Definition: AgoraEnumerates.h:697
AgoraColorPrimaryID
AgoraColorPrimaryID
Definition: AgoraEnumerates.h:1862
AgoraAudioEncodedFrameDelegatePosition
AgoraAudioEncodedFrameDelegatePosition
Definition: AgoraEnumerates.h:687
AgoraRtcMediaPlayerProtocol-p
Definition: AgoraRtcMediaPlayerProtocol.h:24
AgoraRtcConnection::localUid
NSUInteger localUid
Definition: AgoraObjects.h:3197
AgoraVideoDenoiserOptions
Definition: AgoraObjects.h:2585
AgoraLastmileProbeConfig
Definition: AgoraObjects.h:635
AgoraAudienceLatencyLevelType
AgoraAudienceLatencyLevelType
Definition: AgoraEnumerates.h:539
AgoraLastmileProbeResultState
AgoraLastmileProbeResultState
Definition: AgoraEnumerates.h:795
AgoraWlAccStats
Definition: AgoraObjects.h:3483
AgoraFocalLength
AgoraFocalLength
Definition: AgoraEnumerates.h:2727
AgoraMultipathStats
Definition: AgoraObjects.h:3796
AgoraRtcMediaStreamInfo
Definition: AgoraObjects.h:3097
AgoraFaceShapeArea
AgoraFaceShapeArea
The specific facial area to be adjusted.
Definition: AgoraEnumerates.h:2059
AgoraChannelMediaRelayInfo
Definition: AgoraObjects.h:2393
AgoraMediaSource::enableMultiAudioTrack
BOOL enableMultiAudioTrack
Definition: AgoraObjects.h:92
WatermarkOptions
Definition: AgoraObjects.h:1427
AgoraVideoSourceType
AgoraVideoSourceType
Definition: AgoraEnumerates.h:3043
AgoraAudioFrame
Definition: AgoraObjects.h:2036
AgoraMediaRecorderStreamType
AgoraMediaRecorderStreamType
Definition: AgoraEnumerates.h:3737
AgoraAudioEncodingType
AgoraAudioEncodingType
Definition: AgoraEnumerates.h:704
AgoraMediaSource::enableCache
BOOL enableCache
Definition: AgoraObjects.h:81
AgoraAreaCodeType
AgoraAreaCodeType
Definition: AgoraEnumerates.h:2572
VIEW_CLASS
UIView VIEW_CLASS
Definition: AgoraObjects.h:14
AgoraChannelProfile
AgoraChannelProfile
Definition: AgoraEnumerates.h:497
COLOR_CLASS
UIColor COLOR_CLASS
Definition: AgoraObjects.h:15
AgoraBlurDegree
AgoraBlurDegree
Definition: AgoraEnumerates.h:2332
AgoraAudioSpectrumInfo
Definition: AgoraObjects.h:3125
AgoraLeaveChannelOptions
Definition: AgoraObjects.h:2174
AgoraDataStreamConfig
Definition: AgoraObjects.h:2383
AgoraLowlightEnhanceMode
AgoraLowlightEnhanceMode
Definition: AgoraEnumerates.h:2297
AgoraRtcRemoteAudioStats
Definition: AgoraObjects.h:930
AgoraUserInfo
Definition: AgoraObjects.h:2317
AgoraVideoCodecCapabilityLevel
AgoraVideoCodecCapabilityLevel
Definition: AgoraEnumerates.h:406
AgoraRtcEngineConfig
Definition: AgoraObjects.h:1974
AgoraMediaStreamType
AgoraMediaStreamType
Definition: AgoraEnumerates.h:3167
AgoraImageTrackOptions
Definition: AgoraObjects.h:3406
AgoraColorSpace
Definition: AgoraObjects.h:1795
AgoraVideoRenderMode
AgoraVideoRenderMode
Definition: AgoraEnumerates.h:847
AgoraLastmileProbeOneWayResult
Definition: AgoraObjects.h:667
AgoraVideoQualityAdaptIndication
AgoraVideoQualityAdaptIndication
Definition: AgoraEnumerates.h:837
AgoraContentInspectType
AgoraContentInspectType
Definition: AgoraEnumerates.h:3500
AgoraEncryptionConfig
Definition: AgoraObjects.h:2298
AgoraColorRangeID
AgoraColorRangeID
Definition: AgoraEnumerates.h:1902
AgoraEncodedVideoFrameInfo
Definition: AgoraObjects.h:3252
AgoraRtcMediaPlayerCustomSourceOnSeekCallback
long long(^ AgoraRtcMediaPlayerCustomSourceOnSeekCallback)(id< AgoraRtcMediaPlayerProtocol > _Nonnull playerKit, long long offset, int whence)
The Player seek event callback, you need to operate the corresponding stream seek operation,...
Definition: AgoraObjects.h:49
AgoraMixedAudioStream
Definition: AgoraObjects.h:2711
AgoraChannelMediaRelayConfiguration
Definition: AgoraObjects.h:2412
AgoraVideoLayoutInfo
Definition: AgoraObjects.h:3674
AgoraMetadata
Definition: AgoraObjects.h:3752
AgoraVideoStreamType
AgoraVideoStreamType
Definition: AgoraEnumerates.h:817
AgoraVideoCodecTypeForStream
AgoraVideoCodecTypeForStream
Definition: AgoraEnumerates.h:444
AgoraEchoTestConfiguration
Definition: AgoraObjects.h:3452
AgoraMediaFilterEventDelegate-p
Definition: AgoraMediaFilterEventDelegate.h:36
AgoraFaceShapeStyle
AgoraFaceShapeStyle
The face shape style.
Definition: AgoraEnumerates.h:2260
AgoraAdvancedAudioOptions
Definition: AgoraObjects.h:3400
AgoraVideoCodecCapLevels
Definition: AgoraObjects.h:1192
AgoraRtcAudioVolumeInfo
Definition: AgoraObjects.h:1042
AgoraVideoHwEncoderAccelerating
AgoraVideoHwEncoderAccelerating
Definition: AgoraEnumerates.h:428
AgoraAlphaStitchMode
AgoraAlphaStitchMode
Definition: AgoraEnumerates.h:3913
AgoraMediaPlayerCacheStatistics
Definition: AgoraObjects.h:114
AgoraAudioProcessChannels
AgoraAudioProcessChannels
Definition: AgoraEnumerates.h:3658
AgoraLocalAccessPointConfiguration
Definition: AgoraObjects.h:3328
AgoraFocalLengthInfo
Definition: AgoraObjects.h:1202
AgoraEncodingPreference
AgoraEncodingPreference
Definition: AgoraEnumerates.h:1994
AgoraRecorderStreamType
AgoraRecorderStreamType
Definition: AgoraEnumerates.h:3751
AgoraFaceShapeBeautyOptions
Definition: AgoraObjects.h:2537
AgoraThreadPriorityType
AgoraThreadPriorityType
Definition: AgoraEnumerates.h:3473
AgoraScreenVideoParameters
Definition: AgoraObjects.h:2879
AgoraVirtualBackgroundSource
Definition: AgoraObjects.h:2630
AgoraMediaPlayerPlaybackStats
The real time statistics of the media stream being played.
Definition: AgoraObjects.h:126
AgoraLiveStreamAdvancedFeature
Definition: AgoraObjects.h:1385
AgoraRtcConnection
Definition: AgoraObjects.h:3171
AgoraSnapshotConfig
Definition: AgoraObjects.h:3164
AgoraLowlightEnhanceOptions
Definition: AgoraObjects.h:2602
AgoraExperienceQuality
AgoraExperienceQuality
Definition: AgoraEnumerates.h:762
__deprecated
#define __deprecated
Definition: AgoraBase.h:74
AgoraDownlinkNetworkInfo
Definition: AgoraObjects.h:2160
AgoraAudioCodecProfileType
AgoraAudioCodecProfileType
Definition: AgoraEnumerates.h:1114
AgoraVideoContentHint
AgoraVideoContentHint
Definition: AgoraEnumerates.h:3462
AgoraMediaSource::isAgoraSource
BOOL isAgoraSource
Definition: AgoraObjects.h:98
AgoraLocalTranscoderConfiguration
Definition: AgoraObjects.h:2751
AgoraRtcVideoCanvas
Definition: AgoraObjects.h:555
AgoraEncodedAudioFrameInfo
Definition: AgoraObjects.h:2140
AgoraVirtualBackgroundSourceType
AgoraVirtualBackgroundSourceType
Definition: AgoraEnumerates.h:2318
SegModelType
SegModelType
Definition: AgoraEnumerates.h:2341
AgoraMediaSource::playerOnSeekCallback
AgoraRtcMediaPlayerCustomSourceOnSeekCallback _Nonnull playerOnSeekCallback
Definition: AgoraObjects.h:109
AgoraAudioRecordingConfiguration
Definition: AgoraObjects.h:3015
AgoraColorTransferID
AgoraColorTransferID
Definition: AgoraEnumerates.h:1874
LogUploadServerInfo
Definition: AgoraObjects.h:3305
AgoraVideoFrameType
AgoraVideoFrameType
Definition: AgoraEnumerates.h:1847
AgoraColorEnhanceOptions
Definition: AgoraObjects.h:2617
AgoraMediaRecorderConfiguration
Definition: AgoraObjects.h:3512
AgoraMediaRecorderContainerFormat
AgoraMediaRecorderContainerFormat
Definition: AgoraEnumerates.h:3746
AgoraLogConfig
Definition: AgoraObjects.h:1942
AgoraPathStats
Definition: AgoraObjects.h:3775
AgoraMultipathMode
AgoraMultipathMode
Defines how data is transmitted across multiple network paths.
Definition: AgoraEnumerates.h:3939
AgoraClientRoleOptions
Definition: AgoraObjects.h:2330
AgoraMediaSourceType
AgoraMediaSourceType
Definition: AgoraEnumerates.h:2946
AgoraAudioFileRecordingType
AgoraAudioFileRecordingType
Definition: AgoraEnumerates.h:677
AgoraRtcLocalAudioStats
Definition: AgoraObjects.h:889
AgoraCameraCapturerConfiguration
Definition: AgoraObjects.h:2340
AgoraCompressionPreference
AgoraCompressionPreference
Definition: AgoraEnumerates.h:2010
IMAGE_CLASS
UIImage IMAGE_CLASS
Definition: AgoraObjects.h:16
AgoraAdvancedVideoOptions
Definition: AgoraObjects.h:1175
AgoraExtensionInfo
Definition: AgoraObjects.h:3582
AgoraMediaPlayerUpdatedInfo
The updated information of media player.
Definition: AgoraObjects.h:149
AgoraLogLevel
AgoraLogLevel
Definition: AgoraEnumerates.h:2547
AgoraScreenCaptureSourceType
AgoraScreenCaptureSourceType
Definition: AgoraEnumerates.h:3761
AgoraLastmileProbeResult
Definition: AgoraObjects.h:685
AgoraChannelStats
Definition: AgoraObjects.h:1062
AgoraCaptureBrightnessLevelType
AgoraCaptureBrightnessLevelType
Definition: AgoraEnumerates.h:547