Video SDK for iOS API Reference
All Classes Files Functions Enumerations Enumerator Properties
ZoomVideoSDKUser.h
Go to the documentation of this file.
1//
2// ZoomVideoSDKUserInfo.h
3// ZoomVideoSDK
4//
5// Created by Zoom Video Communications on 2018/12/7.
6// Copyright © Zoom Video Communications, Inc. All rights reserved.
7//
8
9#import <Foundation/Foundation.h>
10#import <ZoomVideoSDK/ZoomVideoSDKRawDataPipe.h>
11#import <ZoomVideoSDK/ZoomVideoSDKVideoCanvas.h>
12#import <ZoomVideoSDK/ZoomVideoSDKRemoteCameraControlHelper.h>
13#import <ZoomVideoSDK/ZoomVideoSDKShareHelper.h>
14
19@interface ZoomVideoSDKVideoStatisticInfo : NSObject
23@property (nonatomic, assign) NSInteger width;
27@property (nonatomic, assign) NSInteger height;
31@property (nonatomic, assign) NSInteger fps;
35@property (nonatomic, assign) NSInteger bps;
39@property (nonatomic, assign) ZoomVideoSDKNetworkStatus videoNetworkStatus;
40@end
41
46@interface ZoomVideoSDKShareStatisticInfo : NSObject
50@property (nonatomic, assign) NSInteger width;
54@property (nonatomic, assign) NSInteger height;
58@property (nonatomic, assign) NSInteger fps;
62@property (nonatomic, assign) NSInteger bps;
63
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
94- (NSInteger)getUserID;
98- (NSString *_Nullable)getUserName;
102- (NSString *_Nullable)getCustomUserId;
106- (NSString *_Nullable)getUserReference;
110- (BOOL)isHost;
114- (BOOL)isManager;
118- (BOOL)isIndividualRecordAgreed;
122- (BOOL)isVideoSpotLighted;
126- (ZoomVideoSDKAudioStatus *_Nullable)audioStatus;
130- (ZoomVideoSDKVideoStatisticInfo *_Nullable)getVideoStatisticInfo;
134- (ZoomVideoSDKShareStatisticInfo *_Nullable)getShareStatisticInfo;
138- (ZoomVideoSDKRawDataPipe *_Nullable)getVideoPipe;
143- (NSArray <ZoomVideoSDKRawDataPipe *> *_Nullable)getMultiCameraStreamList;
144
148- (ZoomVideoSDKVideoCanvas *_Nullable)getVideoCanvas;
153- (NSArray <ZoomVideoSDKVideoCanvas *> *_Nullable)getMultiCameraCanvasList;
154
159- (ZoomVideoSDKRemoteCameraControlHelper *_Nullable)getRemoteCameraControlHelper;
160
165- (NSArray <ZoomVideoSDKShareAction *>*_Nullable)getShareActionList;
166
173- (BOOL)setUserVolume:(float)volume isShareAudio:(BOOL)isSharingAudio;
174
181- (BOOL)getUserVolume:(float * _Nullable)volume isShareAudio:(BOOL)isSharingAudio;
182
188- (BOOL)canSetUserVolume:(BOOL)isSharingAudio;
189
196- (ZoomVideoSDKError)transferFile:(NSString * _Nullable)filePath;
197
202- (BOOL)isIncomingLiveStreamUser;
203
204@end
ZoomVideoSDKAudioType
ZoomVideoSDKAudioType An enumeration of audio type.
ZoomVideoSDKError
ZoomVideoSDKError An enumeration of error.
ZoomVideoSDKNetworkStatus
Type of video network status.
Audio status of user.
A Class to manage the subscription and unsubscription of video or share raw data.
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
ZoomVideoSDKNetworkStatus videoNetworkStatus
Get video network status.
NSInteger bps
bits per second