Video SDK for iOS API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKUser.h
Go to the documentation of this file.
1
6#import <Foundation/Foundation.h>
7#import <ZoomVideoSDK/ZoomVideoSDKRawDataPipe.h>
8#import <ZoomVideoSDK/ZoomVideoSDKVideoCanvas.h>
9#import <ZoomVideoSDK/ZoomVideoSDKRemoteCameraControlHelper.h>
10#import <ZoomVideoSDK/ZoomVideoSDKShareHelper.h>
11
16@interface ZoomVideoSDKVideoStatisticInfo : NSObject
20@property (nonatomic, assign) NSInteger width;
24@property (nonatomic, assign) NSInteger height;
28@property (nonatomic, assign) NSInteger fps;
32@property (nonatomic, assign) NSInteger bps;
36@property (nonatomic, assign) ZoomVideoSDKNetworkStatus videoNetworkStatus;
37@end
38
43@interface ZoomVideoSDKShareStatisticInfo : NSObject
47@property (nonatomic, assign) NSInteger width;
51@property (nonatomic, assign) NSInteger height;
55@property (nonatomic, assign) NSInteger fps;
59@property (nonatomic, assign) NSInteger bps;
63@property (nonatomic, assign) ZoomVideoSDKNetworkStatus shareNetworkStatus;
64@end
65
70@interface ZoomVideoSDKAudioStatus : NSObject
74@property (nonatomic, assign) BOOL isMuted;
78@property (nonatomic, assign) BOOL talking;
82@property (nonatomic, assign) ZoomVideoSDKAudioType audioType;
83
84@end
85
90@interface ZoomVideoSDKUser : NSObject
95- (NSInteger)getUserID;
100- (NSString *_Nullable)getUserName;
105- (NSString *_Nullable)getCustomUserId;
110- (NSString *_Nullable)getUserReference;
115- (BOOL)isHost;
120- (BOOL)isManager;
125- (BOOL)isIndividualRecordAgreed;
130- (BOOL)isVideoSpotLighted;
135- (ZoomVideoSDKAudioStatus *_Nullable)audioStatus;
140- (ZoomVideoSDKVideoStatisticInfo *_Nullable)getVideoStatisticInfo;
145- (ZoomVideoSDKShareStatisticInfo *_Nullable)getShareStatisticInfo;
150- (ZoomVideoSDKRawDataPipe *_Nullable)getVideoPipe;
155- (NSArray <ZoomVideoSDKRawDataPipe *> *_Nullable)getMultiCameraStreamList;
156
161- (ZoomVideoSDKVideoCanvas *_Nullable)getVideoCanvas;
166- (NSArray <ZoomVideoSDKVideoCanvas *> *_Nullable)getMultiCameraCanvasList;
167
172- (ZoomVideoSDKRemoteCameraControlHelper *_Nullable)getRemoteCameraControlHelper;
173
178- (NSArray <ZoomVideoSDKShareAction *>*_Nullable)getShareActionList;
179
187- (BOOL)setUserVolume:(float)volume isShareAudio:(BOOL)isSharingAudio DEPRECATED_MSG_ATTRIBUTE("Use -setUserPlaybackVolume:isSharingAudio: instead");
188
196- (BOOL)getUserVolume:(float * _Nullable)volume isShareAudio:(BOOL)isSharingAudio DEPRECATED_MSG_ATTRIBUTE("Use -getUserPlaybackVolume:isSharingAudio: instead");
197
204- (BOOL)canSetUserVolume:(BOOL)isSharingAudio DEPRECATED_MSG_ATTRIBUTE("Use -canSetUserPlaybackVolume: instead");
205
212- (BOOL)setUserPlaybackVolume:(float)volume isSharingAudio:(BOOL)isSharingAudio;
213
220- (BOOL)getUserPlaybackVolume:(float * _Nullable)volume isSharingAudio:(BOOL)isSharingAudio;
221
227- (BOOL)canSetUserPlaybackVolume:(BOOL)isShareAudio;
228
233- (unsigned int)getAudioLevel;
234
241- (ZoomVideoSDKError)transferFile:(NSString * _Nullable)filePath;
242
247- (BOOL)isIncomingLiveStreamUser;
252- (ZoomVideoSDKWhiteboardStatus)getWhiteboardStatus;
257- (BOOL)isInSubSession;
263- (ZoomVideoSDKNetworkStatus)getNetworkLevel:(ZoomVideoSDKDataType)type;
268- (ZoomVideoSDKNetworkStatus)getOverallNetworkLevel;
269@end
ZoomVideoSDKDataType
Enumerates the data type for network quality monitoring.
ZoomVideoSDKWhiteboardStatus
Enumeration of the status of whiteboard sharing.
ZoomVideoSDKAudioType
Enumerates the types of audio.
ZoomVideoSDKError
Enumerates all errors in the VideoSDK.
ZoomVideoSDKNetworkStatus
Enumerates the network statuses.
Audio status of user.
A Class to manage the subscription and unsubscription of video or share raw data.
Remote camera control helper object interface.
Share raw data pipe interface.
Share statistic information.
Zoom Video SDK user information.
The video canvas is the display area of the video streams on the user’s local device....
Video statistic information.
NSInteger fps
frame per second.
NSInteger height
frame height.
ZoomVideoSDKNetworkStatus videoNetworkStatus
Get video network status.
NSInteger bps
bits per second.