Video SDK for iOS API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKShareAction Class Reference

Share raw data pipe interface. More...

#include <ZoomVideoSDKShareHelper.h>

Inherits NSObject.

Instance Methods

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

Detailed Description

Share raw data pipe interface.

Definition at line 31 of file ZoomVideoSDKShareHelper.h.

Method Documentation

◆ getShareCanvas

- (ZoomVideoSDKVideoCanvas *_Nullable) getShareCanvas

Gets the render canvas object.

Returns
If the function succeeds, it returns a ZoomVideoSDKVideoCanvas object. Otherwise, this function fails and returns nil.

References getShareCanvas.

Referenced by getShareCanvas.

◆ getSharePipe

- (ZoomVideoSDKRawDataPipe *_Nullable) getSharePipe

Gets the share raw data pipe.

Returns
If the function succeeds, it returns a ZoomVideoSDKRawDataPipe object. Otherwise, this function fails and returns nil.

References getSharePipe.

Referenced by getSharePipe.

◆ getShareSourceContentSize

- (CGSize) getShareSourceContentSize

Gets the size of the share content.

Returns
The size of share content.

References getShareSourceContentSize.

Referenced by getShareSourceContentSize.

◆ getShareSourceId

- (NSInteger) getShareSourceId

Gets the share source ID.

Returns
The user ID of the user object.

References getShareSourceId.

Referenced by getShareSourceId.

◆ getShareStatus

Gets the share status.

Returns
Share status of the share object.

References getShareStatus.

Referenced by getShareStatus.

◆ getShareType

- (ZoomVideoSDKShareType) getShareType

Gets the share type.

Returns
Share type of the share object.

References getShareType.

Referenced by getShareType.

◆ getSubscribeFailReason

- (ZoomVideoSDKSubscribeFailReason) getSubscribeFailReason

Gets the subscribe fail reason.

Returns
Failed reason of the subscription.

References getSubscribeFailReason.

Referenced by getSubscribeFailReason.

◆ isAnnotationPrivilegeEnabled

- (BOOL) isAnnotationPrivilegeEnabled

Determines whether annotation privilege is enabled.

Returns
YES if annotation privilege is enabled. Otherwise, NO.

References isAnnotationPrivilegeEnabled.

Referenced by isAnnotationPrivilegeEnabled.