ZoomVideoSDKUser.h

Go to the documentation of this file.

 
#import <Foundation/Foundation.h>
#import <ZoomVideoSDK/ZoomVideoSDKRawDataPipe.h>
#import <ZoomVideoSDK/ZoomVideoSDKVideoCanvas.h>
#import <ZoomVideoSDK/ZoomVideoSDKRemoteCameraControlHelper.h>
#import <ZoomVideoSDK/ZoomVideoSDKShareHelper.h>
 

typedef NS_ENUM(NSInteger, ZoomVideoSDKStatisticsDirection) {
    ZoomVideoSDKStatisticsDirection_Send = 0,
    ZoomVideoSDKStatisticsDirection_Receive = 1,
};

@interface ZoomVideoSDKQOSStatistics : NSObject

@property (nonatomic, assign, readonly) ZoomVideoSDKStatisticsDirection direction;

@property (nonatomic, assign, readonly) NSInteger timestamp;

@property (nonatomic, copy, readonly) NSString * _Nullable codecName;

@property (nonatomic, assign, readonly) NSInteger rtt;

@property (nonatomic, assign, readonly) double jitter;

@property (nonatomic, assign, readonly) NSInteger width;

@property (nonatomic, assign, readonly) NSInteger height;

@property (nonatomic, assign, readonly) NSInteger fps;

@property (nonatomic, assign, readonly) NSInteger bps;

@property (nonatomic, assign, readonly) NSInteger bytesTransferred;

@property (nonatomic, assign, readonly) NSInteger packetsLost;

@property (nonatomic, assign, readonly) NSInteger packetsTransferred;

@property (nonatomic, assign, readonly) ZoomVideoSDKNetworkStatus networkLevel;

@property (nonatomic, assign, readonly) ZoomVideoSDKDataType statisticsType;

@property (nonatomic, assign, readonly) NSInteger avg_loss;

@property (nonatomic, assign, readonly) NSInteger max_loss;

@property (nonatomic, assign, readonly) NSInteger bandwidth;
 
@end

@interface ZoomVideoSDKQOSSendStatistics : ZoomVideoSDKQOSStatistics

@property (nonatomic, assign, readonly) NSInteger frameWidthInput;

@property (nonatomic, assign, readonly) NSInteger frameHeightInput;

@property (nonatomic, assign, readonly) NSInteger frameRateInput;

@property (nonatomic, assign, readonly) NSInteger bytesSent;

@property (nonatomic, assign, readonly) NSInteger packetsSent;

@property (nonatomic, assign, readonly) NSInteger totalPacketSendDelay;

@property (nonatomic, assign, readonly) NSInteger totalEncodeTime;

@property (nonatomic, assign, readonly) NSInteger framesEncoded;

@property (nonatomic, assign, readonly) NSUInteger headerBytesSent;
 
@end

@interface ZoomVideoSDKQOSRecvStatistics : ZoomVideoSDKQOSStatistics

@property (nonatomic, assign, readonly) unsigned long long bytesReceived;

@property (nonatomic, assign, readonly) NSInteger packetsReceived;

@property (nonatomic, assign, readonly) NSInteger estimatedPlayoutTimestamp;

@property (nonatomic, assign, readonly) NSInteger totalDecodeTime;

@property (nonatomic, assign, readonly) NSInteger framesDecoded;

@property (nonatomic, assign, readonly) double jitterBufferDelay;

@property (nonatomic, assign, readonly) unsigned long long jitterBufferEmittedCount;

@property (nonatomic, assign, readonly) unsigned long long headerBytesReceived;

@property (nonatomic, assign, readonly) NSUInteger packetsDiscarded;

@property (nonatomic, assign, readonly) NSUInteger fecPacketsReceived;

@property (nonatomic, assign, readonly) NSUInteger fecPacketsDiscarded;

@property (nonatomic, assign, readonly) double jitterBufferTargetDelay;

@property (nonatomic, assign, readonly) double jitterBufferMinimumDelay;

@property (nonatomic, assign, readonly) unsigned long long totalSamplesReceived;

@property (nonatomic, assign, readonly) unsigned long long concealedSamples;

@property (nonatomic, assign, readonly) unsigned long long silentConcealedSamples;

@property (nonatomic, assign, readonly) unsigned long long concealmentEvents;

