Meeting SDK for Windows API Reference
Loading...
Searching...
No Matches
meeting_remote_ctrl_interface.h
Go to the documentation of this file.
1
6#ifndef _MEETING_REMOTE_CTRL_INTERFACE_H_
7#define _MEETING_REMOTE_CTRL_INTERFACE_H_
8#include "zoom_sdk_def.h"
9
28
32{
33public:
38 virtual void onRemoteControlStatus(RemoteControlStatus status, unsigned int userID, unsigned int shareSourceID) = 0;
39
42 virtual void onUserRemoteControlForbidden(unsigned int userID) = 0;
43};
44
48{
49public:
51
58
64 virtual SDKError CanRequestControl(unsigned int shareSourceID) = 0;
65
70 virtual SDKError IsHaveRemoteControlRight(unsigned int shareSourceID) = 0;
71
76 virtual SDKError IsInRemoteControllingStatus(unsigned int shareSourceID) = 0;
77
82 virtual SDKError EnterRemoteControllingStatus(unsigned int shareSourceID) = 0;
83
88 virtual SDKError LeaveRemoteControllingStatus(unsigned int shareSourceID) = 0;
89
94 virtual SDKError RequestRemoteControl(unsigned int shareSourceID) = 0;
95
100 virtual SDKError GiveupRemoteControl(unsigned int shareSourceID) = 0;
101
106 virtual SDKError GiveRemoteControlTo(unsigned int userId) = 0;
107
112 virtual SDKError DeclineRemoteControlRequest(unsigned int userId) = 0;
113
118
123 virtual SDKError GetCurrentRemoteController(unsigned int& userId) = 0;
124
128
132
138};
140#endif
Meeting remote control interface.
virtual SDKError RequestRemoteControl(unsigned int shareSourceID)=0
Request to remotely control the specified user.
virtual SDKError GiveRemoteControlTo(unsigned int userId)=0
Give the authority of remote control to the specified user.
virtual SDKError IsInRemoteControllingStatus(unsigned int shareSourceID)=0
Determine if the current user is controlling the specified user remotely.
virtual SDKError RevokeRemoteControl()=0
Get back all the authority of remote control.
virtual bool IsAutoAcceptRemoteControlFeatureEnabled()=0
Determine if the auto accept remote control requests feature is enabled in the meeting.
virtual SDKError LeaveRemoteControllingStatus(unsigned int shareSourceID)=0
Stop controlling remotely.
virtual SDKError EnterRemoteControllingStatus(unsigned int shareSourceID)=0
Start remotely controlling the specified user's computer.
virtual SDKError GetCurrentRemoteController(unsigned int &userId)=0
Get the controller ID who is currently controlling by long-distance.
virtual SDKError CanEnableAutoAcceptRemoteControlFeature()=0
Whether the current user can enable the auto accept remote control requests feature.
virtual SDKError IsHaveRemoteControlRight(unsigned int shareSourceID)=0
Determine if the user has privileges to control the specified user remotely..
virtual SDKError CanRequestControl(unsigned int shareSourceID)=0
Determine if the current user is able to request to control others remotely.
virtual SDKError GiveupRemoteControl(unsigned int shareSourceID)=0
Give up remotely controlling the specified user.
virtual SDKError SetEvent(IMeetingRemoteCtrlEvent *pEvent)=0
Set meeting remote control callback event handler.
virtual SDKError DeclineRemoteControlRequest(unsigned int userId)=0
Refuse the request to remote control from the specified user.
virtual SDKError EnableAutoAcceptRemoteControlFeature(bool bEnable)=0
Enable or disable auto accept remote control requests feature.
Meeting remote control callback event.
virtual void onUserRemoteControlForbidden(unsigned int userID)=0
Callback event when the request of remote control is forbidden for guest user.
virtual void onRemoteControlStatus(RemoteControlStatus status, unsigned int userID, unsigned int shareSourceID)=0
Callback event of notification of the remote control status.
RemoteControlStatus
Information category for authority and status changes during the remote Control. Here are more detail...
@ Remote_Control_Who_Can_Control_Me
The status of remote control. I can be controlled by whom.
@ Remote_Control_I_Can_Control_Who_End
The authority of remote control. I lose control when remote control ends.
@ Remote_Control_I_Recv_Decline_Msg
Remote control information. I have received a refused information of remote control.
@ Remote_Control_I_Control_Who_Begin
The status of remote control. I am in the status of remote control.
@ Remote_Control_I_Can_Request_Control_Who
Remote control information. I can enable the remote control.
@ Remote_Control_I_Recv_Request_Msg
Remote control information. I have received an information of request for remote control.
@ Remote_Control_None
For initialization.
@ Remote_Control_I_Control_Who_End
The status of remote control. I am out of the remote control.
@ Remote_Control_I_Can_Control_Who_Begin
The authority of remote control. I get control when remote control begins.
@ Remote_Control_Who_Control_Me
The status of remote control. I am controlled by whom.
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
#define BEGIN_ZOOM_SDK_NAMESPACE
SDKError
Enumeration of common errors of SDK.