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

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

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

virtual SDKError	CanPinToFirstView (unsigned int userid, PinResult &result)=0
	Determine if it is able to pin the video of the specified user to the first view. More...

virtual SDKError	PinVideoToFirstView (unsigned int userid)=0
	Pin the video of the assigned user to the first view. More...

virtual SDKError	UnPinVideoFromFirstView (unsigned int userid)=0
	Unpin the video of the assigned user from the first view. More...

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

virtual IList< unsigned int > *	GetPinnedUserListFromFirstView ()=0
	Get the list of all the pinned user in the first view. More...

virtual SDKError	CanPinToSecondView (unsigned int userid, PinResult &result)=0
	Determine if it is able to pin the video of the specified user to the second view. More...

virtual SDKError	PinVideoToSecondView (unsigned int userid)=0
	Pin the video of the assigned user to the second view. More...

virtual SDKError	UnPinVideoFromSecondView (unsigned int userid)=0
	Unpin the video of the assigned user from the second view. More...

virtual IList< unsigned int > *	GetPinnedUserListFromSecondView ()=0
	Get the list of all the pinned user in the second view. More...

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

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

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

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

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

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

virtual SDKError	HideOrShowNoVideoUserOnVideoWall (bool bHide)=0
	Display or not the user who does not turn on the video in the video all mode. More...

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

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

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

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

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

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

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

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

virtual ISetVideoOrderHelper *	GetSetVideoOrderHelper ()=0
	Get set video order helper interface. More...

virtual ICameraController *	GetMyCameraController ()=0
	Get camera controller interface. More...

Detailed Description

Meeting video controller interface.

Definition at line 151 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.

◆ CanPinToFirstView()

virtual SDKError IMeetingVideoController::CanPinToFirstView	(	unsigned int	userid,
		PinResult &	result
	)

pure virtual

Determine if it is able to pin the video of the specified user to the first view.

Parameters

	userid	Specifies the user ID to be determined.
[out]	result	Indicates if it is able to pin. 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 only for Zoom style user interface mode.

◆ CanPinToSecondView()

virtual SDKError IMeetingVideoController::CanPinToSecondView	(	unsigned int	userid,
		PinResult &	result
	)

pure virtual

Determine if it is able to pin the video of the specified user to the second view.

Parameters

	userid	Specifies the user ID to be determined.
[out]	result	Indicates if it is able to pin. 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 only for Zoom style user interface mode.

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

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

◆ GetMyCameraController()

virtual ICameraController * IMeetingVideoController::GetMyCameraController ( )

pure virtual

Get camera controller interface.

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

◆ GetPinnedUserListFromFirstView()

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

pure virtual

Get the list of all the pinned user in the first view.

Returns: If the function succeeds, the return value is the list of the pinned user in the first view. Otherwise failed, the return value is NULL.

Remarks: Valid only for Zoom style user interface mode.

◆ GetPinnedUserListFromSecondView()

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

pure virtual

Get the list of all the pinned user in the second view.

Returns: If the function succeeds, the return value is the list of the pinned user in the second view. Otherwise failed, the return value is NULL.

Remarks: Valid only for Zoom style user interface mode.

◆ GetSetVideoOrderHelper()

virtual ISetVideoOrderHelper * IMeetingVideoController::GetSetVideoOrderHelper ( )

pure virtual

Get set video order helper interface.

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

◆ 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 NULL.

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

◆ 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 NULL.

◆ HideOrShowNoVideoUserOnVideoWall()

virtual SDKError IMeetingVideoController::HideOrShowNoVideoUserOnVideoWall ( bool bHide )

pure virtual

Display or not the user who does not turn on the video in the video all mode.

Returns: TRUE indicates to hide, FALSE show. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid only for Zoom style user interface mode.

◆ IsFollowHostVideoOrderOn()

virtual bool IMeetingVideoController::IsFollowHostVideoOrderOn ( )

pure virtual

Determine if the follow host video mode is enabled.

Returns: TRUE indicates to enable the mode.

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

◆ PinVideoToFirstView()

virtual SDKError IMeetingVideoController::PinVideoToFirstView ( unsigned int userid )

pure virtual

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

Parameters

userid Specifies the user ID to be pinned.

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

Remarks: Valid only for Zoom style user interface mode.

◆ PinVideoToSecondView()

virtual SDKError IMeetingVideoController::PinVideoToSecondView ( unsigned int userid )

pure virtual

Pin the video of the assigned user to the second view.

Parameters

userid Specifies the user ID to be pinned.

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

Remarks: Valid only for Zoom style user interface mode.

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

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

◆ UnPinAllVideosFromFirstView()

virtual SDKError IMeetingVideoController::UnPinAllVideosFromFirstView ( )

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 only for Zoom style user interface mode.

◆ UnPinVideoFromFirstView()

virtual SDKError IMeetingVideoController::UnPinVideoFromFirstView ( unsigned int userid )

pure virtual

Unpin the video of the assigned user from the first view.

Parameters

userid Specifies the user ID to be unpinned.

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

Remarks: Valid only for Zoom style user interface mode.

◆ UnPinVideoFromSecondView()

virtual SDKError IMeetingVideoController::UnPinVideoFromSecondView ( unsigned int userid )

pure virtual

Unpin the video of the assigned user from the second view.

Parameters

userid Specifies the user ID to be unpinned.

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

Remarks: Valid only for Zoom style 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()

◆ CanPinToFirstView()

◆ CanPinToSecondView()

◆ CanSpotlight()

◆ CanStopAttendeeVideo()

◆ CanUnSpotlight()

◆ EnableFollowHostVideoOrder()

◆ GetMyCameraController()

◆ GetPinnedUserListFromFirstView()

◆ GetPinnedUserListFromSecondView()

◆ GetSetVideoOrderHelper()

◆ GetSpotlightedUserList()

◆ GetVideoOrderList()

◆ HideOrShowNoVideoUserOnVideoWall()

◆ IsFollowHostVideoOrderOn()

◆ IsSupportFollowHostVideoOrder()

◆ MuteVideo()

◆ PinVideoToFirstView()

◆ PinVideoToSecondView()

◆ SetEvent()

◆ SpotlightVideo()

◆ StopAttendeeVideo()

◆ UnmuteVideo()

◆ UnPinAllVideosFromFirstView()

◆ UnPinVideoFromFirstView()

◆ UnPinVideoFromSecondView()

◆ UnSpotlightAllVideos()

◆ UnSpotlightVideo()