ZOOM Windows SDK  5.2.41727.0928
Public Member Functions | List of all members
IMeetingRemoteController Class Referenceabstract

Meeting remote control interface. More...

#include <meeting_remote_ctrl_interface.h>

Public Member Functions

virtual SDKError SetEvent (IMeetingRemoteCtrlEvent *pEvent)=0
 Set meeting remote control callback event handler. More...
 
virtual SDKError CanRequestControl (unsigned int userId)=0
 Determine if it is able to ask for controlling the specified user by long-distance. More...
 
virtual SDKError IsHaveRemoteControlRight (unsigned int userId)=0
 Determine if it is able to control the specified user by long-distance. More...
 
virtual SDKError IsInRemoteControllingStatus (unsigned int userId)=0
 Determine if the specified user is in process of remote control. More...
 
virtual SDKError EnterRemoteControllingStatus (unsigned int userId)=0
 Control the specified user by long-distance. More...
 
virtual SDKError LeaveRemoteControllingStatus (unsigned int userId)=0
 End controlling the specified user by long distance. More...
 
virtual SDKError RequestRemoteControl (unsigned int userId)=0
 Send the request of remote control to the specified user. More...
 
virtual SDKError GiveupRemoteControl (unsigned int userId)=0
 Abandon the remote control to the specified user. More...
 
virtual SDKError GiveRemoteControlTo (unsigned int userId)=0
 Give the authority of remote control to the specified user. More...
 
virtual SDKError DeclineRemoteControlRequest (unsigned int userId)=0
 Refuse the request to remote control from the specified user. More...
 
virtual SDKError RevokeRemoteControl ()=0
 Get back all the authority of remote control. More...
 
virtual SDKError GetCurrentRemoteController (unsigned int &userId)=0
 Get the controller ID who is currently controlling by long-distance. More...
 

Detailed Description

Meeting remote control interface.

Member Function Documentation

◆ CanRequestControl()

virtual SDKError IMeetingRemoteController::CanRequestControl ( unsigned int  userId)
pure virtual

Determine if it is able to ask for controlling the specified user by long-distance.

Parameters
userIdSpecify the user ID to check.
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
userIdSpecify the user 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.

◆ EnterRemoteControllingStatus()

virtual SDKError IMeetingRemoteController::EnterRemoteControllingStatus ( unsigned int  userId)
pure virtual

Control the specified user by long-distance.

Parameters
userIdSpecify the user 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]userIdThe 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
userIdSpecify 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  userId)
pure virtual

Abandon the remote control to the specified user.

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

◆ IsHaveRemoteControlRight()

virtual SDKError IMeetingRemoteController::IsHaveRemoteControlRight ( unsigned int  userId)
pure virtual

Determine if it is able to control the specified user by long-distance.

Parameters
userIdSpecify the user 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  userId)
pure virtual

Determine if the specified user is in process of remote control.

Parameters
userIdSpecify the user 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  userId)
pure virtual

End controlling the specified user by long distance.

Parameters
userIdSpecify the user 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  userId)
pure virtual

Send the request of remote control to the specified user.

Parameters
userIdSpecify the user 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
pEventA 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.

The documentation for this class was generated from the following file: