ZMVideoSDKSession Class Reference

Provides access to session-level information and operations. More...

#include <ZMVideoSDKSession.h>

Inherits NSObject.

Instance Methods
(unsigned long long)	- getSessionNumber
	Get the current session number.
(NSString *_Nullable)	- getSessionName
	Get the session's name.
(NSString *_Nullable)	- getSessionPassword
	Get the session's password.
(NSString *_Nullable)	- getSessionPhonePasscode
	Get the session's password.
(NSString *_Nullable)	- getSessionID
	Get the session Id.
(NSString *_Nullable)	- getSessionHostName
	Get the host's name.
(ZMVideoSDKUser *_Nullable)	- getSessionHost
	Get the session's host user object.
(NSArray< ZMVideoSDKUser * > *_Nullable)	- getRemoteUsers
	Get a list of the session's remote users.
(ZMVideoSDKUser *_Nullable)	- getMySelf
	The session's user object for myself.
(ZMVideoSDKSessionAudioStatisticInfo *_Nullable)	- getSessionAudioStatisticInfo
	Get the session's audio statistic information.
(ZMVideoSDKSessionASVStatisticInfo *_Nullable)	- getSessionVideoStatisticInfo
	Get the session's video statistic information.
(ZMVideoSDKSessionASVStatisticInfo *_Nullable)	- getSessionShareStatisticInfo
	Get the session's screen share statistic information.
(BOOL)	- isFileTransferEnabled
	Determine whether file transfer is enabled.
(ZMVideoSDKErrors)	- 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.
(ZMVideoSDKSessionType)	- getSessionType
	Get the session type of this session.

Detailed Description

Provides access to session-level information and operations.

Definition at line 269 of file ZMVideoSDKSession.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

- (ZMVideoSDKUser *_Nullable) getMySelf

The session's user object for myself.

Returns

If the function succeeds, the return value is myself object. Otherwise returns nil.

getRemoteUsers

- (NSArray< ZMVideoSDKUser * > *_Nullable) getRemoteUsers

Get a list of the session's remote users.

Returns

If the function succeeds, the return value is remote users list. Otherwise returns nil.

getSessionAudioStatisticInfo

- (ZMVideoSDKSessionAudioStatisticInfo *_Nullable) getSessionAudioStatisticInfo

Get the session's audio statistic information.

Returns

If the function succeeds, it will return a session audio statistic infomation object, otherwise returns nil.

getSessionHost

- (ZMVideoSDKUser *_Nullable) getSessionHost

Get the session's host user object.

Returns

If the function succeeds, the return value is host user object. Otherwise return nil.

getSessionHostName

- (NSString *_Nullable) getSessionHostName

Get the host's name.

Returns

The value is session host name.

getSessionID

- (NSString *_Nullable) getSessionID

Get the session Id.

Returns

The value is session ID.

Note

: Only the host can get the session Id.

getSessionName

- (NSString *_Nullable) getSessionName

Get the session's name.

Returns

The value is session name.

getSessionNumber

- (unsigned long long) getSessionNumber

Get the current session number.

Returns

If the function succeeds, the return value is the current meeting number. Otherwise returns ZERO(0).

getSessionPassword

- (NSString *_Nullable) getSessionPassword

Get the session's password.

Returns

The value is session password.

getSessionPhonePasscode

- (NSString *_Nullable) getSessionPhonePasscode

Get the session's password.

Returns

The value is session password.

getSessionShareStatisticInfo

- (ZMVideoSDKSessionASVStatisticInfo *_Nullable) getSessionShareStatisticInfo

Get the session's screen share statistic information.

Returns

If the function succeeds, it will return a session share statistic information object, otherwise returns nil.

getSessionType

- (ZMVideoSDKSessionType) getSessionType

Get the session type of this session.

Returns

The session type.

getSessionVideoStatisticInfo

- (ZMVideoSDKSessionASVStatisticInfo *_Nullable) getSessionVideoStatisticInfo

Get the session's video statistic information.

Returns

If the function succeeds, it will return a session video statistic information object, otherwise returns nil.

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.

isFileTransferEnabled

- (BOOL) isFileTransferEnabled

Determine whether file transfer is enabled.

Returns

YES if file transfer is enabled, otherwise NO.

transferFile:

- (ZMVideoSDKErrors) transferFile:

(NSString *)

filePath

Send file to all users in current session.

Parameters

filePath

The local path of the file.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.