Meeting remote control interface. More...

#include <meeting_remote_ctrl_interface.h>

Public Member Functions
virtual	~IMeetingRemoteController ()

virtual SDKError	SetEvent (IMeetingRemoteCtrlEvent *pEvent)=0
	Set meeting remote control callback event handler.

virtual SDKError	CanRequestControl (unsigned int shareSourceID)=0
	Determine if the current user is able to request to control others remotely.

virtual SDKError	IsHaveRemoteControlRight (unsigned int shareSourceID)=0
	Determine if the user has privileges to control the specified user remotely..

virtual SDKError	IsInRemoteControllingStatus (unsigned int shareSourceID)=0
	Determine if the current user is controlling the specified user remotely.

virtual SDKError	EnterRemoteControllingStatus (unsigned int shareSourceID)=0
	Start remotely controlling the specified user's computer.

virtual SDKError	LeaveRemoteControllingStatus (unsigned int shareSourceID)=0
	Stop controlling remotely.

virtual SDKError	RequestRemoteControl (unsigned int shareSourceID)=0
	Request to remotely control the specified user.

virtual SDKError	GiveupRemoteControl (unsigned int shareSourceID)=0
	Give up remotely controlling the specified user.

virtual SDKError	GiveRemoteControlTo (unsigned int userId)=0
	Give the authority of remote control to the specified user.

virtual SDKError	DeclineRemoteControlRequest (unsigned int userId)=0
	Refuse the request to remote control from the specified user.

virtual SDKError	RevokeRemoteControl ()=0
	Get back all the authority of remote control.

virtual SDKError	GetCurrentRemoteController (unsigned int &userId)=0
	Get the controller ID who is currently controlling by long-distance.

virtual bool	IsAutoAcceptRemoteControlFeatureEnabled ()=0
	Determine if the auto accept remote control requests feature is enabled in the meeting.

virtual SDKError	CanEnableAutoAcceptRemoteControlFeature ()=0
	Whether the current user can enable the auto accept remote control requests feature.

virtual SDKError	EnableAutoAcceptRemoteControlFeature (bool bEnable)=0
	Enable or disable auto accept remote control requests feature.

Detailed Description

Meeting remote control interface.

Definition at line 47 of file meeting_remote_ctrl_interface.h.

Constructor & Destructor Documentation

◆ ~IMeetingRemoteController()

virtual IMeetingRemoteController::~IMeetingRemoteController ( )

inlinevirtual

Definition at line 50 of file meeting_remote_ctrl_interface.h.

50{}

Member Function Documentation

◆ CanEnableAutoAcceptRemoteControlFeature()

virtual SDKError IMeetingRemoteController::CanEnableAutoAcceptRemoteControlFeature ( )

pure virtual

Whether the current user can enable the auto accept remote control requests feature.

Returns: True means the current user can enable the feature.

◆ CanRequestControl()

virtual SDKError IMeetingRemoteController::CanRequestControl ( unsigned int shareSourceID )

pure virtual

Determine if the current user is able to request to control others remotely.

Parameters

shareSourceID Specify the share scource ID to check.

Remarks: For custom style mode, this interface is only valid after subscribing the sharing content from the specified user by calling ICustomizedShareRender::SetUserID(unsigned int userid) successfully.

Returns: If it is able to request to control the specified user by long-distance, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, see SDKError enum.

◆ DeclineRemoteControlRequest()

virtual SDKError IMeetingRemoteController::DeclineRemoteControlRequest ( unsigned int userId )

pure virtual

Refuse the request to remote control from the specified user.

Parameters

userId Specify the share scource ID to be disabled to remote control.

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

◆ EnableAutoAcceptRemoteControlFeature()

virtual SDKError IMeetingRemoteController::EnableAutoAcceptRemoteControlFeature ( bool bEnable )

pure virtual

Enable or disable auto accept remote control requests feature.

Parameters

bEnable True means that auto accept remote control requests are enabled; False means disabled.

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

◆ EnterRemoteControllingStatus()

