Video SDK for Windows API Reference
Loading...
Searching...
No Matches
IZoomVideoSDKRemoteControlHelper Class Referenceabstract

Video SDK remote control interface. More...

#include <zoom_video_sdk_share_helper_interface.h>

Public Member Functions

virtual ~IZoomVideoSDKRemoteControlHelper ()
 
virtual bool canRequestControl ()=0
 Determine if the user is able to ask to remote control the specified user.
 
virtual ZoomVideoSDKErrors requestRemoteControl ()=0
 Send the remote control request to the specified user.
 
virtual ZoomVideoSDKErrors endRemoteControl ()=0
 End the remote control of the specified user.
 
virtual bool canRemoteControl ()=0
 Determine if the user is able to remote control the specified user.
 
virtual ZoomVideoSDKErrors enterRemoteControl ()=0
 Remote control the specified user.
 
virtual bool isRemoteControlling ()=0
 Determine if the specified user is in the process of being remotely controlled.
 
virtual ZoomVideoSDKErrors leaveRemoteControl ()=0
 The user has temporarily paused remote control, to continue, there is no need to request remote control again.
 

Detailed Description

Video SDK remote control interface.

Definition at line 150 of file zoom_video_sdk_share_helper_interface.h.

Constructor & Destructor Documentation

◆ ~IZoomVideoSDKRemoteControlHelper()

virtual IZoomVideoSDKRemoteControlHelper::~IZoomVideoSDKRemoteControlHelper ( )
inlinevirtual

Definition at line 153 of file zoom_video_sdk_share_helper_interface.h.

153{}

Member Function Documentation

◆ canRemoteControl()

virtual bool IZoomVideoSDKRemoteControlHelper::canRemoteControl ( )
pure virtual

Determine if the user is able to remote control the specified user.

Returns
If the user is able to remote control the specified user, the return value is true. Otherwise false.

◆ canRequestControl()

virtual bool IZoomVideoSDKRemoteControlHelper::canRequestControl ( )
pure virtual

Determine if the user is able to ask to remote control the specified user.

Remarks
For custom style mode, this interface is only valid after subscribing to the content to be shared by the specified user by calling ICustomizedShareRender::SetUserID(unsigned int userid) successfully.
Returns
If the user is able to request to remote control the specified user, the return value is true. Otherwise false.

◆ endRemoteControl()

virtual ZoomVideoSDKErrors IZoomVideoSDKRemoteControlHelper::endRemoteControl ( )
pure virtual

End the remote control of the specified user.

Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

◆ enterRemoteControl()

virtual ZoomVideoSDKErrors IZoomVideoSDKRemoteControlHelper::enterRemoteControl ( )
pure virtual

Remote control the specified user.

Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

◆ isRemoteControlling()

virtual bool IZoomVideoSDKRemoteControlHelper::isRemoteControlling ( )
pure virtual

Determine if the specified user is in the process of being remotely controlled.

Returns
If the specified user is being remotely controled, the return value is true. Otherwise false.

◆ leaveRemoteControl()

virtual ZoomVideoSDKErrors IZoomVideoSDKRemoteControlHelper::leaveRemoteControl ( )
pure virtual

The user has temporarily paused remote control, to continue, there is no need to request remote control again.

Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

◆ requestRemoteControl()

virtual ZoomVideoSDKErrors IZoomVideoSDKRemoteControlHelper::requestRemoteControl ( )
pure virtual

Send the remote control request to the specified user.

Returns
If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.