Video SDK for iOS API Reference
All Classes Files Functions Enumerations Enumerator Properties
ZoomVideoSDKShareAction Class Reference

#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

Definition at line 30 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. For more details, see ZoomVideoSDKVideoCanvas.

◆ getSharePipe

- (ZoomVideoSDKRawDataPipe *_Nullable) getSharePipe

Get the share raw data pipe.

Returns
The share pipe. For more information, see ZoomVideoSDKRawDataPipe

◆ 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

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.