User object interface. More...

#include <zoom_video_sdk_user_helper_interface.h>

Public Member Functions
virtual	~IZoomVideoSDKUser ()

virtual const zchar_t *	getCustomIdentity ()=0
	Get the user's custom id.

virtual const zchar_t *	getUserName ()=0
	Get the user's name.

virtual const zchar_t *	getUserID ()=0
	Get the user's id.

virtual ZoomVideoSDKAudioStatus	getAudioStatus ()=0
	Get the user's audio status.

virtual const zchar_t *	getUserReference ()=0
	Get the user's reference info.

virtual bool	isHost ()=0
	Determine whether the user is the host.

virtual bool	isManager ()=0
	Determine whether the user is the manager(coHost)

virtual bool	isVideoSpotLighted ()=0
	Determine whether the user is spotLighted.

virtual ZoomVideoSDKVideoStatisticInfo	getVideoStatisticInfo ()=0
	Get the user's video statistic information.

virtual ZoomVideoSDKShareStatisticInfo	getShareStatisticInfo ()=0
	Get the user's share statistic information.

virtual IZoomVideoSDKRawDataPipe *	GetVideoPipe ()=0
	Get the user's video raw data pipe.

virtual IZoomVideoSDKCanvas *	GetVideoCanvas ()=0
	Gets the user's video render canvas object.

virtual IVideoSDKVector< IZoomVideoSDKShareAction * > *	getShareActionList ()=0
	Get the user's share-action list.

virtual IZoomVideoSDKRemoteCameraControlHelper *	getRemoteCameraControlHelper ()=0
	Get the helper class instance to access the remote camera control.

virtual IVideoSDKVector< IZoomVideoSDKRawDataPipe * > *	getMultiCameraStreamList ()=0
	Get the user's multi-camera stream list.

virtual unsigned int	getAudioLevel ()=0
	Gets the current audio level of a remote user.

virtual bool	getUserVolume (float &volume, bool isShareAudio=false)=0
	Get user volume.

virtual bool	canSetUserVolume (bool isShareAudio=false)=0
	Determine which audio you can set, shared audio or microphone.

virtual bool	hasIndividualRecordingConsent ()=0
	Used to determine whether I agree to individual video recording.

virtual bool	setUserVolume (float volume, bool isShareAudio=false)=0
	Set the user's local volume. This does not affect how other participants hear the user.

virtual bool	getUserPlaybackVolume (float &volume, bool isShareAudio=false)=0
	Gets the local volume.

virtual bool	canSetUserPlaybackVolume (bool isShareAudio=false)=0
	Checks whether you can set the volume for shared audio or microphone.

virtual bool	setUserPlaybackVolume (float volume, bool isShareAudio=false)=0
	Sets the user's local volume. This does not affect how other participants hear the user.

virtual ZoomVideoSDKErrors	transferFile (const zchar_t *filePath)=0
	Send file to current user object.

virtual bool	isIncomingLiveStreamUser ()=0
	Determine whether the user is incoming live stream user.

virtual bool	isInSubSession ()=0
	Determine whether the user is in a subsession.

virtual ZoomVideoSDKWhiteboardStatus	getWhiteboardStatus ()=0
	Get the whiteboard sharing status of the user.

virtual ZoomVideoSDKNetworkStatus	getNetworkLevel (ZoomVideoSDKDataType type)=0
	Gets the network quality level of the specified data type for the user.

virtual ZoomVideoSDKNetworkStatus	getOverallNetworkLevel ()=0
	Gets the overall network quality level of the user.

Detailed Description

User object interface.

Definition at line 402 of file zoom_video_sdk_user_helper_interface.h.

Constructor & Destructor Documentation

◆ ~IZoomVideoSDKUser()

virtual IZoomVideoSDKUser::~IZoomVideoSDKUser ( )

inlinevirtual

Definition at line 405 of file zoom_video_sdk_user_helper_interface.h.

405{}

Member Function Documentation

◆ canSetUserPlaybackVolume()

virtual bool IZoomVideoSDKUser::canSetUserPlaybackVolume ( bool isShareAudio = false )

pure virtual

Checks whether you can set the volume for shared audio or microphone.

Parameters

isShareAudio true to check if you can set the volume of shared audio; otherwise, you can set the volume of the microphone.

Returns: true if you can set the volume of shared audio; otherwise, false.

◆ canSetUserVolume()

