Share control interface. More...

#include <ZoomVideoSDKShareHelper.h>

Inherits NSObject.

Instance Methods
(ZoomVideoSDKError)	- startShareWithView:
	Share a selected view.

(ZoomVideoSDKError)	- startSharingExternalSource:andAudioSource:
	Share an external source.

(ZoomVideoSDKError)	- startSharingExternalSource:andAudioSource:isPlaying:
	Share an external source.

(ZoomVideoSDKError)	- enablePlaySharingAudioRawdata:
	Enable or disable local playback of shared audio raw data.

(ZoomVideoSDKError)	- stopShare
	Stop view or screen share.

(ZoomVideoSDKError)	- pauseShare
	Pause share. For camera share, the presenter can pause the share to support annotation.

(ZoomVideoSDKError)	- resumeShare
	Resume share. For camera share, the presenter can restart the camera share.

(ZoomVideoSDKError)	- lockShare:
	Lock sharing the view or screen. Only the host can call this method.

(BOOL)	- isShareLocked
	Determine whether sharing the view or screen is locked.

(BOOL)	- isSharingOut
	Determine whether the current user is sharing.

(BOOL)	- isOtherSharing
	Determine whether other user is sharing.

(BOOL)	- isScreenSharingOut
	Determine whether the current user is sharing the screen.

(BOOL)	- isShareDeviceAudioEnabled
	Determine if the SDK has enabled share device audio when screen sharing.

(BOOL)	- enableShareDeviceAudio:
	Enable or disable the device audio shared together when screen sharing.

(BOOL)	- isAnnotationFeatureSupport
	Whether annotation feature is supported or not.

(ZoomVideoSDKError)	- disableViewerAnnotation:
	Disable or enable viewer’s annotation by the share owner.

(BOOL)	- isViewerAnnotationDisabled
	Whether annotation on current sharing is disabled or not.

(ZoomVideoSDKAnnotationHelper *_Nullable)	- createAnnotationHelper:
	Creates annotation helper based on shared view.

(ZoomVideoSDKError)	- destroyAnnotationHelper:
	Destroys annotation helper.

(ZoomVideoSDKError)	- enableMultiShare:
	Enable or disable participants can share simultaneously.

(BOOL)	- isMultiShareEnabled
	Determine whether multi share is enabled or not.

(ZoomVideoSDKError)	- startShareCamera:
	Share the select camera. Query the select camera using ZoomVideoSDKVideoHelper::getCameraDeviceList.

(ZoomVideoSDKError)	- startShareWithPreprocessing:sharePreprocessor:
	Start share preprocessing.

(ZoomVideoSDKError)	- applyPreprocessingOverlayImage:
	Apply a UIImage overlay to the shared image stream when using (when you share with `startShareWithPreprocessing:sharePreprocessor:` or `startInAppScreenShare`). Use this method to cover the shared content with an image during preprocessing.

(void)	- removePreprocessingOverlayImage
	Remove the currently applied UIImage overlay from the shared image stream when using (when you share with `startShareWithPreprocessing:sharePreprocessor:` or `startInAppScreenShare`).

(BOOL)	- isSupportInAppScreenShare
	Check that the system supports in-app screen share or not.

(ZoomVideoSDKError)	- startInAppScreenShare
	Start in-app screen share.

Detailed Description

Share control interface.

Definition at line 111 of file ZoomVideoSDKShareHelper.h.

Method Documentation

◆ applyPreprocessingOverlayImage:

- (ZoomVideoSDKError) applyPreprocessingOverlayImage: (UIImage *_Nullable) image

Apply a UIImage overlay to the shared image stream when using (when you share with startShareWithPreprocessing:sharePreprocessor: or startInAppScreenShare). Use this method to cover the shared content with an image during preprocessing.

Parameters

image The UIImage to overlay on top of the shared image. The UIImage is fully coverd the current share frame before it is sent to viewers.

Returns: If the function succeeds, the return value is Errors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKError.

◆ createAnnotationHelper:

- (ZoomVideoSDKAnnotationHelper *_Nullable) createAnnotationHelper: (UIView *_Nullable) view

Creates annotation helper based on shared view.

Parameters

view	the shared view. Pass the nil will return the helper for self sharing.

Returns: The result of it.

Warning: The view passed in this function should be subscribed share view. And if the share view aspect mode is full fill, the annotate not supported. When the share owner not support the feature of annotate, the others should not do annotate in that case.

◆ destroyAnnotationHelper:

