ZoomVideoSDKShareAction Class Reference

Share raw data pipe interface. More...

#include <ZoomVideoSDKShareHelper.h>

Inherits NSObject.

Instance Methods
(NSInteger)	- getShareSourceId
	Get share source ID.
(ZoomVideoSDKVideoCanvas *_Nullable)	- getShareCanvas
	Get the render canvas object.
(ZoomVideoSDKReceiveSharingStatus)	- getShareStatus
	Get the share status.
(ZoomVideoSDKRawDataPipe *_Nullable)	- getSharePipe
	Get the share raw data pipe.
(ZoomVideoSDKSubscribeFailReason)	- getSubscribeFailReason
	Get the subscribe fail reason.
(BOOL)	- isAnnotationPrivilegeEnabled
	Determine whether annotation privilege is enabled.
(ZoomVideoSDKShareType)	- getShareType
	Get the share type.
(CGSize)	- getShareSourceContentSize
	Get the size of the share content.

Detailed Description

Share raw data pipe interface.

Definition at line 34 of file ZoomVideoSDKShareHelper.h.

Method Documentation

getShareCanvas

- (ZoomVideoSDKVideoCanvas *_Nullable) getShareCanvas

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 NULL.

References ZoomVideoSDKShareStatus::sharingStatus.

getSharePipe

- (ZoomVideoSDKRawDataPipe *_Nullable) getSharePipe

Get the share raw data pipe.

Returns

The share pipe.

getShareSourceContentSize

- (CGSize) getShareSourceContentSize

Get the size of the share content.

Returns

The size of share content.

getShareSourceId

- (NSInteger) getShareSourceId

Get share source ID.

Returns

The user ID of the user object.

getShareStatus

- (ZoomVideoSDKReceiveSharingStatus) getShareStatus

Get the share status.

Returns

Share status of the share object.

getShareType

- (ZoomVideoSDKShareType) getShareType

Get the share type.

Returns

Share type of the share object.

getSubscribeFailReason

- (ZoomVideoSDKSubscribeFailReason) getSubscribeFailReason

Get the subscribe fail reason.

Returns

failed reason of the subscription.

isAnnotationPrivilegeEnabled

- (BOOL) isAnnotationPrivilegeEnabled

Determine whether annotation privilege is enabled.

Returns

YES indicates that annotation privilege is enabled, otherwise false.