Video SDK for MacOS API Reference
Loading...
Searching...
No Matches
ZMVideoSDKSession.h
Go to the documentation of this file.
1
5
6
7#import <Foundation/Foundation.h>
8
9NS_ASSUME_NONNULL_BEGIN
10
11@class ZMVideoSDKUser;
12
17@interface ZMFileTransferProgress : NSObject
21@property(nonatomic, assign, readonly) unsigned int ratio;
25@property(nonatomic, assign, readonly) unsigned long long completeSize;
29@property(nonatomic, assign, readonly) unsigned int bitPreSecond;
30@end
31
32
37@interface ZMVideoSDKFileStatus : NSObject
41@property(nonatomic, assign, readonly) ZMVideoSDKFileTransferStatus transStatus;
45@property(nonatomic, retain, readonly) ZMFileTransferProgress *transProgress;
46@end
47
48
53@interface ZMVideoSDKSendFile : NSObject
57@property(nonatomic, assign, readonly) time_t timeStamp;
61@property(nonatomic, assign, readonly) BOOL isSendToAll;
65@property(nonatomic, assign, readonly) unsigned long long fileSize;
69@property(nonatomic, copy, readonly) NSString *fileName;
73@property(nonatomic, retain, readonly) ZMVideoSDKFileStatus *status;
77@property(nonatomic, assign, readonly) ZMVideoSDKUser * _Nullable receiver;
78
84@end
85
86
91@interface ZMVideoSDKReceiveFile : NSObject
95@property(nonatomic, assign, readonly) time_t timeStamp;
99@property(nonatomic, assign, readonly) BOOL isSendToAll;
103@property(nonatomic, assign, readonly) unsigned long long fileSize;
107@property(nonatomic, copy, readonly) NSString *fileName;
111@property(nonatomic, retain, readonly) ZMVideoSDKFileStatus *status;
115@property(nonatomic, assign, readonly) ZMVideoSDKUser * _Nullable sender;
116
122- (ZMVideoSDKErrors)startReceive:(NSString *)downloadPath;
128@end
129
130
136
140@property(nonatomic, assign, readonly) int sendFrequency;
141
145@property(nonatomic, assign, readonly) int sendLatency;
146
150@property(nonatomic, assign, readonly) int sendJitter;
151
155@property(nonatomic, assign, readonly) float sendPacketLossAvg;
156
160@property(nonatomic, assign, readonly) float sendPacketLossMax;
161
165@property(nonatomic, assign, readonly) int recvFrequency;
166
170@property(nonatomic, assign, readonly) int recvLatency;
171
175@property(nonatomic, assign, readonly) int recvJitter;
176
180@property(nonatomic, assign, readonly) float recvPacketLossAvg;
181
185@property(nonatomic, assign, readonly) float recvPacketLossMax;
186@end
187
193
197@property(nonatomic, assign, readonly) int sendFrameWidth;
198
202@property(nonatomic, assign, readonly) int sendFrameHeigh;
203
207@property(nonatomic, assign, readonly) int sendFps;
208
212@property(nonatomic, assign, readonly) int sendLatency;
213
217@property(nonatomic, assign, readonly) int sendJitte;
218
222@property(nonatomic, assign, readonly) float sendPacketLossAvg;
223
227@property(nonatomic, assign, readonly) float sendPacketLossMax;
228
232@property(nonatomic, assign, readonly) int recvFrameWidth;
233
237@property(nonatomic, assign, readonly) int recvFrameHeigh;
238
242@property(nonatomic, assign, readonly) int recvFps;
243
247@property(nonatomic, assign, readonly) int recvLatency;
248
252@property(nonatomic, assign, readonly) int recvJitte;
253
257@property(nonatomic, assign, readonly) float recvPacketLossAvg;
258
262@property(nonatomic, assign, readonly) float recvPacketLossMax;
263@end
264
269@interface ZMVideoSDKSession : NSObject
270
275- (unsigned long long)getSessionNumber;
276
281- (NSString* _Nullable)getSessionName;
282
287- (NSString* _Nullable)getSessionPassword;
288
293- (NSString* _Nullable)getSessionPhonePasscode;
294
300- (NSString* _Nullable)getSessionID;
301
306- (NSString* _Nullable)getSessionHostName;
307
313
318- (NSArray<ZMVideoSDKUser *>* _Nullable)getRemoteUsers;
319
325
331
337
343
349
355- (ZMVideoSDKErrors)transferFile:(NSString *)filePath;
356
361- (NSString * _Nullable)getTransferFileTypeWhiteList;
362
367- (unsigned long long)getMaxTransferFileSize;
368
374@end
375
376NS_ASSUME_NONNULL_END
ZMVideoSDKFileTransferStatus
Enumeration of file transfer status.
ZMVideoSDKErrors
Enumerates all errors in the VideoSDK.
ZMVideoSDKSessionType
Enumeration of session type.
Represents the progress details of a file transfer.
unsigned long long completeSize
The file's size transferred so far in bytes.
unsigned int bitPreSecond
The file transfer's speed in bits per second.
unsigned int ratio
The file transfer's completion ratio.
Represents a file transfer's status, including current state and progress.
ZMVideoSDKFileTransferStatus transStatus
The file transfer's status.
ZMFileTransferProgress * transProgress
The file transfer's progress.
Represents a file being received in the session.
ZMVideoSDKErrors cancelReceive()
Cancels receive the file.
unsigned long long fileSize
The file size of the file transfer.
BOOL isSendToAll
Determines whether the file transfer is send to all.
time_t timeStamp
The file transfer's timestamp.
NSString * fileName
The file name of the file transfer.
ZMVideoSDKFileStatus * status
The file transfer's status.
ZMVideoSDKUser *_Nullable sender
The file transfer's sender.
Represents a file being sent in the session.
time_t timeStamp
The file transfer's timestamp.
ZMVideoSDKFileStatus * status
The file transfer's status.
NSString * fileName
The file name of the file transfer.
unsigned long long fileSize
The file size of the file transfer.
BOOL isSendToAll
Determines whether the file transfer is send to all.
ZMVideoSDKErrors cancelSend()
Cancels the file transfer.
ZMVideoSDKUser *_Nullable receiver
The file transfer's receiver.
Provides video or share statistics such as resolution, FPS, latency, and packet loss.
int sendFrameWidth
Gets the frame width in pixels sent by the current user.
float sendPacketLossMax
Gets the maximum video packet loss sent by the current user.
float recvPacketLossMax
Gets the maximum video packet loss received by the current user.
float sendPacketLossAvg
Gets the average video packet loss sent by the current user.
int recvFrameWidth
Gets the frame width in pixels received by the current user.
float recvPacketLossAvg
Gets the video average packet loss received by the current user.
int sendFrameHeigh
Gets the frame height in pixels sent by the current user.
int sendLatency
Gets the video latency (delay in network data transfer) experienced by the current user while sending...
int sendFps
Gets the frame rate in FPS sent by the current user.
int recvJitte
Gets the video jitter (change in latency) experienced by the current user while receiving data.
int recvFrameHeigh
Gets the frame height in pixels received by the current user.
int recvFps
Gets the frame rate in FPS received by the current user.
int recvLatency
Gets the video latency (delay in network data transfer) experienced by the current user while receivi...
int sendJitte
Gets the video jitter (change in latency) experienced by the current user while sending data.
Provides audio statistics for the session such as latency, jitter, and packet loss.
int recvFrequency
Gets the frequency in kilohertz (KHz) received by the current user.
float sendPacketLossAvg
Gets the average audio packet loss sent by the current user.
int sendJitter
Gets the audio jitter (change in latency) experienced by the current user while sending data.
int sendFrequency
Gets the frequency in kilohertz (KHz) sent by the current user.
float recvPacketLossMax
Gets the maximum audio packet loss received by the current user.
int sendLatency
Gets the audio latency (delay in network data transfer) experienced by the current user while sending...
float recvPacketLossAvg
Gets the average audio packet loss received by the current user.
int recvLatency
Gets the audio latency (delay in network data transfer) experienced by the current user while receivi...
float sendPacketLossMax
Gets the maximum audio packet loss sent by the current user.
int recvJitter
Gets the audio jitter (change in latency) experienced by the current user while receiving data.
Provides access to session-level information and operations.
NSString *_Nullable getSessionName()
Gets the session's name.
ZMVideoSDKSessionType getSessionType()
Gets the session type of this session.
NSString *_Nullable getSessionHostName()
Gets the host's name.
NSString *_Nullable getSessionPassword()
Gets the session's password.
NSString *_Nullable getSessionPhonePasscode()
Gets the session's phone passcode.
NSString *_Nullable getSessionID()
Gets the session ID.
NSString *_Nullable getTransferFileTypeWhiteList()
Gets the list of allowed file types in transfer.
unsigned long long getSessionNumber()
Gets the current session number.
ZMVideoSDKUser *_Nullable getSessionHost()
Gets the session's host user object.
unsigned long long getMaxTransferFileSize()
Gets the maximum size for file transfer.
NSArray< ZMVideoSDKUser * > *_Nullable getRemoteUsers()
Gets a list of the session's remote users.
BOOL isFileTransferEnabled()
Determines whether file transfer is enabled.
ZMVideoSDKUser *_Nullable getMySelf()
The session's user object for myself.
ZMVideoSDKSessionAudioStatisticInfo *_Nullable getSessionAudioStatisticInfo()
Gets the session's audio statistic information.
ZMVideoSDKSessionASVStatisticInfo *_Nullable getSessionVideoStatisticInfo()
Gets the session's video statistic information.
ZMVideoSDKSessionASVStatisticInfo *_Nullable getSessionShareStatisticInfo()
Gets the session's screen share statistic information.
Zoom Video SDK user information.