- (ZoomVideoSDKError) destroyAnnotationHelper: (ZoomVideoSDKAnnotationHelper *_Nullable) helper

Destroys annotation helper.

Parameters

helper ZoomVideoSDKAnnotationHelper.

Returns: The result of it.

◆ disableViewerAnnotation:

- (ZoomVideoSDKError) disableViewerAnnotation: (BOOL) disable

Disable or enable viewer’s annotation by the share owner.

Parameters

disable YES means annotation is disabled, NO means it is enabled.

Returns: The result of this.

Warning: Only the share owner can call this function.

◆ enableMultiShare:

- (ZoomVideoSDKError) enableMultiShare: (BOOL) enable

Enable or disable participants can share simultaneously.

Parameters

enable True to enable. False to disable.

Returns: If the function succeeds, the return value is Errors_Success.

Warning: When you switch multi share from enable to disable, all sharing will be stopped.

◆ enablePlaySharingAudioRawdata:

- (ZoomVideoSDKError) enablePlaySharingAudioRawdata: (BOOL) bPlay

Enable or disable local playback of shared audio raw data.

Parameters

bPlay YES to play shared audio raw data, NO not to play it.

Returns: If the function succeeds, it will return Errors_Success. Otherwise failed.

◆ enableShareDeviceAudio:

- (BOOL) enableShareDeviceAudio: (BOOL) enable

Enable or disable the device audio shared together when screen sharing.

Parameters

enable share audio out or not.

Returns: The result of it.

◆ isAnnotationFeatureSupport

- (BOOL) isAnnotationFeatureSupport

Whether annotation feature is supported or not.

Returns: The result of it.

◆ isMultiShareEnabled

- (BOOL) isMultiShareEnabled

Determine whether multi share is enabled or not.

Returns: YES enabled, NO not enabled.

◆ isOtherSharing

- (BOOL) isOtherSharing

Determine whether other user is sharing.

Returns: YES indicates another user is sharing, otherwise NO.

◆ isScreenSharingOut

- (BOOL) isScreenSharingOut

Determine whether the current user is sharing the screen.

Returns: YES indicates the current user is sharing the screen, otherwise NO.

◆ isShareDeviceAudioEnabled

- (BOOL) isShareDeviceAudioEnabled

Determine if the SDK has enabled share device audio when screen sharing.

Returns: The result of it.

◆ isShareLocked

- (BOOL) isShareLocked

Determine whether sharing the view or screen is locked.

Returns: YES indicates that sharing is locked, otherwise NO.

◆ isSharingOut

- (BOOL) isSharingOut

Determine whether the current user is sharing.

Returns: YES indicates the current user is sharing, otherwise NO.

◆ isSupportInAppScreenShare

- (BOOL) isSupportInAppScreenShare

Check that the system supports in-app screen share or not.

Returns: return whether the device supports in-app screen share or not. Please refer to RPScreenRecorder.

◆ isViewerAnnotationDisabled

- (BOOL) isViewerAnnotationDisabled

Whether annotation on current sharing is disabled or not.

Returns: The result of this.

Warning: Only the share owner can call this function.

◆ lockShare:

- (ZoomVideoSDKError) lockShare: (BOOL) lock

Lock sharing the view or screen. Only the host can call this method.

Parameters

lock	YES to lock sharing.

Returns: If the function succeeds, the return value is Errors_Success. Otherwise failed.

Warning: Only Host/Manger can call the function.

◆ pauseShare

- (ZoomVideoSDKError) pauseShare

Pause share. For camera share, the presenter can pause the share to support annotation.

Returns: If the function succeeds, the return value is Errors_Success. Otherwise failed.

◆ removePreprocessingOverlayImage

- (void) removePreprocessingOverlayImage

Remove the currently applied UIImage overlay from the shared image stream when using (when you share with startShareWithPreprocessing:sharePreprocessor: or startInAppScreenShare).

Note: Once removed, the raw shared content is sent directly to viewers without any overlay. Call this method when you no longer need to display the overlay (for example, when a covered image is no longer required).

◆ resumeShare

- (ZoomVideoSDKError) resumeShare

Resume share. For camera share, the presenter can restart the camera share.

Returns: If the function succeeds, the return value is Errors_Success. Otherwise failed.

◆ startInAppScreenShare

- (ZoomVideoSDKError) startInAppScreenShare

Start in-app screen share.

Returns: If the function succeeds, the return value is Errors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKError.

Warning: Can only be called once every 500ms.

◆ startShareCamera:

- (ZoomVideoSDKError) startShareCamera: (visionos) API_UNAVAILABLE

Share the select camera. Query the select camera using ZoomVideoSDKVideoHelper::getCameraDeviceList.

Parameters

parentView the share view to show the camera for the presenter.

Returns: If the function succeeds, the return value is Errors_Success. Otherwise failed.

Note: The presenter can use ZoomVideoSDKShareHelper::pauseShare to enable viewer annotation. If the camera is paused, the presenter can use ZoomVideoSDKShareHelper::resumeShare to resume. Notice: The user should start video before start share camera, otherwise the error Errors_Session_Share_Camera_Video_Not_Start.

◆ startShareWithPreprocessing:sharePreprocessor:

- (ZoomVideoSDKError) startShareWithPreprocessing:		(ZoomVideoSDKSharePreprocessParam *_Nullable)	param
sharePreprocessor:		(id< ZoomVideoSDKSharePreprocessor > _Nullable)	preProcessDelegate

Start share preprocessing.

Parameters

param	The share preprocessing parameters.
preProcessDelegate	Object that handles preprocessing events.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise this function fails. To get extended error information, see ZoomVideoSDKErrors enum.

Note: If pAudioSource is non-null, it means share user-defined audio at the same time.; This share type should using the CptShare.framework, zm_annoter_dynamic.framework.

◆ startShareWithView:

- (ZoomVideoSDKError) startShareWithView: (UIView *_Nullable) view

Share a selected view.

Parameters

view	The view to be shared.

Warning: view, recommend to pass a single UIView's object, such as UIView, UIImageView or WKWebView.; It is not recommended to pass UIView after add subview WKWebView or UIImageView.

Returns: If the function succeeds, the return value is Errors_Success. Otherwise failed. To get extended error information, see [ZoomVideoSDKError].

◆ startSharingExternalSource:andAudioSource:

- (ZoomVideoSDKError) startSharingExternalSource:		(id< ZoomVideoSDKShareSource > _Nullable)	shareDelegate
andAudioSource:		(id< ZoomVideoSDKShareAudioSource > _Nullable)	audioDelegate

Share an external source.

Parameters

shareDelegate	External share source.
audioDelegate	External share audio source.

Returns: If the function succeeds, it will return Errors_Success.Otherwise failed. To get extended error information, see [ZoomVideoSDKError].

Warning: If audioDelegate is non-null, it means share user-defined audio at the same time.

Deprecated: Use startSharingExternalSource:andAudioSource:isPlaying: instead.

◆ startSharingExternalSource:andAudioSource:isPlaying:

- (ZoomVideoSDKError) startSharingExternalSource:	(id< ZoomVideoSDKShareSource > _Nullable)	shareDelegate
andAudioSource:	(id< ZoomVideoSDKShareAudioSource > _Nullable)	audioDelegate
isPlaying:	(BOOL)	isPlaying

Share an external source.

Parameters

shareDelegate	External share source.
audioDelegate	External share audio source.
isPlaying	YES to play shared audio raw data, false not to play.

Returns: If the function succeeds, it will return Errors_Success.Otherwise failed. To get extended error information, see [ZoomVideoSDKError].

Warning: If audioDelegate is non-null, it means share user-defined audio at the same time.

◆ stopShare

- (ZoomVideoSDKError) stopShare

Stop view or screen share.

Returns: If the function succeeds, the return value is Errors_Success. Otherwise failed.

Instance Methods

Detailed Description

Method Documentation

◆ applyPreprocessingOverlayImage:

◆ createAnnotationHelper:

◆ destroyAnnotationHelper:

◆ disableViewerAnnotation:

◆ enableMultiShare:

◆ enablePlaySharingAudioRawdata:

◆ enableShareDeviceAudio:

◆ isAnnotationFeatureSupport

◆ isMultiShareEnabled

◆ isOtherSharing

◆ isScreenSharingOut

◆ isShareDeviceAudioEnabled

◆ isShareLocked

◆ isSharingOut

◆ isSupportInAppScreenShare

◆ isViewerAnnotationDisabled

◆ lockShare:

◆ pauseShare

◆ removePreprocessingOverlayImage

◆ resumeShare

◆ startInAppScreenShare

◆ startShareCamera:

◆ startShareWithPreprocessing:sharePreprocessor:

◆ startShareWithView:

◆ startSharingExternalSource:andAudioSource:

◆ startSharingExternalSource:andAudioSource:isPlaying:

◆ stopShare