@property (nonatomic, assign, readonly) unsigned long long insertedSamplesForDeceleration;

@property (nonatomic, assign, readonly) unsigned long long removedSamplesForAcceleration;

@property (nonatomic, assign, readonly) double totalSamplesDuration;

@property (nonatomic, assign, readonly) double audioLevel;

@property (nonatomic, assign, readonly) double totalAudioEnergy;
 
@end
 

@interface ZoomVideoSDKVideoStatisticInfo : ZoomVideoSDKQOSStatistics

@property (nonatomic, assign) ZoomVideoSDKNetworkStatus videoNetworkStatus DEPRECATED_MSG_ATTRIBUTE("Use networkLevel instead");
 
@end

@interface ZoomVideoSDKShareStatisticInfo : ZoomVideoSDKQOSStatistics

@property (nonatomic, assign) ZoomVideoSDKNetworkStatus shareNetworkStatus DEPRECATED_MSG_ATTRIBUTE("Use networkLevel instead");
 
@end

@interface ZoomVideoSDKAudioStatus : NSObject
@property (nonatomic, assign) BOOL          isMuted;
@property (nonatomic, assign) BOOL          talking;
@property (nonatomic, assign) ZoomVideoSDKAudioType  audioType;
 
@end

@interface ZoomVideoSDKUser : NSObject
- (NSInteger)getUserID;
- (NSString *_Nullable)getUserName;
- (NSString *_Nullable)getCustomUserId DEPRECATED_MSG_ATTRIBUTE("Use -getUserKey instead");
- (NSString *_Nullable)getUserKey;
- (NSString *_Nullable)getUserReference;
- (BOOL)isHost;
- (BOOL)isManager;
- (BOOL)isIndividualRecordAgreed;
- (BOOL)isVideoSpotLighted;
- (ZoomVideoSDKAudioStatus *_Nullable)audioStatus;
- (ZoomVideoSDKVideoStatisticInfo *_Nullable)getVideoStatisticInfo;
- (ZoomVideoSDKShareStatisticInfo *_Nullable)getShareStatisticInfo;
- (ZoomVideoSDKRawDataPipe *_Nullable)getVideoPipe;
- (NSArray <ZoomVideoSDKRawDataPipe *> *_Nullable)getMultiCameraStreamList;

- (ZoomVideoSDKVideoCanvas *_Nullable)getVideoCanvas;
- (NSArray <ZoomVideoSDKVideoCanvas *> *_Nullable)getMultiCameraCanvasList;

- (ZoomVideoSDKRemoteCameraControlHelper *_Nullable)getRemoteCameraControlHelper;

- (NSArray <ZoomVideoSDKShareAction *>*_Nullable)getShareActionList;

- (BOOL)setUserVolume:(float)volume isShareAudio:(BOOL)isSharingAudio DEPRECATED_MSG_ATTRIBUTE("Use -setUserPlaybackVolume:isSharingAudio: instead");

- (BOOL)getUserVolume:(float * _Nullable)volume isShareAudio:(BOOL)isSharingAudio DEPRECATED_MSG_ATTRIBUTE("Use -getUserPlaybackVolume:isSharingAudio: instead");

- (BOOL)canSetUserVolume:(BOOL)isSharingAudio DEPRECATED_MSG_ATTRIBUTE("Use -canSetUserPlaybackVolume: instead");

- (BOOL)setUserPlaybackVolume:(float)volume isSharingAudio:(BOOL)isSharingAudio;

- (BOOL)getUserPlaybackVolume:(float * _Nullable)volume isSharingAudio:(BOOL)isSharingAudio;

- (BOOL)canSetUserPlaybackVolume:(BOOL)isShareAudio;

- (unsigned int)getAudioLevel;

- (ZoomVideoSDKError)transferFile:(NSString * _Nullable)filePath;

- (BOOL)isIncomingLiveStreamUser;

- (ZoomVideoSDKWhiteboardStatus)getWhiteboardStatus;

- (BOOL)isInSubSession;

- (BOOL)isInFailover;

- (ZoomVideoSDKNetworkStatus)getNetworkLevel:(ZoomVideoSDKDataType)type;

- (ZoomVideoSDKNetworkStatus)getOverallNetworkLevel;
@end