virtual bool IZoomVideoSDKUser::canSetUserVolume ( bool isShareAudio = false )

pure virtual

Determine which audio you can set, shared audio or microphone.

Parameters

isShareAudio If true, checks whether you can set the volume of shared audio, otherwise you can set the volume of the microphone.

Returns: If can return true, otherwise false.

Deprecated: This interface is marked as deprecated, and is replaced by canSetUserPlaybackVolume(bool isShareAudio = false).

◆ getAudioLevel()

virtual unsigned int IZoomVideoSDKUser::getAudioLevel ( )

pure virtual

Gets the current audio level of a remote user.

Returns: The current audio level.

◆ getAudioStatus()

virtual ZoomVideoSDKAudioStatus IZoomVideoSDKUser::getAudioStatus ( )

pure virtual

Get the user's audio status.

Returns: Audio status of the user object.

◆ getCustomIdentity()

virtual const zchar_t * IZoomVideoSDKUser::getCustomIdentity ( )

pure virtual

Get the user's custom id.

Returns: The Custom id of the user object.

◆ getMultiCameraStreamList()

virtual IVideoSDKVector< IZoomVideoSDKRawDataPipe * > * IZoomVideoSDKUser::getMultiCameraStreamList ( )

pure virtual

Get the user's multi-camera stream list.

Returns: A list of all streaming cameras pipe.

◆ getNetworkLevel()

virtual ZoomVideoSDKNetworkStatus IZoomVideoSDKUser::getNetworkLevel ( ZoomVideoSDKDataType type )

pure virtual

Gets the network quality level of the specified data type for the user.

Parameters

type	The data type, such as audio, video, or share.

Returns: The current network status level for the specified data type.

◆ getOverallNetworkLevel()

virtual ZoomVideoSDKNetworkStatus IZoomVideoSDKUser::getOverallNetworkLevel ( )

pure virtual

Gets the overall network quality level of the user.

Returns: The overall network status level.

◆ getRemoteCameraControlHelper()

virtual IZoomVideoSDKRemoteCameraControlHelper * IZoomVideoSDKUser::getRemoteCameraControlHelper ( )

pure virtual

Get the helper class instance to access the remote camera control.

Returns: If the function succeeds, the return value is the remote camera control helper object. Otherwise returns nullptr.

◆ getShareActionList()

virtual IVideoSDKVector< IZoomVideoSDKShareAction * > * IZoomVideoSDKUser::getShareActionList ( )

pure virtual

Get the user's share-action list.

Returns: A list of all share information.

◆ getShareStatisticInfo()

virtual ZoomVideoSDKShareStatisticInfo IZoomVideoSDKUser::getShareStatisticInfo ( )

pure virtual

Get the user's share statistic information.

Returns: The share statistic information.

◆ getUserID()

virtual const zchar_t * IZoomVideoSDKUser::getUserID ( )

pure virtual

Get the user's id.

Returns: The user id of the user object.

◆ getUserName()

virtual const zchar_t * IZoomVideoSDKUser::getUserName ( )

pure virtual

Get the user's name.

Returns: The name of the user object.

◆ getUserPlaybackVolume()

virtual bool IZoomVideoSDKUser::getUserPlaybackVolume	(	float &	volume,
		bool	isShareAudio = false )

pure virtual

Gets the local volume.

Parameters

volume	The user volume.
isShareAudio	true to get the volume of shared audio(such as shared computer audio); otherwise gets the microphone volume.

Returns: true if the operation succeeds; otherwise, false.

◆ getUserReference()

virtual const zchar_t * IZoomVideoSDKUser::getUserReference ( )

pure virtual

Get the user's reference info.

Returns: user's reference info.

◆ getUserVolume()

virtual bool IZoomVideoSDKUser::getUserVolume	(	float &	volume,
		bool	isShareAudio = false )

pure virtual

Get user volume.

Parameters

volume	The user volume.
isShareAudio	If true, gets the volume of shared audio(such as shared computer audio), otherwise gets the volume of the microphone.

Returns: If successful, return true, otherwise false.

Deprecated: This interface is marked as deprecated, and is replaced by getUserPlaybackVolume(float& volume, bool isShareAudio = false).

◆ GetVideoCanvas()

virtual IZoomVideoSDKCanvas * IZoomVideoSDKUser::GetVideoCanvas ( )

pure virtual

Gets the user's video render canvas object.

