ZMVideoSDKShareAction Class Reference

Represents the state and control interfaces of a share action in a Zoom session. More...

#include <ZMVideoSDKShareHelper.h>

Inherits NSObject.

Instance Methods
(NSSize)	- getShareSourceContentSize
	Get the size of the share content.
(ZMVideoSDKRawDataPipe *_Nullable)	- getSharePipe
	Get the share raw data pipe.
(ZMVideoSDKVideoCanvas *_Nullable)	- getShareCanvas
	Gets the render canvas object.
(ZMVideoSDKRemoteControlHelper *_Nullable)	- getRemoteControlHelper
	Get the helper class instance to access remote control. Only available for controller side.
(NSArray< ZMVideoSDKUser * > *_Nullable)	- getRemoteControlApprovedUserList
	Get the list of users I (the controlling user) have agreed to control. Only available for the controlling user.
(ZMVideoSDKErrors)	- revokeRemoteControl
	Get back all the authority of remote control. Only available for the user themselves.
(ZMVideoSDKUser *_Nullable)	- getCurrentRemoteController
	Get the controller ID who is currently controlling me (the controlled user). Only available for the controlled user.

Properties
unsigned int	shareSourceId
	Share source ID.
ZMVideoSDKShareStatus	shareStatus
	Share status.
ZMVideoSDKShareType	shareType
	Share type.
ZMVideoSDKShareCapturePauseReason	shareCapturePauseReason
	Gets the reason why the share capture is paused.
ZMVideoSDKSubscribeFailReason	subscribeFailReason
	The subscribe fail reason.
BOOL	isAnnotationPrivilegeEnabled
	Determine whether annotation privilege is enabled.

Detailed Description

Represents the state and control interfaces of a share action in a Zoom session.

Definition at line 74 of file ZMVideoSDKShareHelper.h.

Method Documentation

getCurrentRemoteController

- (ZMVideoSDKUser *_Nullable) getCurrentRemoteController

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

Returns

If the function succeeds, the return value is the user currently controlling by long-distance. Otherwise returns nil.

getRemoteControlApprovedUserList

- (NSArray< ZMVideoSDKUser * > *_Nullable) getRemoteControlApprovedUserList

Get the list of users I (the controlling user) 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 nil.

getRemoteControlHelper

- (ZMVideoSDKRemoteControlHelper *_Nullable) getRemoteControlHelper

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

Returns

If the function succeeds, it will return the remote control helper object. Otherwise returns nil.

getShareCanvas

- (ZMVideoSDKVideoCanvas *_Nullable) getShareCanvas

Gets the render canvas object.

Returns

If the function succeeds, the return value is the ZMVideoSDKVideoCanvas object. Otherwise this function fails and returns nil.

getSharePipe

- (ZMVideoSDKRawDataPipe *_Nullable) getSharePipe

Get the share raw data pipe.

Returns

If the function succeeds, the return value is the share pipe object. Otherwise this function fails and returns nil.

getShareSourceContentSize

- (NSSize) getShareSourceContentSize

Get the size of the share content.

Returns

The size of share content.

revokeRemoteControl

- (ZMVideoSDKErrors) revokeRemoteControl

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

Returns

If the function succeeds, the return value is ZMVideoSDKErrors_Success. Otherwise failed.

Property Documentation

isAnnotationPrivilegeEnabled

- (BOOL) isAnnotationPrivilegeEnabled

readnonatomicassign

Determine whether annotation privilege is enabled.

Definition at line 100 of file ZMVideoSDKShareHelper.h.

shareCapturePauseReason

- (ZMVideoSDKShareCapturePauseReason) shareCapturePauseReason

readnonatomicassign

Gets the reason why the share capture is paused.

Note

If sharing is not paused, the return value is ZMVideoSDKShare_Capture_Pause_None.

Definition at line 91 of file ZMVideoSDKShareHelper.h.

shareSourceId

- (unsigned int) shareSourceId

readnonatomicassign

Share source ID.

Definition at line 78 of file ZMVideoSDKShareHelper.h.

shareStatus

- (ZMVideoSDKShareStatus) shareStatus

readnonatomicassign

Share status.

Definition at line 82 of file ZMVideoSDKShareHelper.h.

shareType

- (ZMVideoSDKShareType) shareType

readnonatomicassign

Share type.

Definition at line 86 of file ZMVideoSDKShareHelper.h.

subscribeFailReason

- (ZMVideoSDKSubscribeFailReason) subscribeFailReason

readnonatomicassign

The subscribe fail reason.

Definition at line 96 of file ZMVideoSDKShareHelper.h.