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

#include <ZMVideoSDKSession.h>

Inherits NSObject.

Instance Methods
(unsigned long long)	- getSessionNumber
	Gets the current session number.
(NSString *_Nullable)	- getSessionName
	Gets the session'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)	- getSessionHostName
	Gets the host's name.
(ZMVideoSDKUser *_Nullable)	- getSessionHost
	Gets the session's host user object.
(NSArray< ZMVideoSDKUser * > *_Nullable)	- getRemoteUsers
	Gets a list of the session's remote users.
(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.
(BOOL)	- isFileTransferEnabled
	Determines whether file transfer is enabled.
(ZMVideoSDKErrors)	- transferFile:
	Sends file to all users in current session.
(NSString *_Nullable)	- getTransferFileTypeWhiteList
	Gets the list of allowed file types in transfer.
(unsigned long long)	- getMaxTransferFileSize
	Gets the maximum size for file transfer.
(ZMVideoSDKSessionType)	- getSessionType
	Gets 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

Gets the maximum size for file transfer.

Returns: The maximum number of bytes for file transfer.

References getMaxTransferFileSize.

Referenced by getMaxTransferFileSize.

◆ getMySelf

- (ZMVideoSDKUser *_Nullable) getMySelf

The session's user object for myself.

Returns: If the function succeeds, it returns myself object. Otherwise, this function fails and returns nil.

References getMySelf.

Referenced by getMySelf.

◆ getRemoteUsers

- (NSArray< ZMVideoSDKUser * > *_Nullable) getRemoteUsers

Gets a list of the session's remote users.

Returns: If the function succeeds, it returns remote users list. Otherwise, this function fails and returns nil.

References getRemoteUsers.

Referenced by getRemoteUsers.

◆ getSessionAudioStatisticInfo

- (ZMVideoSDKSessionAudioStatisticInfo *_Nullable) getSessionAudioStatisticInfo

Gets the session's audio statistic information.

Returns: If the function succeeds, it returns a session audio statistic information object. Otherwise, this function fails and returns nil.

References getSessionAudioStatisticInfo.

Referenced by getSessionAudioStatisticInfo.

◆ getSessionHost

- (ZMVideoSDKUser *_Nullable) getSessionHost

Gets the session's host user object.

Returns: If the function succeeds, it returns host user object. Otherwise, this function fails and returns nil.

References getSessionHost.

Referenced by getSessionHost.

◆ getSessionHostName

- (NSString *_Nullable) getSessionHostName

Gets the host's name.

Returns: The session host name. Otherwise, this function fails and returns nil.

References getSessionHostName.

Referenced by getSessionHostName.

◆ getSessionID

- (NSString *_Nullable) getSessionID

Gets the session ID.

Returns: The session ID. Otherwise, this function fails and returns nil.

Note: Only the host can get the session ID.

References getSessionID.

Referenced by getSessionID.

◆ getSessionName

- (NSString *_Nullable) getSessionName

Gets the session's name.

Returns: The session name. Otherwise, this function fails and returns nil.

References getSessionName.

Referenced by getSessionName.

◆ getSessionNumber

- (unsigned long long) getSessionNumber

Gets the current session number.

Returns: If the function succeeds, it returns the current meeting number. Otherwise returns 0.

References getSessionNumber.

Referenced by getSessionNumber.

◆ getSessionPassword

- (NSString *_Nullable) getSessionPassword

Gets the session's password.

Returns: The session password. Otherwise, this function fails and returns nil.

References getSessionPassword.

Referenced by getSessionPassword.

◆ getSessionPhonePasscode

- (NSString *_Nullable) getSessionPhonePasscode

Gets the session's phone passcode.

Returns: The session phone passcode. Otherwise, this function fails and returns nil.

References getSessionPhonePasscode.

Referenced by getSessionPhonePasscode.

◆ getSessionShareStatisticInfo

- (ZMVideoSDKSessionASVStatisticInfo *_Nullable) getSessionShareStatisticInfo

Gets the session's screen share statistic information.

Returns: If the function succeeds, it returns a session share statistic information object. Otherwise, this function fails and returns nil.

References getSessionShareStatisticInfo.

Referenced by getSessionShareStatisticInfo.

◆ getSessionType

- (ZMVideoSDKSessionType) getSessionType

Gets the session type of this session.

Returns: The session type.

References getSessionType.

Referenced by getSessionType.

◆ getSessionVideoStatisticInfo

- (ZMVideoSDKSessionASVStatisticInfo *_Nullable) getSessionVideoStatisticInfo

Gets the session's video statistic information.

Returns: If the function succeeds, it returns a session video statistic information object. Otherwise, this function fails and returns nil.

References getSessionVideoStatisticInfo.

Referenced by getSessionVideoStatisticInfo.

◆ getTransferFileTypeWhiteList

- (NSString *_Nullable) getTransferFileTypeWhiteList

Gets 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. Otherwise, this function fails and returns nil.

References getTransferFileTypeWhiteList.

Referenced by getTransferFileTypeWhiteList.

◆ isFileTransferEnabled

- (BOOL) isFileTransferEnabled

Determines whether file transfer is enabled.

Returns: YES if file transfer is enabled. Otherwise, NO.

References isFileTransferEnabled.

Referenced by isFileTransferEnabled.

◆ transferFile:

- (ZMVideoSDKErrors) transferFile: (NSString *) filePath

Sends file to all users in current session.

Parameters

filePath The file's local path.

Returns: If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

Instance Methods