Video SDK for iOS API Reference
Loading...
Searching...
No Matches
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;
66@property (nonatomic, assign) ZoomVideoSDKNetworkStatus shareNetworkStatus;
67@end
68
73@interface ZoomVideoSDKAudioStatus : NSObject
77@property (nonatomic, assign) BOOL isMuted;
81@property (nonatomic, assign) BOOL talking;
85@property (nonatomic, assign) ZoomVideoSDKAudioType audioType;
86
87@end
88
93@interface ZoomVideoSDKUser : NSObject
97- (NSInteger)getUserID;
101- (NSString *_Nullable)getUserName;
105- (NSString *_Nullable)getCustomUserId;
109- (NSString *_Nullable)getUserReference;
113- (BOOL)isHost;
117- (BOOL)isManager;
121- (BOOL)isIndividualRecordAgreed;
125- (BOOL)isVideoSpotLighted;
129- (ZoomVideoSDKAudioStatus *_Nullable)audioStatus;
133- (ZoomVideoSDKVideoStatisticInfo *_Nullable)getVideoStatisticInfo;
137- (ZoomVideoSDKShareStatisticInfo *_Nullable)getShareStatisticInfo;
141- (ZoomVideoSDKRawDataPipe *_Nullable)getVideoPipe;
146- (NSArray <ZoomVideoSDKRawDataPipe *> *_Nullable)getMultiCameraStreamList;
147
151- (ZoomVideoSDKVideoCanvas *_Nullable)getVideoCanvas;
156- (NSArray <ZoomVideoSDKVideoCanvas *> *_Nullable)getMultiCameraCanvasList;
157
162- (ZoomVideoSDKRemoteCameraControlHelper *_Nullable)getRemoteCameraControlHelper;
163
168- (NSArray <ZoomVideoSDKShareAction *>*_Nullable)getShareActionList;
169
176- (BOOL)setUserVolume:(float)volume isShareAudio:(BOOL)isSharingAudio;
177
184- (BOOL)getUserVolume:(float * _Nullable)volume isShareAudio:(BOOL)isSharingAudio;
185
191- (BOOL)canSetUserVolume:(BOOL)isSharingAudio;
192
199- (ZoomVideoSDKError)transferFile:(NSString * _Nullable)filePath;
200
205- (BOOL)isIncomingLiveStreamUser;
210-(BOOL)isInSubSession;
211@end
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.