IMeetingRemoteSupportController Class Reference

Meeting remote support interface. More...

#include <meeting_remote_support_interface.h>

Public Member Functions
virtual	~IMeetingRemoteSupportController ()
virtual SDKError	SetEvent (IMeetingRemoteSupportEvent *pEvent)=0
	Set meeting remote support callback event handler.
virtual bool	IsSupportRemoteSupport ()=0
	Query Whether the meeting supports remote support.
virtual bool	CanRequestRemoteSupport ()=0
	Whether if the current user can request remote support.
virtual IList< unsigned int > *	GetRemoteSupportUserList ()=0
	Get the list of users'IDs that can be supported remotely.
virtual SDKError	RequestRemoteSupport (unsigned int userId, RemoteSupportType supportType)=0
	Send the request of remote support to the specified user.
virtual SDKError	StopRemoteSupport ()=0
	Stop the remote support to the specified user.
virtual SDKError	CanSelectRemoteSupportScreen ()=0
	Whether if the current user is able to select remote support screen.
virtual SDKError	SelectRemoteSupportScreen (int screenIndex)=0
	Select the monitor of remote support to the specified user.

Detailed Description

Meeting remote support interface.

Definition at line 96 of file meeting_remote_support_interface.h.

Constructor & Destructor Documentation

~IMeetingRemoteSupportController()

virtual IMeetingRemoteSupportController::~IMeetingRemoteSupportController ( )

inlinevirtual

Definition at line 99 of file meeting_remote_support_interface.h.

{}

Member Function Documentation

CanRequestRemoteSupport()

virtual bool IMeetingRemoteSupportController::CanRequestRemoteSupport ( )

pure virtual

Whether if the current user can request remote support.

Returns

true if the user can request remote support, false if they can't.

CanSelectRemoteSupportScreen()

virtual SDKError IMeetingRemoteSupportController::CanSelectRemoteSupportScreen ( )

pure virtual

Whether if the current user is able to select remote support screen.

Returns

If the function succeeds, the return value is SDKErr_Success.

GetRemoteSupportUserList()

virtual IList< unsigned int > * IMeetingRemoteSupportController::GetRemoteSupportUserList ( )

pure virtual

Get the list of users'IDs that can be supported remotely.

Returns

If the function succeeds, the return value is a pointer to the IList object.

IsSupportRemoteSupport()

virtual bool IMeetingRemoteSupportController::IsSupportRemoteSupport ( )

pure virtual

Query Whether the meeting supports remote support.

Returns

true if supported, false if not supported.

RequestRemoteSupport()

virtual SDKError IMeetingRemoteSupportController::RequestRemoteSupport ( unsigned int userId, RemoteSupportType supportType )

pure virtual

Send the request of remote support to the specified user.

Parameters

userId	Specify the user ID that you want to send the request.
supportType	Specify category for remote support .

Returns

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

SelectRemoteSupportScreen()

virtual SDKError IMeetingRemoteSupportController::SelectRemoteSupportScreen ( int screenIndex )

pure virtual

Select the monitor of remote support to the specified user.

Parameters

screenIndex

Specify the screen index that you want to control.

Returns

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

SetEvent()

virtual SDKError IMeetingRemoteSupportController::SetEvent ( IMeetingRemoteSupportEvent * pEvent )

pure virtual

Set meeting remote support callback event handler.

Parameters

pEvent

A pointer to the IMeetingRemoteSupportEvent that receives the remote support event.

Returns

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

Remarks

When the remote support or the authority changes, the user receives a callback event.

StopRemoteSupport()

virtual SDKError IMeetingRemoteSupportController::StopRemoteSupport ( )

pure virtual

Stop the remote support to the specified user.

Returns

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

Remarks

It will stop the share currently in progress.