IZoomVideoSDKShareAction Class Reference

#include <zoom_video_sdk_share_helper_interface.h>

Public Member Functions
virtual	~IZoomVideoSDKShareAction ()
virtual unsigned int	getShareSourceId ()=0
	Get share source ID.
virtual IZoomVideoSDKCanvas *	getShareCanvas ()=0
	Get the render canvas object.
virtual IZoomVideoSDKRawDataPipe *	getSharePipe ()=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.

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.

{}

Member Function Documentation

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.