Returns: If the function succeeds, the return value is the video render helper object. Otherwise, this function fails and returns nullptr.

◆ GetVideoPipe()

virtual IZoomVideoSDKRawDataPipe * IZoomVideoSDKUser::GetVideoPipe ( )

pure virtual

Get the user's video raw data pipe.

Returns: The video pipe.

◆ getVideoStatisticInfo()

virtual ZoomVideoSDKVideoStatisticInfo IZoomVideoSDKUser::getVideoStatisticInfo ( )

pure virtual

Get the user's video statistic information.

Returns: The video statistic information.

◆ getWhiteboardStatus()

virtual ZoomVideoSDKWhiteboardStatus IZoomVideoSDKUser::getWhiteboardStatus ( )

pure virtual

Get the whiteboard sharing status of the user.

Returns: The whiteboard sharing status.

◆ hasIndividualRecordingConsent()

virtual bool IZoomVideoSDKUser::hasIndividualRecordingConsent ( )

pure virtual

Used to determine whether I agree to individual video recording.

Returns: If agreed return true, otherwise false.

◆ isHost()

virtual bool IZoomVideoSDKUser::isHost ( )

pure virtual

Determine whether the user is the host.

Returns: True indicates that the user is the host, otherwise false.

◆ isIncomingLiveStreamUser()

virtual bool IZoomVideoSDKUser::isIncomingLiveStreamUser ( )

pure virtual

Determine whether the user is incoming live stream user.

Returns: True indicates that the user is an incoming live stream user, otherwise false.

◆ isInSubSession()

virtual bool IZoomVideoSDKUser::isInSubSession ( )

pure virtual

Determine whether the user is in a subsession.

Returns: If the user is currently in a subsession, it will return true, otherwise not.

◆ isManager()

virtual bool IZoomVideoSDKUser::isManager ( )

pure virtual

Determine whether the user is the manager(coHost)

Returns: True indicates that the user is the manager(coHost), otherwise false.

◆ isVideoSpotLighted()

virtual bool IZoomVideoSDKUser::isVideoSpotLighted ( )

pure virtual

Determine whether the user is spotLighted.

Returns: True indicates that the user is spotLighted, otherwise false.

◆ setUserPlaybackVolume()

virtual bool IZoomVideoSDKUser::setUserPlaybackVolume	(	float	volume,
		bool	isShareAudio = false )

pure virtual

Sets the user's local volume. This does not affect how other participants hear the user.

Parameters

volume	Value can between 0 and 10. If 0, the user won't hear the related audio.
isSharingAudio	true to set the volume of shared audio (such as shared computer audio; otherwise, sets the microphone volume.

Returns: true if the operation succeeds; otherwise, false.

◆ setUserVolume()

virtual bool IZoomVideoSDKUser::setUserVolume	(	float	volume,
		bool	isShareAudio = false )

pure virtual

Set the user's local volume. This does not affect how other participants hear the user.

Parameters

volume	The value can be >= 0 and <=10. If volume is 0, you won't be able to hear the related audio.
isShareAudio	If true, sets the volume of shared audio(such as shared computer audio), otherwise sets the volume of microphone.

Returns: If success return true, otherwise false.

Deprecated: This interface is marked as deprecated, and is replaced by setUserPlaybackVolume(float volume, bool isShareAudio = false).

◆ transferFile()

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

pure virtual

Send file to current user object.

Parameters

filePath The local path of the file

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IZoomVideoSDKUser()

Member Function Documentation

◆ canSetUserPlaybackVolume()

◆ canSetUserVolume()

◆ getAudioLevel()

◆ getAudioStatus()

◆ getCustomIdentity()

◆ getMultiCameraStreamList()

◆ getNetworkLevel()

◆ getOverallNetworkLevel()

◆ getRemoteCameraControlHelper()

◆ getShareActionList()

◆ getShareStatisticInfo()

◆ getUserID()

◆ getUserName()

◆ getUserPlaybackVolume()

◆ getUserReference()

◆ getUserVolume()

◆ GetVideoCanvas()

◆ GetVideoPipe()

◆ getVideoStatisticInfo()

◆ getWhiteboardStatus()

◆ hasIndividualRecordingConsent()

◆ isHost()

◆ isIncomingLiveStreamUser()

◆ isInSubSession()

◆ isManager()

◆ isVideoSpotLighted()

◆ setUserPlaybackVolume()

◆ setUserVolume()

◆ transferFile()