IZoomVideoSDKSession Class Reference

Session information interface. More...

#include <zoom_video_sdk_session_info_interface.h>

Public Member Functions
virtual uint64_t	getSessionNumber ()=0
	Get the current session number.
virtual const zchar_t *	getSessionName ()=0
	Get the session name.
virtual const zchar_t *	getSessionPassword ()=0
	Get the session's password.
virtual const zchar_t *	getSessionPhonePasscode ()=0
	Get the session phone passcode.
virtual const zchar_t *	getSessionID ()=0
	Get the session ID.
virtual const zchar_t *	getSessionHostName ()=0
	Get the host's name.
virtual IZoomVideoSDKUser *	getSessionHost ()=0
	Get the session's host user object.
virtual IVideoSDKVector< IZoomVideoSDKUser * > *	getRemoteUsers ()=0
	Get a list of the session's remote users.
virtual IZoomVideoSDKUser *	getMyself ()=0
	Get the session's user object for myself.
virtual bool	IsValidUser (IZoomVideoSDKUser *pUser)=0
	Determine if a user object is valid.
virtual ZoomVideoSDKErrors	getSessionAudioStatisticInfo (ZoomVideoSDKSessionAudioStatisticInfo &send_info, ZoomVideoSDKSessionAudioStatisticInfo &recv_info)=0
	Get session's audio statistic information.
virtual ZoomVideoSDKErrors	getSessionVideoStatisticInfo (ZoomVideoSDKSessionASVStatisticInfo &send_info, ZoomVideoSDKSessionASVStatisticInfo &recv_info)=0
	Get session's video statistic information.
virtual ZoomVideoSDKErrors	getSessionShareStatisticInfo (ZoomVideoSDKSessionASVStatisticInfo &send_info, ZoomVideoSDKSessionASVStatisticInfo &recv_info)=0
	Get session's share statistic information.
virtual bool	isFileTransferEnable ()=0
	Determine whether file transfer is enabled.
virtual ZoomVideoSDKErrors	transferFile (const zchar_t *filePath)=0
	Send file to all users in current session.
virtual const zchar_t *	getTransferFileTypeWhiteList ()=0
	Get the list of allowed file types in transfer.
virtual uint64_t	getMaxTransferFileSize ()=0
	Get the maximum size for file transfer.
virtual ZoomVideoSDKSessionType	getSessionType ()=0
	Get the session type of this session.

Detailed Description

Session information interface.

Definition at line 68 of file zoom_video_sdk_session_info_interface.h.

Member Function Documentation

getMaxTransferFileSize()

virtual uint64_t IZoomVideoSDKSession::getMaxTransferFileSize ( )

pure virtual

Get the maximum size for file transfer.

Returns

The maximum number of bytes for file transfer

getMyself()

virtual IZoomVideoSDKUser * IZoomVideoSDKSession::getMyself ( )

pure virtual

Get the session's user object for myself.

Returns

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

getRemoteUsers()

virtual IVideoSDKVector< IZoomVideoSDKUser * > * IZoomVideoSDKSession::getRemoteUsers ( )

pure virtual

Get a list of the session's remote users.

Returns

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

getSessionAudioStatisticInfo()

virtual ZoomVideoSDKErrors IZoomVideoSDKSession::getSessionAudioStatisticInfo ( ZoomVideoSDKSessionAudioStatisticInfo & send_info, ZoomVideoSDKSessionAudioStatisticInfo & recv_info )

pure virtual

Get session's audio statistic information.

Parameters

[out]	send_info	Audio send information refer.
[out]	recv_info	Audio receive information refer.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

getSessionHost()

virtual IZoomVideoSDKUser * IZoomVideoSDKSession::getSessionHost ( )

pure virtual

Get the session's host user object.

Returns

If the function succeeds, the return value is session host user object. Otherwise returns nullptr.

getSessionHostName()

virtual const zchar_t * IZoomVideoSDKSession::getSessionHostName ( )

pure virtual

Get the host's name.

Returns

If the function succeeds, the return value is session host name. Otherwise returns nullptr.

getSessionID()

virtual const zchar_t * IZoomVideoSDKSession::getSessionID ( )

pure virtual

Get the session ID.

Returns

If the function succeeds, the return value is session ID. Otherwise returns nullptr.

Remarks

This interface is only valid for the host.

getSessionName()

virtual const zchar_t * IZoomVideoSDKSession::getSessionName ( )

pure virtual

Get the session name.

Returns

If the function succeeds, the return value is session name. Otherwise returns nullptr.

getSessionNumber()

virtual uint64_t IZoomVideoSDKSession::getSessionNumber ( )

pure virtual

Get the current session number.

Returns

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

getSessionPassword()

virtual const zchar_t * IZoomVideoSDKSession::getSessionPassword ( )

pure virtual

Get the session's password.

Returns

If the function succeeds, the return value is session password. Otherwise returns nullptr.

getSessionPhonePasscode()

virtual const zchar_t * IZoomVideoSDKSession::getSessionPhonePasscode ( )

pure virtual

Get the session phone passcode.

Returns

If the function succeeds, the return value is session phone passcode. Otherwise returns nullptr.

getSessionShareStatisticInfo()

virtual ZoomVideoSDKErrors IZoomVideoSDKSession::getSessionShareStatisticInfo ( ZoomVideoSDKSessionASVStatisticInfo & send_info, ZoomVideoSDKSessionASVStatisticInfo & recv_info )

pure virtual

Get session's share statistic information.

Parameters

[out]	send_info	Share send information refer.
[out]	recv_info	Share receive information refer.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

getSessionType()

virtual ZoomVideoSDKSessionType IZoomVideoSDKSession::getSessionType ( )

pure virtual

Get the session type of this session.

Returns

The session type.

getSessionVideoStatisticInfo()

virtual ZoomVideoSDKErrors IZoomVideoSDKSession::getSessionVideoStatisticInfo ( ZoomVideoSDKSessionASVStatisticInfo & send_info, ZoomVideoSDKSessionASVStatisticInfo & recv_info )

pure virtual

Get session's video statistic information.

Parameters

[out]	send_info	Video send information refer.
[out]	recv_info	Video receive information refer.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

getTransferFileTypeWhiteList()

virtual const zchar_t * IZoomVideoSDKSession::getTransferFileTypeWhiteList ( )

pure virtual

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()

virtual bool IZoomVideoSDKSession::isFileTransferEnable ( )

pure virtual

Determine whether file transfer is enabled.

Returns

True if file transfer is enabled, otherwise false.

IsValidUser()

virtual bool IZoomVideoSDKSession::IsValidUser ( IZoomVideoSDKUser * pUser )

pure virtual

Determine if a user object is valid.

Parameters

pUser

The user object pointer.

Returns

True if user object is valid. Otherwise returns false.

transferFile()

virtual ZoomVideoSDKErrors IZoomVideoSDKSession::transferFile ( const zchar_t * filePath )

pure virtual

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 ZoomVideoSDKErrors_Success.