Meeting video controller interface. More...

#include <meeting_video_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IMeetingVideoCtrlEvent *pEvent)=0
	Set the meeting video controller callback event handler.

virtual SDKError	MuteVideo ()=0
	Turn off the user's own video.

virtual SDKError	UnmuteVideo ()=0
	Turn on the user's own video.

virtual SDKError	CanSpotlight (unsigned int userid, SpotlightResult &result)=0
	Determine if it is able to spotlight the video of the specified user in the meeting.

virtual SDKError	CanUnSpotlight (unsigned int userid, SpotlightResult &result)=0
	Determine if it is able to unspotlight the video of the specified user in the meeting.

virtual SDKError	SpotlightVideo (unsigned int userid)=0
	Spotlight the video of the assigned user to the first view.

virtual SDKError	UnSpotlightVideo (unsigned int userid)=0
	Unspotlight the video of the assigned user to the first view.

virtual SDKError	UnSpotlightAllVideos ()=0
	Unpin all the videos from the first view.

virtual IList< unsigned int > *	GetSpotlightedUserList ()=0
	Get the list of all the spotlighted user in the meeting.

virtual SDKError	CanAskAttendeeToStartVideo (unsigned int userid)=0
	Query if it is able to demand the specified user to turn on the video.

virtual SDKError	AskAttendeeToStartVideo (unsigned int userid)=0
	Demand the assigned user to turn on the video.

virtual SDKError	CanStopAttendeeVideo (unsigned int userid)=0
	Query if it is able to demand the specified user to turn off the video.

virtual SDKError	StopAttendeeVideo (unsigned int userid)=0
	Turn off the video of the assigned user.

virtual bool	IsSupportFollowHostVideoOrder ()=0
	Determine if the following host video order feature is supported.

virtual SDKError	EnableFollowHostVideoOrder (bool bEnable)=0
	Enable or disable follow host video order mode.

virtual bool	IsFollowHostVideoOrderOn ()=0
	Determine if the follow host video mode is enabled.

virtual IList< unsigned int > *	GetVideoOrderList ()=0
	Get the video order list.

virtual bool	IsIncomingVideoStopped ()=0
	Determine if the incoming video is stopped.

virtual IMeetingCameraHelper *	GetMeetingCameraHelper (unsigned int userid)=0
	Get camera helper interface.

virtual SDKError	RevokeCameraControlPrivilege ()=0
	Revoke camera control privilege.

virtual bool	CanEnableAlphaChannelMode ()=0
	Determine if alpha channel mode can be enabled.

virtual SDKError	EnableAlphaChannelMode (bool enable)=0
	Enable or disable video alpha channel mode.

virtual bool	IsAlphaChannelModeEnabled ()=0
	Determine if alpha channel mode is enabled.

virtual VideoSize	GetUserVideoSize (unsigned int userid)=0
	Get the size of user's video.

virtual SDKError	SetVideoQualityPreference (SDKVideoPreferenceSetting preferenceSetting)=0
	Set the video quality preference that automatically adjust user's video to prioritize frame rate versus resolution based on the current bandwidth available.

virtual SDKError	EnableSpeakerContrastEnhance (bool enable)=0
	Enable or disable contrast enhancement effect for speaker video.

virtual bool	IsSpeakerContrastEnhanceEnabled ()=0
	Determine if contrast enhancement effect for speaker video is enabled.

Detailed Description

Meeting video controller interface.

Definition at line 311 of file meeting_video_interface.h.

Member Function Documentation

◆ AskAttendeeToStartVideo()

virtual SDKError IMeetingVideoController::AskAttendeeToStartVideo ( unsigned int userid )

pure virtual

Demand the assigned user to turn on the video.

Parameters

userid Specifies the user ID to demand.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both Zoom style and customize user interface mode.

◆ CanAskAttendeeToStartVideo()

virtual SDKError IMeetingVideoController::CanAskAttendeeToStartVideo ( unsigned int userid )

pure virtual

Query if it is able to demand the specified user to turn on the video.

Parameters

userid Specifies the user ID to query.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both Zoom style and customize user interface mode.

◆ CanEnableAlphaChannelMode()