virtual SDKError IMeetingRemoteController::EnterRemoteControllingStatus ( unsigned int shareSourceID )

pure virtual

Start remotely controlling the specified user's computer.

Parameters

shareSourceID Specify the share scource ID to be controlled.

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

◆ GetCurrentRemoteController()

virtual SDKError IMeetingRemoteController::GetCurrentRemoteController ( unsigned int & userId )

pure virtual

Get the controller ID who is currently controlling by long-distance.

Parameters

[out] userId The user ID who is currently controlling by long-distance. ZERO(0) indicates that there is no controller for the moment.

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

◆ GiveRemoteControlTo()

virtual SDKError IMeetingRemoteController::GiveRemoteControlTo ( unsigned int userId )

pure virtual

Give the authority of remote control to the specified user.

Parameters

userId Specify the user ID that you want to give the authority.

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

◆ GiveupRemoteControl()

virtual SDKError IMeetingRemoteController::GiveupRemoteControl ( unsigned int shareSourceID )

pure virtual

Give up remotely controlling the specified user.

Parameters

shareSourceID Specify the share scource ID.

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

◆ IsAutoAcceptRemoteControlFeatureEnabled()

virtual bool IMeetingRemoteController::IsAutoAcceptRemoteControlFeatureEnabled ( )

pure virtual

Determine if the auto accept remote control requests feature is enabled in the meeting.

Returns: True means that the feature enabled, False means that the feature isn't enabled.

◆ IsHaveRemoteControlRight()

virtual SDKError IMeetingRemoteController::IsHaveRemoteControlRight ( unsigned int shareSourceID )

pure virtual

Determine if the user has privileges to control the specified user remotely..

Parameters

shareSourceID Specify the share scource ID to check.

Returns: If it is able to control the specified user by long-distance, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, see SDKError enum.

◆ IsInRemoteControllingStatus()

virtual SDKError IMeetingRemoteController::IsInRemoteControllingStatus ( unsigned int shareSourceID )

pure virtual

Determine if the current user is controlling the specified user remotely.

Parameters

shareSourceID Specify the share scource ID to check.

Returns: If the specified user is in process of remote control, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, see SDKError enum.

◆ LeaveRemoteControllingStatus()

virtual SDKError IMeetingRemoteController::LeaveRemoteControllingStatus ( unsigned int shareSourceID )

pure virtual

Stop controlling remotely.

Parameters

shareSourceID Specify the share scource ID that you want to end the remote control.

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

◆ RequestRemoteControl()

virtual SDKError IMeetingRemoteController::RequestRemoteControl ( unsigned int shareSourceID )

pure virtual

Request to remotely control the specified user.

Parameters

shareSourceID Specify the share scource ID that you want to send the request.

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

◆ RevokeRemoteControl()

virtual SDKError IMeetingRemoteController::RevokeRemoteControl ( )

pure virtual

Get back all the authority of remote control.

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

◆ SetEvent()

virtual SDKError IMeetingRemoteController::SetEvent ( IMeetingRemoteCtrlEvent * pEvent )

pure virtual

Set meeting remote control callback event handler.

Parameters

pEvent A pointer to the IMeetingRemoteCtrlEvent that receives the remote control event.

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

Remarks: When the remote control or the authority changes, the user will receive a callback event.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IMeetingRemoteController()

Member Function Documentation

◆ CanEnableAutoAcceptRemoteControlFeature()

◆ CanRequestControl()

◆ DeclineRemoteControlRequest()

◆ EnableAutoAcceptRemoteControlFeature()

◆ EnterRemoteControllingStatus()

◆ GetCurrentRemoteController()

◆ GiveRemoteControlTo()

◆ GiveupRemoteControl()

◆ IsAutoAcceptRemoteControlFeatureEnabled()

◆ IsHaveRemoteControlRight()

◆ IsInRemoteControllingStatus()

◆ LeaveRemoteControllingStatus()

◆ RequestRemoteControl()

◆ RevokeRemoteControl()

◆ SetEvent()