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

#include <zoom_video_sdk_share_helper_interface.h>

Public Member Functions

virtual ~IZoomVideoSDKShareAction ()
 
virtual unsigned int getShareSourceId ()=0
 Get share source ID.
 
virtual IZoomVideoSDKCanvasgetShareCanvas ()=0
 Get the render canvas object.
 
virtual IZoomVideoSDKRawDataPipegetSharePipe ()=0
 Get share raw data pipe.
 
virtual ZoomVideoSDKShareStatus getShareStatus ()=0
 Get share status.
 
virtual ZoomVideoSDKSubscribeFailReason getSubscribeFailReason ()=0
 Get subscribe fail reason.
 
virtual bool isAnnotationPrivilegeEnabled ()=0
 Determine whether annotation privilege is enabled.
 
virtual ZoomVideoSDKShareType getShareType ()=0
 Get share type.
 
virtual ZoomVideoSDKViewSize getShareSourceContentSize ()=0
 Get the size of the share content.
 
virtual IZoomVideoSDKRemoteControlHelpergetRemoteControlHelper ()=0
 Get the helper class instance to access remote control. Only available for controller side.
 
virtual IVideoSDKVector< IZoomVideoSDKUser * > * getRemoteControlApprovedUserList ()=0
 Get the list of users I have agreed to control. Only available for the controlling user.
 
virtual ZoomVideoSDKErrors revokeRemoteControl ()=0
 Get back all the authority of remote control. Only available for the user themselves.
 
virtual IZoomVideoSDKUsergetCurrentRemoteController ()=0
 Get the controller ID who is currently controlling me. Only available for the controlled user.
 

Detailed Description

Definition at line 214 of file zoom_video_sdk_share_helper_interface.h.

Constructor & Destructor Documentation

◆ ~IZoomVideoSDKShareAction()

virtual IZoomVideoSDKShareAction::~IZoomVideoSDKShareAction ( )
inlinevirtual

Definition at line 217 of file zoom_video_sdk_share_helper_interface.h.

217{}

Member Function Documentation

◆ getCurrentRemoteController()

virtual IZoomVideoSDKUser * IZoomVideoSDKShareAction::getCurrentRemoteController ( )
pure virtual

Get the controller ID who is currently controlling me. Only available for the controlled user.

Returns
If the function succeeds, the return value is the user object. Otherwise nullptr.

◆ getRemoteControlApprovedUserList()

virtual IVideoSDKVector< IZoomVideoSDKUser * > * IZoomVideoSDKShareAction::getRemoteControlApprovedUserList ( )
pure virtual

Get the list of users I have agreed to control. Only available for the controlling user.

Returns
If the function succeeds, the return value is the list of users I have agreed to control. Otherwise returns nullptr.

◆ getRemoteControlHelper()

virtual IZoomVideoSDKRemoteControlHelper * IZoomVideoSDKShareAction::getRemoteControlHelper ( )
pure virtual

Get the helper class instance to access remote control. Only available for controller side.

Returns
If the function succeeds, the return value is the remote control helper object. Otherwise returns nullptr. For more details, see IZoomVideoSDKRemoteControlHelper.

◆ getShareCanvas()

virtual IZoomVideoSDKCanvas * IZoomVideoSDKShareAction::getShareCanvas ( )
pure virtual

Get the render canvas object.

Returns
If the function succeeds, the return value is the share render helper object. Otherwise, this function fails and returns nullptr. For more details, see IZoomVideoSDKCanvas.

◆ getSharePipe()

virtual IZoomVideoSDKRawDataPipe * IZoomVideoSDKShareAction::getSharePipe ( )
pure virtual

Get share raw data pipe.

Returns
The share pipe. For more information, see IZoomVideoSDKRawDataPipe

◆ getShareSourceContentSize()

virtual ZoomVideoSDKViewSize IZoomVideoSDKShareAction::getShareSourceContentSize ( )
pure virtual

Get the size of the share content.

Returns
The size of share content.

◆ getShareSourceId()

virtual unsigned int IZoomVideoSDKShareAction::getShareSourceId ( )
pure virtual

Get share source ID.

Returns
The user ID of the user object.

◆ getShareStatus()

virtual ZoomVideoSDKShareStatus IZoomVideoSDKShareAction::getShareStatus ( )
pure virtual

Get share status.

Returns
Share status of the share object.

◆ getShareType()

virtual ZoomVideoSDKShareType IZoomVideoSDKShareAction::getShareType ( )
pure virtual

Get share type.

Returns
Share type of the share object.

◆ getSubscribeFailReason()

virtual ZoomVideoSDKSubscribeFailReason IZoomVideoSDKShareAction::getSubscribeFailReason ( )
pure virtual

Get subscribe fail reason.

Returns
failed reason of the subscription.

◆ isAnnotationPrivilegeEnabled()

virtual bool IZoomVideoSDKShareAction::isAnnotationPrivilegeEnabled ( )
pure virtual

Determine whether annotation privilege is enabled.

Returns
True indicates that annotation privilege is enabled, otherwise false.

◆ revokeRemoteControl()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareAction::revokeRemoteControl ( )
pure virtual

Get back all the authority of remote control. Only available for the user themselves.

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