Video SDK for iOS API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKSession.h
Go to the documentation of this file.
1
5
6#import <Foundation/Foundation.h>
7#import <ZoomVideoSDK/ZoomVideoSDKUser.h>
8
9#pragma mark - Statistic Information -
18@property(nonatomic, assign, readonly) NSInteger sendFrequency;
22@property(nonatomic, assign, readonly) NSInteger sendLatency;
26@property(nonatomic, assign, readonly) NSInteger sendJitter;
30@property(nonatomic, assign, readonly) CGFloat sendPacketLossAvg;
34@property(nonatomic, assign, readonly) CGFloat sendPacketLossMax;
38@property(nonatomic, assign, readonly) NSInteger recvFrequency;
42@property(nonatomic, assign, readonly) NSInteger recvLatency;
46@property(nonatomic, assign, readonly) NSInteger recvJitter;
50@property(nonatomic, assign, readonly) CGFloat recvPacketLossAvg;
54@property(nonatomic, assign, readonly) CGFloat recvPacketLossMax;
55
56@end
57
66@property(nonatomic, assign, readonly) NSInteger sendFrameWidth;
70@property(nonatomic, assign, readonly) NSInteger sendFrameHeight;
74@property(nonatomic, assign, readonly) NSInteger sendFps;
78@property(nonatomic, assign, readonly) NSInteger sendLatency;
82@property(nonatomic, assign, readonly) NSInteger sendJitter;
86@property(nonatomic, assign, readonly) CGFloat sendPacketLossAvg;
90@property(nonatomic, assign, readonly) CGFloat sendPacketLossMax;
94@property(nonatomic, assign, readonly) NSInteger recvFrameWidth;
98@property(nonatomic, assign, readonly) NSInteger recvFrameHeight;
102@property(nonatomic, assign, readonly) NSInteger recvFps;
106@property(nonatomic, assign, readonly) NSInteger recvLatency;
110@property(nonatomic, assign, readonly) NSInteger recvJitter;
114@property(nonatomic, assign, readonly) CGFloat recvPacketLossAvg;
118@property(nonatomic, assign, readonly) CGFloat recvPacketLossMax;
119@end
120
121
122#pragma mark - ZoomVideoSDKSession -
127@interface ZoomVideoSDKSession : NSObject
128
133- (NSString * _Nullable)getSessionName;
134
140- (NSString * _Nullable)getSessionID;
141
146- (unsigned long long)getSessionNumber;
147
152- (NSString * _Nullable)getSessionPassword;
153
158- (NSString * _Nullable)getSessionPhonePasscode;
159
164- (NSString * _Nullable)getSessionHostName;
165
171
176- (NSArray <ZoomVideoSDKUser *>* _Nullable)getRemoteUsers;
177
183
189
195
201
202#pragma mark - file transfer -
203
209
216- (ZoomVideoSDKError)transferFile:(NSString * _Nullable)filePath;
217
222- (NSString *_Nullable)getTransferFileTypeWhiteList;
223
228- (unsigned long long)getMaxTransferFileSize;
229
235
236@end
ZoomVideoSDKSessionType
Enumeration of the session type.
ZoomVideoSDKError
Enumeration of all the errors in the VideoSDK.
The Session video or share statistic information.
NSInteger sendJitter
The video jitter (change in latency) experienced by the current user while sending data.
NSInteger recvLatency
The video latency (delay in network data transfer) experienced by the current user while receiving da...
NSInteger recvFrameHeight
The frame height in pixels received by the current user.
NSInteger sendFrameWidth
The frame width in pixels sent by the current user.
NSInteger sendLatency
The video latency (delay in network data transfer) experienced by the current user while sending data...
NSInteger recvJitter
The video jitter (change in latency) experienced by the current user while receiving data.
NSInteger recvFrameWidth
The frame width in pixels received by the current user.
NSInteger recvFps
The frame rate in FPS received by the current user.
NSInteger sendFps
The frame rate in FPS sent by the current user.
NSInteger sendFrameHeight
The frame height in pixels sent by the current user.
CGFloat recvPacketLossMax
The maximum video packet loss received by the current user.
CGFloat recvPacketLossAvg
The video average packet loss received by the current user.
CGFloat sendPacketLossMax
The maximum video packet loss sent by the current user.
CGFloat sendPacketLossAvg
The average video packet loss sent by the current user.
Session audio statistic information.
CGFloat recvPacketLossAvg
The average audio packet loss received by the current user.
NSInteger recvFrequency
The frequency in kilohertz (KHz) received by the current user.
NSInteger sendFrequency
The frequency in kilohertz (KHz) sent by the current user.
NSInteger sendLatency
The audio latency (delay in network data transfer) experienced by the current user while sending data...
CGFloat sendPacketLossAvg
The average audio packet loss sent by the current user.
NSInteger recvLatency
The audio latency (delay in network data transfer) experienced by the current user while receiving da...
NSInteger sendJitter
The audio jitter (change in latency) experienced by the current user while sending data.
CGFloat sendPacketLossMax
The maximum audio packet loss sent by the current user.
NSInteger recvJitter
The audio jitter (change in latency) experienced by the current user while receiving data.
CGFloat recvPacketLossMax
The maximum audio packet loss received by the current user.
Zoom Video SDK session.
ZoomVideoSDKSessionASVStatisticInfo *_Nullable getSessionVideoStatisticInfo()
Gets the session's video statistic information.
NSString *_Nullable getSessionHostName()
Gets the host's name.
NSString *_Nullable getTransferFileTypeWhiteList()
Gets the list of allowed file types in transfer.
NSString *_Nullable getSessionID()
Gets the session ID.
ZoomVideoSDKSessionType getSessionType()
Gets the session type of this session.
ZoomVideoSDKUser *_Nullable getMySelf()
Gets the session's user object for myself.
unsigned long long getSessionNumber()
Gets the session number.
NSArray< ZoomVideoSDKUser * > *_Nullable getRemoteUsers()
Gets a list of the session's remote users.
unsigned long long getMaxTransferFileSize()
Gets the maximum size for file transfer.
NSString *_Nullable getSessionPassword()
Gets the session's password.
NSString *_Nullable getSessionName()
Gets the session's name.
ZoomVideoSDKUser *_Nullable getSessionHost()
Gets the session's host user object.
NSString *_Nullable getSessionPhonePasscode()
Gets the session phone passcode.
BOOL isFileTransferEnable()
Determines whether file transfer is enabled.
ZoomVideoSDKSessionASVStatisticInfo *_Nullable getSessionShareStatisticInfo()
Gets the session's screen share statistic information.
ZoomVideoSDKSessionAudioStatisticInfo *_Nullable getSessionAudioStatisticInfo()
Gets the session's audio statistic information.
Zoom Video SDK user information.