Video SDK for MacOS API Reference
Loading...
Searching...
No Matches
ZMVideoSDKSession.h
Go to the documentation of this file.
1
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
83- (ZMVideoSDKErrors)cancelSend;
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;
127- (ZMVideoSDKErrors)cancelReceive;
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
312- (ZMVideoSDKUser* _Nullable)getSessionHost;
313
318- (NSArray<ZMVideoSDKUser *>* _Nullable)getRemoteUsers;
319
324- (ZMVideoSDKUser* _Nullable)getMySelf;
325
330- (ZMVideoSDKSessionAudioStatisticInfo* _Nullable)getSessionAudioStatisticInfo;
331
336- (ZMVideoSDKSessionASVStatisticInfo* _Nullable)getSessionVideoStatisticInfo;
337
342- (ZMVideoSDKSessionASVStatisticInfo* _Nullable)getSessionShareStatisticInfo;
343
348- (BOOL)isFileTransferEnabled;
349
355- (ZMVideoSDKErrors)transferFile:(NSString *)filePath;
356
361- (NSString * _Nullable)getTransferFileTypeWhiteList;
362
367- (unsigned long long)getMaxTransferFileSize;
368
373- (ZMVideoSDKSessionType)getSessionType;
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 size of the file transferred so far in bytes.
unsigned int bitPreSecond
The speed of the file transfer in bits per second.
unsigned int ratio
The ratio of the file transfer completed.
Represents the status of a file transfer, including current state and progress.
Represents a file being received in the session.
Represents a file being sent in the session.
Provides video/share statistics such as resolution, FPS, latency, and packet loss.
Provides audio statistics for the session such as latency, jitter, and packet loss.
Provides access to session-level information and operations.
Zoom Video SDK user information.