virtual bool IMeetingVideoController::CanEnableAlphaChannelMode ( )

pure virtual

Determine if alpha channel mode can be enabled.

Returns: true means it can be enabled. Otherwise false.

◆ CanSpotlight()

virtual SDKError IMeetingVideoController::CanSpotlight	(	unsigned int	userid,
		SpotlightResult &	result )

pure virtual

Determine if it is able to spotlight the video of the specified user in the meeting.

Parameters

	userid	Specifies the user ID to be determined.
[out]	result	Indicates if it is able to spotlight. It validates only when the return value is SDKErr_Success.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both Zoom style and customize user interface mode.

◆ CanStopAttendeeVideo()

virtual SDKError IMeetingVideoController::CanStopAttendeeVideo ( unsigned int userid )

pure virtual

Query if it is able to demand the specified user to turn off the video.

Parameters

userid Specifies the user ID to query.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both Zoom style and customize user interface mode.

◆ CanUnSpotlight()

virtual SDKError IMeetingVideoController::CanUnSpotlight	(	unsigned int	userid,
		SpotlightResult &	result )

pure virtual

Determine if it is able to unspotlight the video of the specified user in the meeting.

Parameters

	userid	Specifies the user ID to be determined.
[out]	result	Indicates if it is able to unspotlight. It validates only when the return value is SDKErr_Success.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both Zoom style and customize user interface mode.

◆ EnableAlphaChannelMode()

virtual SDKError IMeetingVideoController::EnableAlphaChannelMode ( bool enable )

pure virtual

Enable or disable video alpha channel mode.

Parameters

enable True indicates to enable alpha channel mode. Otherwise, disable it.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableFollowHostVideoOrder()

virtual SDKError IMeetingVideoController::EnableFollowHostVideoOrder ( bool bEnable )

pure virtual

Enable or disable follow host video order mode.

Parameters

bEnable TRUE indicates to set to enable the follow host video order mode.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableSpeakerContrastEnhance()

virtual SDKError IMeetingVideoController::EnableSpeakerContrastEnhance ( bool enable )

pure virtual

Enable or disable contrast enhancement effect for speaker video.

Parameters

enable True indicates to enable contrast enhancement effect. Otherwise, disable it.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise fails. To get extended error information, see SDKError enum.

◆ GetMeetingCameraHelper()

virtual IMeetingCameraHelper * IMeetingVideoController::GetMeetingCameraHelper ( unsigned int userid )

pure virtual

Get camera helper interface.

Returns: If the function succeeds, the return value is a pointer to IMeetingCameraHelper. Otherwise returns nullptr.

◆ GetSpotlightedUserList()

virtual IList< unsigned int > * IMeetingVideoController::GetSpotlightedUserList ( )

pure virtual

Get the list of all the spotlighted user in the meeting.

Returns: If the function succeeds, the return value is the list of the spotlighted user in the meeting. Otherwise failed, the return value is nullptr.

Remarks: Valid for both Zoom style and customize user interface mode.

◆ GetUserVideoSize()

virtual VideoSize IMeetingVideoController::GetUserVideoSize ( unsigned int userid )

pure virtual

Get the size of user's video.

Parameters

userid Specifies the user ID. The user id should be 0 when not in meeting.

Returns: The size of user's video.

◆ GetVideoOrderList()

virtual IList< unsigned int > * IMeetingVideoController::GetVideoOrderList ( )

pure virtual

Get the video order list.

Returns: If the function succeeds, the return value the is video order list. Otherwise failed, returns nullptr.

◆ IsAlphaChannelModeEnabled()

virtual bool IMeetingVideoController::IsAlphaChannelModeEnabled ( )

pure virtual

Determine if alpha channel mode is enabled.

Returns: True indicates alpha channel mode is enabled. Otherwise false.

◆ IsFollowHostVideoOrderOn()

virtual bool IMeetingVideoController::IsFollowHostVideoOrderOn ( )

pure virtual

Determine if the follow host video mode is enabled.

Returns: TRUE indicates to enable the mode.

◆ IsIncomingVideoStopped()

virtual bool IMeetingVideoController::IsIncomingVideoStopped ( )

