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;
106- (NSString *_Nullable)getCustomUserId DEPRECATED_MSG_ATTRIBUTE("Use -getUserKey instead");
111- (NSString *_Nullable)getUserKey;
116- (NSString *_Nullable)getUserReference;
121- (BOOL)isHost;
126- (BOOL)isManager;
131- (BOOL)isIndividualRecordAgreed;
136- (BOOL)isVideoSpotLighted;
141- (ZoomVideoSDKAudioStatus *_Nullable)audioStatus;
146- (ZoomVideoSDKVideoStatisticInfo *_Nullable)getVideoStatisticInfo;
151- (ZoomVideoSDKShareStatisticInfo *_Nullable)getShareStatisticInfo;
156- (ZoomVideoSDKRawDataPipe *_Nullable)getVideoPipe;
161- (NSArray <ZoomVideoSDKRawDataPipe *> *_Nullable)getMultiCameraStreamList;
162
167- (ZoomVideoSDKVideoCanvas *_Nullable)getVideoCanvas;
172- (NSArray <ZoomVideoSDKVideoCanvas *> *_Nullable)getMultiCameraCanvasList;
173
178- (ZoomVideoSDKRemoteCameraControlHelper *_Nullable)getRemoteCameraControlHelper;
179
184- (NSArray <ZoomVideoSDKShareAction *>*_Nullable)getShareActionList;
185
193- (BOOL)setUserVolume:(float)volume isShareAudio:(BOOL)isSharingAudio DEPRECATED_MSG_ATTRIBUTE("Use -setUserPlaybackVolume:isSharingAudio: instead");
194
202- (BOOL)getUserVolume:(float * _Nullable)volume isShareAudio:(BOOL)isSharingAudio DEPRECATED_MSG_ATTRIBUTE("Use -getUserPlaybackVolume:isSharingAudio: instead");
203
210- (BOOL)canSetUserVolume:(BOOL)isSharingAudio DEPRECATED_MSG_ATTRIBUTE("Use -canSetUserPlaybackVolume: instead");
211
218- (BOOL)setUserPlaybackVolume:(float)volume isSharingAudio:(BOOL)isSharingAudio;
219
226- (BOOL)getUserPlaybackVolume:(float * _Nullable)volume isSharingAudio:(BOOL)isSharingAudio;
227
233- (BOOL)canSetUserPlaybackVolume:(BOOL)isShareAudio;
234
239- (unsigned int)getAudioLevel;
240
247- (ZoomVideoSDKError)transferFile:(NSString * _Nullable)filePath;
248
253- (BOOL)isIncomingLiveStreamUser;
254
259- (ZoomVideoSDKWhiteboardStatus)getWhiteboardStatus;
260
265- (BOOL)isInSubSession;
266
272- (ZoomVideoSDKNetworkStatus)getNetworkLevel:(ZoomVideoSDKDataType)type;
273
278- (ZoomVideoSDKNetworkStatus)getOverallNetworkLevel;
279@end
ZoomVideoSDKDataType
Enumeration of data types for network quality monitoring.
ZoomVideoSDKWhiteboardStatus
Enumeration of the status of the whiteboard sharing.
ZoomVideoSDKAudioType
Enumeration of audio types.
ZoomVideoSDKError
Enumeration of all the errors in the VideoSDK.
ZoomVideoSDKNetworkStatus
Enumeration of 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 width
Gets the frame width.
NSInteger fps
Gets the frame per second.
NSInteger height
Gets the frame height.
ZoomVideoSDKNetworkStatus videoNetworkStatus
Gets the video network status.
NSInteger bps
Gets the bits per second.