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 #elif TARGET_OS_MAC
17 #import <AppKit/AppKit.h>
18 typedef NSView VIEW_CLASS;
19 typedef NSColor COLOR_CLASS;
20 #endif
21 
25 __attribute__((visibility("default"))) @interface AgoraRtcChannelMediaOptions : NSObject
31 @property(assign, nonatomic) BOOL publishCameraTrack;
32 
38 @property(assign, nonatomic) BOOL publishSecondaryCameraTrack;
39 
45 @property(assign, nonatomic) BOOL publishScreenTrack;
51 @property(assign, nonatomic) BOOL publishCustomAudioTrack;
57 @property(assign, nonatomic) BOOL publishCustomVideoTrack;
63 @property(assign, nonatomic) BOOL publishEncodedVideoTrack;
69 @property(assign, nonatomic) BOOL publishMediaPlayerAudioTrack;
75 @property(assign, nonatomic) BOOL publishAudioTrack;
83 @property(assign, nonatomic) BOOL autoSubscribeAudio;
91 @property(assign, nonatomic) BOOL autoSubscribeVideo;
101 @property(assign, nonatomic) BOOL enableAudioRecordingOrPlayout;
105 @property(assign, nonatomic) AgoraClientRole clientRoleType;
109 @property(assign, nonatomic) AgoraVideoStreamType defaultVideoStreamType;
113 @property(assign, nonatomic) AgoraChannelProfile channelProfile;
118 @property(assign, assign) unsigned int connectionId;
119 
120 @end
121 
124 __attribute__((visibility("default"))) @interface AgoraRtcVideoCanvas : NSObject
132 @property(strong, nonatomic) VIEW_CLASS *_Nullable view;
135 @property(assign, nonatomic) AgoraVideoRenderMode renderMode;
138 @property(assign, nonatomic) NSUInteger uid;
139 @property(copy, nonatomic) NSString *_Nullable userId; // the string user id of view
140 @property(assign, nonatomic) BOOL isSecondaryCameraView;
141 
142 @end
143 
147 __attribute__((visibility("default"))) @interface AgoraLastmileProbeConfig : NSObject
155 @property (assign, nonatomic) BOOL probeUplink;
161 @property (assign, nonatomic) BOOL probeDownlink;
168 @property (assign, nonatomic) NSUInteger expectedUplinkBitrate;
173 @property (assign, nonatomic) NSUInteger expectedDownlinkBitrate;
174 @end
175 
179 __attribute__((visibility("default"))) @interface AgoraLastmileProbeOneWayResult : NSObject
183 @property (assign, nonatomic) NSUInteger packetLossRate;
187 @property (assign, nonatomic) NSUInteger jitter;
191 @property (assign, nonatomic) NSUInteger availableBandwidth;
192 @end
193 
197 __attribute__((visibility("default"))) @interface AgoraLastmileProbeResult : NSObject
202 @property (assign, nonatomic) AgoraLastmileProbeResultState state;
206 @property (assign, nonatomic) NSUInteger rtt;
212 @property (strong, nonatomic) AgoraLastmileProbeOneWayResult *_Nonnull uplinkReport;
218 @property (strong, nonatomic) AgoraLastmileProbeOneWayResult *_Nonnull downlinkReport;
219 @end
220 
221 
224 __attribute__((visibility("default"))) @interface AgoraRtcLocalVideoStats : NSObject
227 @property(assign, nonatomic) NSUInteger sentBitrate;
230 @property(assign, nonatomic) NSUInteger sentFrameRate;
234 @property(assign, nonatomic) NSUInteger uid;
235 
238 @property(assign, nonatomic) NSInteger encoderOutputFrameRate;
241 @property(assign, nonatomic) NSInteger rendererOutputFrameRate;
244 @property(assign, nonatomic) NSInteger targetFrameRate;
248 @property(assign, nonatomic) NSInteger targetBitrate;
252 @property(assign, nonatomic) NSInteger encodedBitrate;
256 @property(assign, nonatomic) NSInteger encodedFrameWidth;
260 @property(assign, nonatomic) NSInteger encodedFrameHeight;
264 @property(assign, nonatomic) NSInteger encodedFrameCount;
270 @property(assign, nonatomic) AgoraVideoCodecType codecType;
271 
272 @end
273 
275 __attribute__((visibility("default"))) @interface AgoraRtcRemoteVideoStats : NSObject
278 @property(assign, nonatomic) NSUInteger uid;
281 @property(assign, nonatomic) NSUInteger delay __deprecated;
284 @property(assign, nonatomic) NSUInteger width;
287 @property(assign, nonatomic) NSUInteger height;
290 @property(assign, nonatomic) NSUInteger receivedBitrate;
293 @property(assign, nonatomic) NSUInteger receivedFrameRate;
296 @property(assign, nonatomic) AgoraVideoStreamType rxStreamType;
297 
300 @property(assign, nonatomic) NSInteger decoderOutputFrameRate;
303 @property(assign, nonatomic) NSInteger rendererOutputFrameRate;
306 @property(assign, nonatomic) NSInteger packetLossRate;
312 @property(assign, nonatomic) NSInteger totalFrozenTime;
316 @property(assign, nonatomic) NSInteger frozenRate;
317 
318 @end
319 
323 __attribute__((visibility("default"))) @interface AgoraRtcLocalAudioStats : NSObject
327 @property(assign, nonatomic) NSUInteger numChannels;
331 @property(assign, nonatomic) NSUInteger sentSampleRate;
335 @property(assign, nonatomic) NSUInteger sentBitrate;
338 @property(assign, nonatomic) NSUInteger internalCodec;
339 
340 @end
341 
345 __attribute__((visibility("default"))) @interface AgoraRtcRemoteAudioStats : NSObject
349 @property(assign, nonatomic) NSUInteger uid;
362 @property(assign, nonatomic) NSUInteger quality;
366 @property(assign, nonatomic) NSUInteger networkTransportDelay;
370 @property(assign, nonatomic) NSUInteger jitterBufferDelay;
374 @property(assign, nonatomic) NSUInteger audioLossRate;
378 @property(assign, nonatomic) NSUInteger numChannels;
382 @property(assign, nonatomic) NSUInteger receivedSampleRate;
386 @property(assign, nonatomic) NSUInteger receivedBitrate;
393 @property(assign, nonatomic) NSUInteger totalFrozenTime;
397 @property(assign, nonatomic) NSUInteger frozenRate;
398 @end
399 
402 __attribute__((visibility("default"))) @interface AgoraRtcAudioVolumeInfo : NSObject
405 @property(assign, nonatomic) NSUInteger uid;
408 @property(assign, nonatomic) NSUInteger volume;
409 @end
410 
414 __attribute__((visibility("default"))) @interface AgoraChannelStats : NSObject
418 @property(assign, nonatomic) NSUInteger duration;
422 @property(assign, nonatomic) NSUInteger txBytes;
426 @property(assign, nonatomic) NSUInteger rxBytes;
430 @property(assign, nonatomic) NSUInteger txAudioKBitrate;
434 @property(assign, nonatomic) NSUInteger rxAudioKBitrate;
438 @property(assign, nonatomic) NSUInteger txVideoKBitrate;
442 @property(assign, nonatomic) NSUInteger rxVideoKBitrate;
446 @property(assign, nonatomic) NSUInteger txAudioBytes;
450 @property(assign, nonatomic) NSUInteger txVideoBytes;
455 @property(assign, nonatomic) NSUInteger rxAudioBytes;
459 @property(assign, nonatomic) NSUInteger rxVideoBytes;
463 @property(assign, nonatomic) NSUInteger lastmileDelay;
467 @property(assign, nonatomic) NSUInteger userCount;
470 @property(assign, nonatomic) double cpuAppUsage;
473 @property(assign, nonatomic) double cpuTotalUsage;
477 @property(assign, nonatomic) NSUInteger connectionId;
481 @property(assign, nonatomic) NSInteger connectTimeMs;
482 
486 @property(assign, nonatomic) NSUInteger txKBitRate;
490 @property(assign, nonatomic) NSUInteger rxKBitRate;
491 
494 @property(assign, nonatomic) NSInteger firstAudioPacketDuration;
497 @property(assign, nonatomic) NSInteger firstVideoPacketDuration;
500 @property(assign, nonatomic) NSInteger firstVideoKeyFramePacketDuration;
503 @property(assign, nonatomic) NSInteger packetsBeforeFirstKeyFramePacket;
504 
505 @end
506 
509 __attribute__((visibility("default"))) @interface AgoraVideoEncoderConfiguration : NSObject
534 @property(assign, nonatomic) CGSize dimensions;
535 
538 @property(assign, nonatomic) AgoraVideoCodecType codecType;
539 
542 @property(assign, nonatomic) AgoraVideoFrameRate frameRate;
543 
564 @property(assign, nonatomic) NSInteger bitrate;
565 
568 @property(assign, nonatomic) AgoraVideoOutputOrientationMode orientationMode;
569 
579 - (instancetype _Nonnull)initWithSize:(CGSize)size
580  frameRate:(AgoraVideoFrameRate)frameRate
581  bitrate:(NSInteger)bitrate
582  orientationMode:(AgoraVideoOutputOrientationMode)orientationMode;
583 
594 - (instancetype _Nonnull)initWithWidth:(NSInteger)width
595  height:(NSInteger)height
596  frameRate:(AgoraVideoFrameRate)frameRate
597  bitrate:(NSInteger)bitrate
598  orientationMode:(AgoraVideoOutputOrientationMode)orientationMode;
599 @end
600 
603 __attribute__((visibility("default"))) @interface AgoraLiveTranscodingUser : NSObject
606 @property(assign, nonatomic) NSUInteger uid;
609 @property(assign, nonatomic) CGRect rect;
615 @property(assign, nonatomic) NSInteger zOrder;
621 @property(assign, nonatomic) double alpha;
636 @property(assign, nonatomic) NSInteger audioChannel;
637 @end
638 
641 __attribute__((visibility("default"))) @interface AgoraImage : NSObject
644 @property(strong, nonatomic) NSURL *_Nonnull url;
647 @property(assign, nonatomic) CGRect rect;
648 @end
649 
652 __attribute__((visibility("default"))) @interface AgoraLiveTranscoding : NSObject
655 @property(assign, nonatomic) CGSize size;
658 @property(assign, nonatomic) NSInteger videoBitrate;
661 @property(assign, nonatomic) NSInteger videoFramerate;
666 @property(assign, nonatomic) BOOL lowLatency;
669 @property(assign, nonatomic) NSInteger videoGop;
672 @property(assign, nonatomic) AgoraVideoCodecProfileType videoCodecProfile;
673 
677 @property(copy, nonatomic) NSArray<AgoraLiveTranscodingUser *> *_Nullable transcodingUsers;
680 @property(copy, nonatomic) NSString *_Nullable transcodingExtraInfo;
686 @property(strong, nonatomic) AgoraImage *_Nullable watermark;
692 @property(strong, nonatomic) AgoraImage *_Nullable backgroundImage;
695 @property(strong, nonatomic) COLOR_CLASS *_Nullable backgroundColor;
696 
699 @property(assign, nonatomic) AgoraAudioSampleRateType audioSampleRate;
702 @property(assign, nonatomic) NSInteger audioBitrate;
711 @property(assign, nonatomic) NSInteger audioChannels;
712 
717 + (AgoraLiveTranscoding *_Nonnull)defaultTranscoding;
718 
719 - (int)addUser:(AgoraLiveTranscodingUser *_Nonnull)user;
720 
721 - (int)removeUser:(NSUInteger)uid;
722 @end
723 
726 __attribute__((visibility("default"))) @interface AgoraLiveInjectStreamConfig : NSObject
730 @property(assign, nonatomic) CGSize size;
733 @property(assign, nonatomic) NSInteger videoGop;
736 @property(assign, nonatomic) NSInteger videoFramerate;
739 @property(assign, nonatomic) NSInteger videoBitrate;
740 
743 @property(assign, nonatomic) AgoraAudioSampleRateType audioSampleRate;
746 @property(assign, nonatomic) NSInteger audioBitrate;
749 @property(assign, nonatomic) NSInteger audioChannels;
750 
755 + (AgoraLiveInjectStreamConfig *_Nonnull)defaultConfig;
756 @end
757 
758  __deprecated
759 
762  __attribute__((visibility("default"))) @interface AgoraRtcVideoCompositingRegion
763  : NSObject
766  @property(assign, nonatomic) NSUInteger uid;
769 @property(assign, nonatomic) CGFloat x;
772 @property(assign, nonatomic) CGFloat y;
775 @property(assign, nonatomic) CGFloat width;
778 @property(assign, nonatomic) CGFloat height;
781 @property(assign, nonatomic) NSInteger zOrder;
784 @property(assign, nonatomic) CGFloat alpha;
787 @property(assign, nonatomic) AgoraVideoRenderMode renderMode;
788 @end
789 
790  __deprecated
793  __attribute__((visibility("default"))) @interface AgoraRtcVideoCompositingLayout
794  : NSObject
797  @property(assign, nonatomic) NSInteger canvasWidth;
800 @property(assign, nonatomic) NSInteger canvasHeight;
803 @property(copy, nonatomic) NSString *_Nullable backgroundColor;
806 @property(copy, nonatomic) NSArray<AgoraRtcVideoCompositingRegion *> *_Nullable regions;
809 @property(copy, nonatomic) NSString *_Nullable appData;
810 @end
811 
817  __deprecated __attribute__((visibility("default"))) @interface AgoraPublisherConfiguration
818  : NSObject
824  @property(assign, nonatomic) BOOL owner;
825 
828 @property(assign, nonatomic) NSInteger width;
831 @property(assign, nonatomic) NSInteger height;
834 @property(assign, nonatomic) NSInteger framerate;
837 @property(assign, nonatomic) NSInteger bitrate;
840 @property(assign, nonatomic) NSInteger audiosamplerate;
843 @property(assign, nonatomic) NSInteger audiobitrate;
846 @property(assign, nonatomic) NSInteger audiochannels;
847 
854 @property(assign, nonatomic) NSInteger defaultLayout;
857 @property(assign, nonatomic) AgoraRtmpStreamLifeCycle lifeCycle;
858 
861 @property(assign, nonatomic) NSInteger injectStreamWidth;
862 
865 @property(assign, nonatomic) NSInteger injectStreamHeight;
866 
869 @property(copy, nonatomic) NSString *_Nullable injectStreamUrl;
870 
873 @property(copy, nonatomic) NSString *_Nullable publishUrl;
874 
878 @property(copy, nonatomic) NSString *_Nullable rawStreamUrl;
879 
882 @property(copy, nonatomic) NSString *_Nullable extraInfo;
883 
886 - (BOOL)validate;
887 
888 - (NSString * _Nullable)toJsonString;
889 @end
890 
891 #if (!(TARGET_OS_IPHONE) && (TARGET_OS_MAC))
892 
895 __attribute__((visibility("default"))) @interface AgoraRtcDeviceInfo : NSObject
896 @property (assign, nonatomic) int __deprecated index;
897 
900 @property(assign, nonatomic) AgoraMediaDeviceType type;
901 
904 @property(copy, nonatomic) NSString *_Nullable deviceId;
905 
908 @property(copy, nonatomic) NSString *_Nullable deviceName;
909 @end
910 #endif
911 
914 __attribute__((visibility("default"))) @interface AgoraVideoFrame : NSObject
926 @property(assign, nonatomic) NSInteger format;
927 
931 @property(assign, nonatomic) CMTime time; // Time for this frame.
932 
936 @property(assign, nonatomic) int stride DEPRECATED_MSG_ATTRIBUTE("use strideInPixels instead");
937 
941 @property(assign, nonatomic) int strideInPixels; // Number of pixels between two consecutive rows.
942  // Note: in pixel, not byte. Not used for iOS
943  // textures.
944 
947 @property(assign, nonatomic) int height; // Number of rows of pixels. Not used for iOS textures.
948 
951 @property(assign, nonatomic) CVPixelBufferRef _Nullable textureBuf;
952 
955 @property(strong, nonatomic) NSData *_Nullable dataBuf; // Raw data buffer. Not used for iOS textures.
956 
959 @property(assign, nonatomic) int cropLeft; // Number of pixels to crop on the left boundary.
962 @property(assign, nonatomic) int cropTop; // Number of pixels to crop on the top boundary.
965 @property(assign, nonatomic) int cropRight; // Number of pixels to crop on the right boundary.
968 @property(assign, nonatomic) int cropBottom; // Number of pixels to crop on the bottom boundary.
972 @property(assign, nonatomic) int rotation; // 0, 90, 180, 270. See document for rotation calculation.
973 /* Note
974  * 1. strideInPixels
975  * Stride is in pixels, not bytes
976  * 2. About the frame width and height
977  * No field is defined for the width. However, it can be deduced by:
978  * croppedWidth = (strideInPixels - cropLeft - cropRight)
979  * And
980  * croppedHeight = (height - cropTop - cropBottom)
981  * 3. About crop
982  * _________________________________________________________________.....
983  * | ^ | ^
984  * | | | |
985  * | cropTop | |
986  * | | | |
987  * | v | |
988  * | ________________________________ | |
989  * | | | | |
990  * | | | | |
991  * |<-- cropLeft -->| valid region |<- cropRight ->|
992  * | | | | height
993  * | | | |
994  * | |_____________________________ | | |
995  * | ^ | |
996  * | | | |
997  * | cropBottom | |
998  * | | | |
999  * | v | v
1000  * _________________________________________________________________......
1001  * | |
1002  * |<---------------- strideInPixels ----------------------------->|
1003  *
1004  * If your buffer contains garbage data, you can crop them. For example, the frame size is
1005  * 360 x 640, often the buffer stride is 368, that is, there extra 8 pixels on the
1006  * right are for padding, and should be removed. In this case, you can set:
1007  * strideInPixels = 368;
1008  * height = 640;
1009  * cropRight = 8;
1010  * // cropLeft, cropTop, cropBottom are set to a default of 0
1011  */
1012 @end
1013 
1014 __attribute__((visibility("default"))) @interface AgoraRtcEngineConfig: NSObject
1015  @property (copy, nonatomic) NSString * _Nullable appId;
1016  @property (assign, nonatomic) AgoraChannelProfile channelProfile;
1017  @property (assign, nonatomic) AgoraAudioScenario audioScenario;
1018  @property (assign, nonatomic) AgoraAreaCodeType areaCode;
1019 @end
1020 
1025 __attribute__((visibility("default"))) @interface AgoraAudioFrame: NSObject
1026  @property (assign, nonatomic) NSInteger samplesPerChannel;
1027  @property (assign, nonatomic) NSInteger bytesPerSample;
1028  @property (assign, nonatomic) NSInteger channels;
1029  @property (assign, nonatomic) NSInteger samplesPerSec;
1030  @property (strong, nonatomic) NSData* _Nullable buffer;
1031  @property (assign, nonatomic) int64_t renderTimeMs;
1032  @property (assign, nonatomic) NSInteger avSyncType;
1033 @end
1034 
1038 __attribute__((visibility("default"))) @interface AgoraNetworkInfo : NSObject
1042 @property(nonatomic, assign) int videoEncoderTargetBitrateBps;
1043 
1044 @end
AgoraRtcChannelMediaOptions
Definition: AgoraObjects.h:26
AgoraRtcChannelMediaOptions::clientRoleType
AgoraClientRole clientRoleType
Definition: AgoraObjects.h:105
AgoraAudioScenario
AgoraAudioScenario
Definition: AgoraEnumerates.h:945
AgoraRtcChannelMediaOptions::channelProfile
AgoraChannelProfile channelProfile
Definition: AgoraObjects.h:113
AgoraRtcChannelMediaOptions::publishAudioTrack
BOOL publishAudioTrack
Definition: AgoraObjects.h:75
AgoraRtcChannelMediaOptions::publishScreenTrack
BOOL publishScreenTrack
Definition: AgoraObjects.h:45
AgoraClientRole
AgoraClientRole
Definition: AgoraEnumerates.h:486
AgoraRtcChannelMediaOptions::autoSubscribeAudio
BOOL autoSubscribeAudio
Definition: AgoraObjects.h:83
AgoraEnumerates.h
AgoraVideoFrame
Definition: AgoraObjects.h:915
AgoraRtcChannelMediaOptions::connectionId
unsigned int connectionId
Definition: AgoraObjects.h:118
AgoraRtcRemoteVideoStats
Definition: AgoraObjects.h:276
AgoraNetworkInfo
Definition: AgoraObjects.h:1039
AgoraRtcChannelMediaOptions::publishCustomAudioTrack
BOOL publishCustomAudioTrack
Definition: AgoraObjects.h:51
AgoraLastmileProbeConfig
Definition: AgoraObjects.h:148
AgoraRtcChannelMediaOptions::publishCustomVideoTrack
BOOL publishCustomVideoTrack
Definition: AgoraObjects.h:57
AgoraLastmileProbeResultState
AgoraLastmileProbeResultState
Definition: AgoraEnumerates.h:610
AgoraRtcChannelMediaOptions::publishCameraTrack
BOOL publishCameraTrack
Definition: AgoraObjects.h:31
AgoraAudioFrame
Definition: AgoraObjects.h:1026
AgoraAreaCodeType
AgoraAreaCodeType
Definition: AgoraEnumerates.h:1348
VIEW_CLASS
UIView VIEW_CLASS
Definition: AgoraObjects.h:14
AgoraChannelProfile
AgoraChannelProfile
Definition: AgoraEnumerates.h:446
COLOR_CLASS
UIColor COLOR_CLASS
Definition: AgoraObjects.h:15
AgoraRtcChannelMediaOptions::publishSecondaryCameraTrack
BOOL publishSecondaryCameraTrack
Definition: AgoraObjects.h:38
AgoraRtcChannelMediaOptions::enableAudioRecordingOrPlayout
BOOL enableAudioRecordingOrPlayout
Definition: AgoraObjects.h:101
AgoraRtcRemoteAudioStats
Definition: AgoraObjects.h:346
AgoraRtcEngineConfig
Definition: AgoraObjects.h:1015
AgoraVideoRenderMode
AgoraVideoRenderMode
Definition: AgoraEnumerates.h:634
AgoraLastmileProbeOneWayResult
Definition: AgoraObjects.h:180
AgoraVideoStreamType
AgoraVideoStreamType
Definition: AgoraEnumerates.h:626
AgoraRtcAudioVolumeInfo
Definition: AgoraObjects.h:403
AgoraRtcChannelMediaOptions::publishEncodedVideoTrack
BOOL publishEncodedVideoTrack
Definition: AgoraObjects.h:63
AgoraRtcVideoCanvas
Definition: AgoraObjects.h:125
AgoraRtcChannelMediaOptions::autoSubscribeVideo
BOOL autoSubscribeVideo
Definition: AgoraObjects.h:91
AgoraRtcChannelMediaOptions::defaultVideoStreamType
AgoraVideoStreamType defaultVideoStreamType
Definition: AgoraObjects.h:109
AgoraRtcLocalAudioStats
Definition: AgoraObjects.h:324
AgoraRtcChannelMediaOptions::publishMediaPlayerAudioTrack
BOOL publishMediaPlayerAudioTrack
Definition: AgoraObjects.h:69
AgoraLastmileProbeResult
Definition: AgoraObjects.h:198
AgoraChannelStats
Definition: AgoraObjects.h:415