pure virtual

Determine if the incoming video is stopped.

Returns: TRUE indicates that the incoming video is stopped.

◆ IsSpeakerContrastEnhanceEnabled()

virtual bool IMeetingVideoController::IsSpeakerContrastEnhanceEnabled ( )

pure virtual

Determine if contrast enhancement effect for speaker video is enabled.

Returns: True indicates contrast enhancement effect is enabled. Otherwise false.

◆ IsSupportFollowHostVideoOrder()

virtual bool IMeetingVideoController::IsSupportFollowHostVideoOrder ( )

pure virtual

Determine if the following host video order feature is supported.

Returns: TRUE indicates to support the following host video order feature.

◆ MuteVideo()

virtual SDKError IMeetingVideoController::MuteVideo ( )

pure virtual

Turn off the user's own video.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both Zoom style and customize user interface mode.

◆ RevokeCameraControlPrivilege()

virtual SDKError IMeetingVideoController::RevokeCameraControlPrivilege ( )

pure virtual

Revoke camera control privilege.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SetEvent()

virtual SDKError IMeetingVideoController::SetEvent ( IMeetingVideoCtrlEvent * pEvent )

pure virtual

Set the meeting video controller callback event handler.

Parameters

pEvent A pointer to the IRequestStartVideoHandler that receives the video controller event.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SetVideoQualityPreference()

virtual SDKError IMeetingVideoController::SetVideoQualityPreference ( SDKVideoPreferenceSetting preferenceSetting )

pure virtual

Set the video quality preference that automatically adjust user's video to prioritize frame rate versus resolution based on the current bandwidth available.

Parameters

preferenceSetting Specifies the video quality preference. For more information, see SDKError enum.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SpotlightVideo()

virtual SDKError IMeetingVideoController::SpotlightVideo ( unsigned int userid )

pure virtual

Spotlight the video of the assigned user to the first view.

Parameters

userid Specifies the user ID to be spotlighted.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both Zoom style and customize user interface mode.

◆ StopAttendeeVideo()

virtual SDKError IMeetingVideoController::StopAttendeeVideo ( unsigned int userid )

pure virtual

Turn off the video of the assigned user.

Parameters

userid Specifies the user ID to turn off.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both Zoom style and customize user interface mode.

◆ UnmuteVideo()

virtual SDKError IMeetingVideoController::UnmuteVideo ( )

pure virtual

Turn on the user's own video.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both Zoom style and customize user interface mode.

◆ UnSpotlightAllVideos()

virtual SDKError IMeetingVideoController::UnSpotlightAllVideos ( )

pure virtual

Unpin all the videos from the first view.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both Zoom style and customize user interface mode.

◆ UnSpotlightVideo()

virtual SDKError IMeetingVideoController::UnSpotlightVideo ( unsigned int userid )

pure virtual

Unspotlight the video of the assigned user to the first view.

Parameters

userid Specifies the user ID to be unspotlighted.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both Zoom style and customize user interface mode.

Public Member Functions

Detailed Description

Member Function Documentation

◆ AskAttendeeToStartVideo()

◆ CanAskAttendeeToStartVideo()

◆ CanEnableAlphaChannelMode()

◆ CanSpotlight()

◆ CanStopAttendeeVideo()

◆ CanUnSpotlight()

◆ EnableAlphaChannelMode()

◆ EnableFollowHostVideoOrder()

◆ EnableSpeakerContrastEnhance()

◆ GetMeetingCameraHelper()

◆ GetSpotlightedUserList()

◆ GetUserVideoSize()

◆ GetVideoOrderList()

◆ IsAlphaChannelModeEnabled()

◆ IsFollowHostVideoOrderOn()

◆ IsIncomingVideoStopped()

◆ IsSpeakerContrastEnhanceEnabled()

◆ IsSupportFollowHostVideoOrder()

◆ MuteVideo()

◆ RevokeCameraControlPrivilege()

◆ SetEvent()

◆ SetVideoQualityPreference()

◆ SpotlightVideo()

◆ StopAttendeeVideo()

◆ UnmuteVideo()

◆ UnSpotlightAllVideos()

◆ UnSpotlightVideo()