ZMVideoSDKUserHelper.h

Go to the documentation of this file.

 
#import <Foundation/Foundation.h>
#import <ZMVideoSDK/ZMVideoSDKDef.h>
#import <ZMVideoSDK/ZMVideoSDKVideoCanvas.h>
 
@class ZMVideoSDKShareAction;
 
NS_ASSUME_NONNULL_BEGIN
@interface ZMVideoSDKVideoStatus : NSObject

@property (nonatomic, assign, readonly) BOOL isHasVideoDevice;
    
@property (nonatomic, assign, readonly) BOOL isOn;
@end

@interface ZMVideoSDKAudioStatus : NSObject
    
@property (nonatomic, assign, readonly) ZMVideoSDKAudioType audioType;
    
@property (nonatomic, assign, readonly) BOOL isMuted;
    
@property (nonatomic, assign, readonly) BOOL isTalking;
@end

@interface ZMVideoSDKQOSStatistics : NSObject

@property (nonatomic, assign, readonly) ZMVideoSDKStatisticsDirection 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) ZMVideoSDKNetworkStatus networkLevel;

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

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

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

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

@interface ZMVideoSDKQOSSendStatistics : ZMVideoSDKQOSStatistics

@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 ZMVideoSDKQOSRecvStatistics : ZMVideoSDKQOSStatistics

@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 ZMVideoSDKVideoStatisticInfo : ZMVideoSDKQOSStatistics

@property (nonatomic, assign, readonly) int bpf DEPRECATED_MSG_ATTRIBUTE("Use bps instead");

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

@interface ZMVideoSDKShareStatisticInfo : ZMVideoSDKQOSStatistics

@property (nonatomic, assign, readonly) int bpf DEPRECATED_MSG_ATTRIBUTE("Use bps instead");

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

@interface ZMVideoSDKYUVRawDataI420 : NSObject

@property (nonatomic, assign, readonly) char* _Nullable yBuffer;

@property (nonatomic, assign, readonly) char* _Nullable uBuffer;

@property (nonatomic, assign, readonly) char* _Nullable vBuffer;

@property (nonatomic, assign, readonly) char* _Nullable buffer;

@property (nonatomic, assign, readonly, nullable) char* alphaBuffer;

@property (nonatomic, assign, readonly) unsigned int bufferLen;

@property (nonatomic, assign, readonly) unsigned int alphaBufferLen;

@property (nonatomic, assign, readonly) BOOL isLimitedI420;

@property (nonatomic, assign, readonly) unsigned int streamWidth;

@property (nonatomic, assign, readonly) unsigned int streamHeight;

@property (nonatomic, assign, readonly) unsigned int rotation;

@property (nonatomic, assign, readonly) unsigned int resourceID;

@property (nonatomic, assign, readonly) long long timeStamp;
- (BOOL)canAddRef;

- (BOOL)addRef;

- (int)releaseRef;
@end
 

@interface ZMVideoSDKShareCursorData : NSObject

@property (nonatomic, assign, readonly) unsigned int sourceID;

@property (nonatomic, assign, readonly) int x;

@property (nonatomic, assign, readonly) int y;
@end

@protocol ZMVideoSDKRawDataPipeDelegate <NSObject>
@optional
    
- (void)onRawDataFrameReceived:(ZMVideoSDKYUVRawDataI420*)data;
    
- (void)onRawDataStatusChanged:(ZMVideoSDKRawDataStatus)status;

- (void)onShareCursorDataReceived:(ZMVideoSDKShareCursorData *)info;
@end

@interface ZMVideoSDKRawDataPipe : NSObject

- (ZMVideoSDKErrors)subscribe:(ZMVideoSDKResolution)resolution listener:(id<ZMVideoSDKRawDataPipeDelegate>)listener;
    
- (ZMVideoSDKErrors)unSubscribe:(id<ZMVideoSDKRawDataPipeDelegate>)listener;

