iOS/macOS(Objective-C)[v1.7.5.0]
PanoObjects.h
浏览该文件的文档.
1
2//
3// PanoObjects.h
4// PanoRtc
5//
6// Copyright © 2019 Pano. All rights reserved.
7//
8
9#import <Foundation/Foundation.h>
10#import "PanoEnumerates.h"
11
20#if TARGET_OS_IPHONE
21#import <UIKit/UIKit.h>
22typedef UIView PanoView;
23#endif
24#if TARGET_OS_OSX
25#import <AppKit/AppKit.h>
26typedef NSView PanoView;
27#endif
28
43typedef UInt32 PanoScreenSourceID;
44
47__attribute__((visibility("default"))) @interface PanoRtcEngineConfig : NSObject
50@property (strong, nonatomic) NSString * _Nonnull appId;
53@property (strong, nonatomic) NSString * _Nonnull rtcServer;
56@property (assign, nonatomic) BOOL videoCodecHwAcceleration;
59@property (assign, nonatomic) UInt32 audioScenario;
62@property (assign, nonatomic) PanoAudioAecType audioAecType;
63@end
64
67__attribute__((visibility("default"))) @interface PanoRtcChannelConfig : NSObject
70@property (assign, nonatomic) PanoChannelMode mode;
73@property (assign, nonatomic) PanoChannelService serviceFlags;
76@property (assign, nonatomic) BOOL subscribeAudioAll;
83@property (strong, nonatomic) NSString * _Nullable userName;
84@property (assign, nonatomic) int attendeeId;
85@end
86
89__attribute__((visibility("default"))) @interface PanoRtcGroupConfig : NSObject
93@property (strong, nonatomic) NSString * _Nullable userData;
94@end
95
98__attribute__((visibility("default"))) @interface PanoRtcGroupUserInfo : NSObject
102@property (assign, nonatomic) UInt64 userId;
106@property (strong, nonatomic) NSString * _Nullable userData;
107@end
108
110__attribute__((visibility("default"))) @interface PanoRtcVideoConfig : NSObject
113@property (assign, nonatomic) PanoVideoProfileType profileType;
115@property (assign, nonatomic) BOOL sourceMirror;
118@property (assign, nonatomic) PanoVideoScalingMode scalingMode;
121@property (assign, nonatomic) BOOL mirror;
122@end
123
125
127__attribute__((visibility("default"))) @interface PanoRtcVideoSourceConfig : NSObject
130@property (assign, nonatomic) PanoVideoProfileType profileType;
132@property (assign, nonatomic) BOOL sourceMirror;
133@end
134
136__attribute__((visibility("default"))) @interface PanoRtcVideoRenderConfig : NSObject
139@property (assign, nonatomic) PanoVideoScalingMode scalingMode;
142@property (assign, nonatomic) BOOL mirror;
143@end
144
146__attribute__((visibility("default"))) @interface PanoRtcAudioFormat : NSObject
149@property (assign, nonatomic) PanoAudioType type;
152@property (assign, nonatomic) UInt32 channels;
155@property (assign, nonatomic) UInt32 sampleRate;
158@property (assign, nonatomic) UInt32 bytesPerSample;
159@end
160
162__attribute__((visibility("default"))) @interface PanoRtcVideoFormat : NSObject
165@property (assign, nonatomic) PanoVideoType type;
168@property (assign, nonatomic) UInt32 width;
171@property (assign, nonatomic) UInt32 height;
176@property (assign, nonatomic) UInt32 count;
181@property (strong, nonatomic) NSArray<NSNumber *> * _Nonnull offset;
184@property (strong, nonatomic) NSArray<NSNumber *> * _Nonnull stride;
187@property (assign, nonatomic) PanoVideoRotation rotation;
190@property (assign, nonatomic) BOOL mirror;
191@end
192
194__attribute__((visibility("default"))) @interface PanoRtcAudioLevel : NSObject
199@property (assign, nonatomic) UInt64 userId;
204@property (assign, nonatomic) UInt32 level;
209@property (assign, nonatomic) BOOL active;
210@end
211
213__attribute__((visibility("default"))) @interface PanoRtcAudioProfile : NSObject
216@property (assign, nonatomic) PanoAudioSampleRate sampleRate;
219@property (assign, nonatomic) PanoAudioChannel channel;
222@property (assign, nonatomic) UInt32 encodeBitrate;
224@property (assign, nonatomic) bool dtx;
225@end
226
228__attribute__((visibility("default"))) @interface PanoRtcAudioSendStats : NSObject
233@property (assign, nonatomic) SInt64 bytesSent;
238@property (assign, nonatomic) SInt64 sendBitrate;
243@property (assign, nonatomic) SInt64 packetsLost;
248@property (assign, nonatomic) Float32 lossRatio;
253@property (assign, nonatomic) SInt64 rtt;
258@property (assign, nonatomic) SInt16 inputLevel;
263@property (assign, nonatomic) BOOL inputActiveFlag; // YES: active, NO: inactive
268@property (assign, nonatomic) PanoAudioCodecType codecType;
269@end
270
272__attribute__((visibility("default"))) @interface PanoRtcAudioRecvStats : NSObject
277@property (assign, nonatomic) UInt64 userId;
282@property (assign, nonatomic) SInt64 bytesRecv;
287@property (assign, nonatomic) SInt64 recvBitrate;
292@property (assign, nonatomic) SInt64 packetsLost;
297@property (assign, nonatomic) Float32 lossRatio;
302@property (assign, nonatomic) SInt16 outputLevel;
307@property (assign, nonatomic) SInt16 stutterScore; // level: [1,5]
312@property (assign, nonatomic) PanoAudioCodecType codecType;
317@property (assign, nonatomic) UInt32 jitterBufferDelay;
322@property (assign, nonatomic) SInt32 endToEndDelay;
327@property (assign, nonatomic) SInt64 rtt;
328@end
329
331__attribute__((visibility("default"))) @interface PanoRtcVideoSendStats : NSObject
334@property (assign, nonatomic) SInt32 streamId;
339@property (assign, nonatomic) SInt64 bytesSent;
344@property (assign, nonatomic) SInt64 sendBitrate;
349@property (assign, nonatomic) SInt64 packetsLost;
354@property (assign, nonatomic) Float32 lossRatio;
359@property (assign, nonatomic) SInt32 width;
364@property (assign, nonatomic) SInt32 height;
369@property (assign, nonatomic) SInt32 framerate;
374@property (assign, nonatomic) SInt32 plisReceived;
379@property (assign, nonatomic) SInt64 rtt;
384@property (assign, nonatomic) PanoVideoCodecType codecType;
385@end
386
388__attribute__((visibility("default"))) @interface PanoRtcVideoRecvStats : NSObject
393@property (assign, nonatomic) UInt64 userId;
396@property (assign, nonatomic) SInt32 streamId;
401@property (assign, nonatomic) SInt64 bytesRecv;
406@property (assign, nonatomic) SInt64 recvBitrate;
411@property (assign, nonatomic) SInt64 packetsLost;
416@property (assign, nonatomic) Float32 lossRatio;
421@property (assign, nonatomic) SInt32 width;
426@property (assign, nonatomic) SInt32 height;
431@property (assign, nonatomic) SInt32 framerate;
436@property (assign, nonatomic) SInt32 plisSent;
441@property (assign, nonatomic) PanoVideoCodecType codecType;
442@end
443
450
457
460__attribute__((visibility("default"))) @interface PanoRtcVideoSendBweStats : NSObject
465@property (assign, nonatomic) SInt64 bandwidth;
470@property (assign, nonatomic) SInt64 encodeBitrate;
475@property (assign, nonatomic) SInt64 transmitBitrate;
480@property (assign, nonatomic) SInt64 retransmitBitrate;
481@end
482
485__attribute__((visibility("default"))) @interface PanoRtcVideoRecvBweStats : NSObject
490@property (assign, nonatomic) UInt64 userId;
495@property (assign, nonatomic) SInt64 bandwidth;
496@end
497
499__attribute__((visibility("default"))) @interface PanoRtcSystemStats : NSObject
502@property (assign, nonatomic) UInt8 totalCpuUsage;
505@property (assign, nonatomic) UInt64 totalPhysMemory;
508@property (assign, nonatomic) UInt64 workingSetSize;
511@property (assign, nonatomic) UInt8 memoryUsage;
512@end
513
515__attribute__((visibility("default"))) @interface PanoRtcDeviceInfo : NSObject
517@property (strong, nonatomic) NSString * _Nonnull deviceId;
519@property (strong, nonatomic) NSString * _Nonnull deviceName;
520@end
521
523__attribute__((visibility("default"))) @interface PanoRtcScreenSourceInfo : NSObject
525@property (assign, nonatomic) PanoScreenSourceID sourceId;
527@property (strong, nonatomic) NSString * _Nonnull sourceName;
528@end
529
531__attribute__((visibility("default"))) @interface PanoWBColor : NSObject
534@property (assign, nonatomic) Float32 red;
537@property (assign, nonatomic) Float32 green;
540@property (assign, nonatomic) Float32 blue;
543@property (assign, nonatomic) Float32 alpha;
544@end
545
547__attribute__((visibility("default"))) @interface PanoWBTextFormat : NSObject
550@property (assign, nonatomic) PanoWBFontStyle style;
553@property (assign, nonatomic) UInt32 size;
554@end
555
557__attribute__((visibility("default"))) @interface PanoWBStamp : NSObject
560@property (strong, nonatomic) NSString * _Nonnull stampId;
563@property (strong, nonatomic) NSString * _Nonnull path;
566@property (assign, nonatomic) BOOL resizable;
567@end
568
578__attribute__((visibility("default"))) @interface PanoWBDocContents : NSObject
581@property (strong, nonatomic) NSString * _Nullable name;
584@property (strong, nonatomic) NSArray<NSString *> * _Nonnull urls;
587@property (strong, nonatomic) NSArray<NSString *> * _Nonnull thumbUrls;
590@property (strong, nonatomic) NSString * _Nullable docId;
593@property (assign, nonatomic) PanoWBDocType type;
594@end
595
601__attribute__((visibility("default"))) @interface PanoWBDocExtHtml : NSObject
604@property (strong, nonatomic) NSString * _Nullable name;
607@property (strong, nonatomic) NSString * _Nonnull url;
610@property (strong, nonatomic) NSArray<NSString *> * _Nonnull thumbUrls;
611@end
612
618__attribute__((visibility("default"))) @interface PanoWBDocExtContents : NSObject
620@property (strong, nonatomic) NSString * _Nullable name;
622@property (assign, nonatomic) UInt32 totalPages;
624@property (assign, nonatomic) UInt32 width;
626@property (assign, nonatomic) UInt32 height;
627@end
628
630__attribute__((visibility("default"))) @interface PanoWBConvertConfig : NSObject
633@property (assign, nonatomic) PanoWBConvertType type;
636@property (assign, nonatomic) BOOL needThumb;
639@property (assign, nonatomic) SInt32 lifeType;
642@property (strong, nonatomic) NSString * _Nullable meta;
643@end
644
646__attribute__((visibility("default"))) @interface PanoWBDocInfo : NSObject
648@property (strong, nonatomic) NSString * _Nonnull fileId;
650@property (strong, nonatomic) NSString * _Nonnull name;
652@property (assign, nonatomic) UInt64 creator;
654@property (assign, nonatomic) PanoWBDocType type;
657@property (strong, nonatomic) NSString * _Nonnull docId;
658@end
659
661__attribute__((visibility("default"))) @interface PanoWBVisionConfig : NSObject
663@property (assign, nonatomic) UInt32 width;
665@property (assign, nonatomic) UInt32 height;
667@property (assign, nonatomic) BOOL limited;
668@end
669
671__attribute__((visibility("default"))) @interface PanoWBDrawEvent : NSObject
673@property (assign, nonatomic) PanoWBDrawEventType type;
674@end
675
677typedef UInt32 PanoWBPageNumber;
678
680__attribute__((visibility("default"))) @interface PanoFaceBeautifyOption : NSObject
683@property (assign, nonatomic) BOOL enable;
686@property (assign, nonatomic) Float32 intensity;
687@end
688
690__attribute__((visibility("default"))) @interface PanoBuiltinTransformOption : NSObject
693@property (assign, nonatomic) BOOL enable;
696@property (assign, nonatomic) BOOL bReset;
699@property (assign, nonatomic) Float32 xScaling;
702@property (assign, nonatomic) Float32 yScaling;
705@property (assign, nonatomic) Float32 xRotation;
708@property (assign, nonatomic) Float32 yRotation;
711@property (assign, nonatomic) Float32 zRotation;
714@property (assign, nonatomic) Float32 xProjection;
717@property (assign, nonatomic) Float32 yProjection;
718@end
719
720
722__attribute__((visibility("default"))) @interface PanoQuadTransformOption : NSObject
725@property (assign, nonatomic) BOOL enable;
728@property (assign, nonatomic) BOOL bReset;
731@property (assign, nonatomic) PanoQuadIndex index;
734@property (assign, nonatomic) Float32 xDeltaAxis;
737@property (assign, nonatomic) Float32 yDeltaAxis;
740@property (assign, nonatomic) BOOL bMirror;
741@end
742
745__attribute__((visibility("default"))) @interface PanoFeedbackInfo : NSObject
748@property (assign, nonatomic) PanoFeedbackType type;
751@property (strong, nonatomic) NSString * _Nonnull productName;
754@property (strong, nonatomic) NSString * _Nonnull detailDescription;
757@property (strong, nonatomic) NSString * _Nullable contact;
760@property (strong, nonatomic) NSString * _Nullable extraInfo;
763@property (assign, nonatomic) BOOL uploadLogs;
764@end
765
767__attribute__((visibility("default"))) @interface PanoRtcAudioMixingConfig : NSObject
770@property (assign, nonatomic) BOOL enablePublish;
777@property (assign, nonatomic) SInt32 publishVolume;
780@property (assign, nonatomic) BOOL enableLoopback;
787@property (assign, nonatomic) SInt32 loopbackVolume;
790@property (assign, nonatomic) SInt32 cycle;
793@property (assign, nonatomic) BOOL replaceMicrophone;
794@end
795
797__attribute__((visibility("default"))) @interface PanoRtcSnapshotVideoOption : NSObject
800@property (assign, nonatomic) PanoImageFileFormat format;
803@property (assign, nonatomic) BOOL mirror;
804@end
805
807__attribute__((visibility("default"))) @interface PanoRtcNetworkQuality : NSObject
810@property (assign, nonatomic) PanoQualityRating rating;
813@property (assign, nonatomic) Float32 txLoss;
816@property (assign, nonatomic) Float32 rxLoss;
819@property (assign, nonatomic) SInt32 rtt;
820@end
821
822__attribute__((visibility("default"))) @interface PanoPropertyAction : NSObject
823
824@property (assign, nonatomic) PanoActionType type;
825@property (copy, nonatomic) NSString * _Nonnull propName;
826@property (strong, nonatomic) NSData * _Nullable propValue;
827
828@end
829
831__attribute__((visibility("default"))) @interface PanoKeyboardEvent : NSObject
832
835@property (assign, nonatomic) PanoKeyboardEventType type;
840@property (assign, nonatomic) UInt8 asciiCode;
841
842@end
843
845__attribute__((visibility("default"))) @interface PanoLocalRecordingOption : NSObject
848@property (assign, nonatomic) PanoLayoutMode layoutMode;
851@property (assign, nonatomic) PanoVideoProfileType profileType;
854@property (copy, nonatomic) NSString * _Nullable recordingPath;
857@property (assign, nonatomic) UInt64 minFreeDiskSpaceMB;
858@end
859
861__attribute__((visibility("default"))) @interface PanoLocalRecordingItem : NSObject
863@property (copy, nonatomic) NSString * _Nonnull channelId;
865@property (copy, nonatomic) NSString * _Nonnull filePath;
867@property (copy, nonatomic) NSString * _Nonnull recordTime;
868@end
PanoChannelService
频道服务标志。
Definition: PanoEnumerates.h:118
PanoQualityRating
质量评分分值。
Definition: PanoEnumerates.h:879
PanoAudioType
音频类型。
Definition: PanoEnumerates.h:190
PanoLayoutMode
录制布局模式。
Definition: PanoEnumerates.h:1005
PanoImageFileFormat
图片文件格式。
Definition: PanoEnumerates.h:733
PanoAudioChannel
音频采样率。
Definition: PanoEnumerates.h:859
PanoVideoCodecType
视频编解码器类型。
Definition: PanoEnumerates.h:825
PanoKeyboardEventType
键盘事件类型
Definition: PanoEnumerates.h:981
PanoVideoProfileType
视频设定类型。
Definition: PanoEnumerates.h:154
PanoActionType
操作类型
Definition: PanoEnumerates.h:971
PanoAudioSampleRate
音频采样率。
Definition: PanoEnumerates.h:851
PanoWBConvertType
白板文件转码类型。
Definition: PanoEnumerates.h:386
PanoVideoRotation
视频旋转值。
Definition: PanoEnumerates.h:202
PanoChannelMode
频道模式。
Definition: PanoEnumerates.h:110
PanoFeedbackType
用户反馈问题类型。
Definition: PanoEnumerates.h:711
PanoWBFontStyle
白板字体样式。
Definition: PanoEnumerates.h:332
PanoWBDrawEventType
白板绘制相关事件类型。
Definition: PanoEnumerates.h:431
PanoWBDocType
白板文件类型。
Definition: PanoEnumerates.h:398
PanoVideoType
视频类型。
Definition: PanoEnumerates.h:196
PanoQuadIndex
四边形顶点索引。
Definition: PanoEnumerates.h:945
PanoVideoScalingMode
视频缩放模式。
Definition: PanoEnumerates.h:177
PanoAudioCodecType
音频编解码器类型。
Definition: PanoEnumerates.h:835
PanoAudioAecType
音频回声消除类型。
Definition: PanoEnumerates.h:98
UIView PanoView
PANO视图类。
Definition: PanoObjects.h:22
PanoRtcVideoSendStats PanoRtcScreenSendStats
屏幕共享发送的统计类。
Definition: PanoObjects.h:449
UInt32 PanoScreenSourceID
屏幕源标识类。
Definition: PanoObjects.h:43
UInt32 PanoWBPageNumber
白板页码类。
Definition: PanoObjects.h:677
PanoRtcVideoRecvStats PanoRtcScreenRecvStats
屏幕共享接收的统计信息类。
Definition: PanoObjects.h:456
(已废弃)视频内嵌变换选项类。
Definition: PanoObjects.h:691
美颜选项类。
Definition: PanoObjects.h:681
用户反馈信息类,用于发送用户反馈。
Definition: PanoObjects.h:746
键盘事件。
Definition: PanoObjects.h:832
本地录制信息类。
Definition: PanoObjects.h:862
本地录制参数类。
Definition: PanoObjects.h:846
Definition: PanoObjects.h:823
视频四边形变换选项类。
Definition: PanoObjects.h:723
音频格式类。
Definition: PanoObjects.h:147
音频接收统计类。
Definition: PanoObjects.h:195
音频混音配置类。
Definition: PanoObjects.h:768
音频配置。
Definition: PanoObjects.h:214
音频接收统计类。
Definition: PanoObjects.h:273
音频发送统计类。
Definition: PanoObjects.h:229
用于加入频道的配置类。
Definition: PanoObjects.h:68
设备信息类。
Definition: PanoObjects.h:516
PanoRtcEngineKit 对象的配置类。
Definition: PanoObjects.h:48
BOOL videoCodecHwAcceleration
视频编解码器是否启用硬件加速。默认值:否。
Definition: PanoObjects.h:56
PanoAudioAecType audioAecType
AEC type。默认值:1(默认)
Definition: PanoObjects.h:62
NSString *_Nonnull appId
从PANO申请的应用标识。
Definition: PanoObjects.h:50
UInt32 audioScenario
音频场景。默认值:0(voip)
Definition: PanoObjects.h:59
NSString *_Nonnull rtcServer
PANO服务器地址。格式:<"域名">[:端口]
Definition: PanoObjects.h:53
用于加入分组的配置类。
Definition: PanoObjects.h:90
分组用户额外信息。
Definition: PanoObjects.h:99
网络质量报告。
Definition: PanoObjects.h:808
屏幕源信息类。
Definition: PanoObjects.h:524
视频快照选项类。
Definition: PanoObjects.h:798
系统信息统计类。
Definition: PanoObjects.h:500
视频配置类。
Definition: PanoObjects.h:111
视频格式类。
Definition: PanoObjects.h:163
视频接收带宽评估统计类。
Definition: PanoObjects.h:486
视频接收统计类。
Definition: PanoObjects.h:389
视频渲染配置类。
Definition: PanoObjects.h:137
视频发送带宽评估统计类。
Definition: PanoObjects.h:461
视频发送统计类。
Definition: PanoObjects.h:332
视频源配置类。
Definition: PanoObjects.h:128
白板颜色类。
Definition: PanoObjects.h:532
白板文件转码配置类。
Definition: PanoObjects.h:631
白板文件内容类。
Definition: PanoObjects.h:579
白板文件外部内容。
Definition: PanoObjects.h:619
白板文件外部Html内容。
Definition: PanoObjects.h:602
白板文件信息类。
Definition: PanoObjects.h:647
白板绘制相关信息。
Definition: PanoObjects.h:672
白板图章类。
Definition: PanoObjects.h:558
白板文本格式类。
Definition: PanoObjects.h:548
白板视口配置。
Definition: PanoObjects.h:662