ZoomVideoSDKSession Class Reference

Zoom Video SDK session. More...

#include <ZoomVideoSDKSession.h>

Inherits NSObject.

Instance Methods
(NSString *_Nullable)	- getSessionName
	Get the session's name.
(NSString *_Nullable)	- getSessionID
	Get the session Id.
(unsigned long long)	- getSessionNumber
	Get the session number.
(NSString *_Nullable)	- getSessionPassword
	Get the session's password.
(NSString *_Nullable)	- getSessionPhonePasscode
	Get the session phone passcode.
(NSString *_Nullable)	- getSessionHostName
	Get the host's name.
(ZoomVideoSDKUser *_Nullable)	- getSessionHost
	Get the session's host user object.
(NSArray< ZoomVideoSDKUser * > *_Nullable)	- getRemoteUsers
	Get a list of the session's remote users.
(ZoomVideoSDKUser *_Nullable)	- getMySelf
	Get the session's user object for myself.
(ZoomVideoSDKSessionAudioStatisticInfo *_Nullable)	- getSessionAudioStatisticInfo
	Get the session's audio statistic information.
(ZoomVideoSDKSessionASVStatisticInfo *_Nullable)	- getSessionVideoStatisticInfo
	Get the session's video statistic information.
(ZoomVideoSDKSessionASVStatisticInfo *_Nullable)	- getSessionShareStatisticInfo
	Get the session's screen share statistic information.
(BOOL)	- isFileTransferEnable
	Determine whether file transfer is enabled.
(ZoomVideoSDKError)	- transferFile:
	Send file to all users in current session.
(NSString *_Nullable)	- getTransferFileTypeWhiteList
	Get the list of allowed file types in transfer.
(unsigned long long)	- getMaxTransferFileSize
	Get the maximum size for file transfer.

Detailed Description

Zoom Video SDK session.

Definition at line 76 of file ZoomVideoSDKSession.h.

Method Documentation

getMaxTransferFileSize

- (unsigned long long) getMaxTransferFileSize

Get the maximum size for file transfer.

Returns

The maximum number of bytes for file transfer.

getMySelf

- (ZoomVideoSDKUser *_Nullable) getMySelf

Get the session's user object for myself.

getRemoteUsers

- (NSArray< ZoomVideoSDKUser * > *_Nullable) getRemoteUsers

Get a list of the session's remote users.

getSessionAudioStatisticInfo

- (ZoomVideoSDKSessionAudioStatisticInfo *_Nullable) getSessionAudioStatisticInfo

Get the session's audio statistic information.

getSessionHost

- (ZoomVideoSDKUser *_Nullable) getSessionHost

Get the session's host user object.

getSessionHostName

- (NSString *_Nullable) getSessionHostName

Get the host's name.

getSessionID

- (NSString *_Nullable) getSessionID

Get the session Id.

Warning

Only the host can get the session Id.

getSessionName

- (NSString *_Nullable) getSessionName

Get the session's name.

getSessionNumber

- (unsigned long long) getSessionNumber

Get the session number.

Warning

get the session number

getSessionPassword

- (NSString *_Nullable) getSessionPassword

Get the session's password.

getSessionPhonePasscode

- (NSString *_Nullable) getSessionPhonePasscode

Get the session phone passcode.

Warning

get the session phone passcode

getSessionShareStatisticInfo

- (ZoomVideoSDKSessionASVStatisticInfo *_Nullable) getSessionShareStatisticInfo

Get the session's screen share statistic information.

getSessionVideoStatisticInfo

- (ZoomVideoSDKSessionASVStatisticInfo *_Nullable) getSessionVideoStatisticInfo

Get the session's video statistic information.

getTransferFileTypeWhiteList

- (NSString *_Nullable) getTransferFileTypeWhiteList

Get the list of allowed file types in transfer.

Returns

The value of allowed file types in transfer, comma-separated if there are multiple values. Exe files are by default forbidden from being transferred.

isFileTransferEnable

- (BOOL) isFileTransferEnable

Determine whether file transfer is enabled.

Returns

True if file transfer is enabled, otherwise false.

transferFile:

- (ZoomVideoSDKError) transferFile:

(NSString *_Nullable)

filePath

Send file to all users in current session.

Parameters

filePath

The local path of the file

Returns

If the function succeeds, the return value is Errors_Success.

Warning

this interface will related with chat privilege seeZoomVideoSDKChatPrivilegeType}.