- (ZMVideoSDKRawDataType)getRawdataType;

- (ZMVideoSDKVideoStatus* _Nullable)getVideoStatus;

- (NSString* _Nullable)getVideoDeviceName;

- (ZMVideoSDKShareStatus)getShareStatus;

- (ZMVideoSDKShareCapturePauseReason)getShareCapturePauseReason;

- (ZMVideoSDKShareType)getShareType;

- (ZMVideoSDKVideoStatisticInfo* _Nullable)getVideoStatisticInfo;
@end

@interface ZMVideoSDKCameraControlRequestHandler : NSObject

- (ZMVideoSDKErrors)approve;

- (ZMVideoSDKErrors)decline;
@end

@interface ZMVideoSDKRemoteCameraControlHelper : NSObject

- (ZMVideoSDKErrors)requestControlRemoteCamera;

- (ZMVideoSDKErrors)giveUpControlRemoteCamera;

- (ZMVideoSDKErrors)turnLeft:(unsigned int)range;

- (ZMVideoSDKErrors)turnRight:(unsigned int)range;

- (ZMVideoSDKErrors)turnUp:(unsigned int)range;

- (ZMVideoSDKErrors)turnDown:(unsigned int)range;

- (ZMVideoSDKErrors)zoomIn:(unsigned int)range;

- (ZMVideoSDKErrors)zoomOut:(unsigned int)range;
@end
 

@interface ZMVideoSDKUser : NSObject
- (NSString* _Nullable)getUserID;

- (NSString* _Nullable)getCustomIdentity DEPRECATED_MSG_ATTRIBUTE("Use -getUserKey instead");

- (NSString* _Nullable)getUserKey;

- (NSString* _Nullable)getUserName;

- (NSString* _Nullable)getUserReference;

- (ZMVideoSDKAudioStatus* _Nullable)getAudioStatus;
    
- (BOOL)isHost;
    
- (BOOL)isManager;
    
- (ZMVideoSDKVideoStatisticInfo* _Nullable)getVideoStatisticInfo;
    
- (ZMVideoSDKShareStatisticInfo* _Nullable)getShareStatisticInfo;
    
- (ZMVideoSDKRawDataPipe* _Nullable)getVideoPipe;

- (ZMVideoSDKVideoCanvas * _Nullable)getVideoCanvas;

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

- (ZMVideoSDKRemoteCameraControlHelper * _Nullable)getRemoteCameraControlHelper;

- (NSArray<ZMVideoSDKRawDataPipe *>* _Nullable)getMultiCameraStreamList;

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

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

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

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

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

- (BOOL)canSetUserPlaybackVolume:(BOOL)isShareAudio;

- (unsigned int)getAudioLevel;

- (BOOL)hasIndividualRecordingConsent;

- (ZMVideoSDKErrors)transferFile:(NSString *)filePath;

- (BOOL)isVideoSpotLighted;

- (BOOL)isIncomingLiveStreamUser;

- (BOOL)isInSubSession;

- (BOOL)isInFailover;

- (ZMVideoSDKWhiteboardStatus)getWhiteboardStatus;

- (ZMVideoSDKNetworkStatus)getNetworkLevel:(ZMVideoSDKDataType)type;

- (ZMVideoSDKNetworkStatus)getOverallNetworkLevel;
@end

@interface ZMVideoSDKUserHelper: NSObject
    
- (BOOL)changeName:(NSString*)name user:(ZMVideoSDKUser*)user;
    
- (BOOL)makeHost:(ZMVideoSDKUser*)user;
    
- (BOOL)makeManager:(ZMVideoSDKUser*)user;
    
- (ZMVideoSDKErrors)revokeManager:(ZMVideoSDKUser*)user;
    
- (BOOL)removeUser:(ZMVideoSDKUser*)user;

- (BOOL)reclaimHost;
@end
 
NS_ASSUME_NONNULL_END