Share helper interface. More...

#include <zoom_video_sdk_share_helper_interface.h>

Public Member Functions
virtual ZoomVideoSDKErrors	startShareView (void *handle, ZoomVideoSDKShareOption option={false, false})=0
	Share a selected window, if virtual speaker is enabled, don't support share audio.

virtual ZoomVideoSDKErrors	startShareApplication (uint32_t processID, ZoomVideoSDKShareOption option={false, false})=0
	Starts sharing a specific application process.

virtual bool	isShareViewValid (void *handle)=0
	Determines whether the handle being shared is valid.

virtual ZoomVideoSDKErrors	startShareScreen (const zchar_t *monitorID, ZoomVideoSDKShareOption option={ false, false })=0
	Share a selected screen, if virtual speaker is enabled, don't support share audio.

virtual IMonitorListBuilder *	getMonitorListBuilder ()=0
	Returns the monitor ID list builder object, the monitor ID list will be cleared after calling startShareMultiScreen.

virtual ZoomVideoSDKErrors	startShareMultiScreen (ZoomVideoSDKShareOption option={ false, false })=0
	Share all screens in IMonitorListBuilder, if virtual speaker is enabled, don't support share audio.

virtual ZoomVideoSDKErrors	startShareComputerAudio ()=0
	Start sharing only the computer audio.

virtual ZoomVideoSDKErrors	startSharePureAudioSource (IZoomVideoSDKShareAudioSource *pShareAudioSource, bool isPlaying=true)=0
	Starts sharing the pure external audio source.

virtual ZoomVideoSDKErrors	stopShare ()=0
	Stop share.

virtual ZoomVideoSDKErrors	pauseShare ()=0
	Pause share.

virtual ZoomVideoSDKErrors	resumeShare ()=0
	Resume share.

virtual bool	isSharingOut ()=0
	Determines whether the current user is sharing.

virtual bool	isScreenSharingOut ()=0
	Determines whether the current user is sharing the screen.

virtual bool	isOtherSharing ()=0
	Determines if other user is sharing.

virtual ZoomVideoSDKErrors	lockShare (bool lock)=0
	Lock sharing the view or screen. Only the host can call this method.

virtual bool	isShareLocked ()=0
	Determines whether sharing is locked.

virtual ZoomVideoSDKErrors	enableMultiShare (bool enable)=0
	Enable or disable participants can share simultaneously.

virtual bool	isMultiShareEnabled ()=0
	Determines whether multi share is enabled or not.

virtual ZoomVideoSDKErrors	enableShareDeviceAudio (bool enable)=0
	Enable or disable the computer sound when sharing. The SDK does not support sharing device audio, for example, when you've enabled virtual speaker.

virtual bool	isShareDeviceAudioEnabled ()=0
	Determines if the SDK has enabled share device sound. This reflects the execution status of `enableShareDeviceAudio` instead of `startShareComputerAudio`.

virtual ZoomVideoSDKErrors	enableOptimizeForSharedVideo (bool enable)=0
	Enable or disable the optimization of frame rate, you can enable it when there is video in shared content.

virtual bool	isOptimizeForSharedVideoEnabled ()=0
	Determines if optimization for shared video is enabled.

virtual ZoomVideoSDKErrors	startShare2ndCamera (const zchar_t *cameraID)=0
	Start sharing a camera feed specified by the cameraID as the second camera.

virtual ZoomVideoSDKErrors	subscribeMyShareCamera (IZoomVideoSDKRawDataPipeDelegate *data_handler)=0
	Subscribe to the raw data stream of the camera that is shared as the second camera.

virtual ZoomVideoSDKErrors	unSubscribeMyShareCamera ()=0
	Unsubscribe to the raw data stream of the camera that is shared as the second camera.

virtual ZoomVideoSDKErrors	startSharingExternalSource (IZoomVideoSDKShareSource pSource, IZoomVideoSDKShareAudioSource pAudioSource=nullptr, bool isPlaying=true)=0
	Shares an external source.

virtual bool	isAnnotationFeatureSupport ()=0
	Whether annotation is enabled or not.

virtual ZoomVideoSDKErrors	disableViewerAnnotation (bool bDisable)=0
	Disable or enable viewer's annotation by the share owner.

virtual bool	isViewerAnnotationDisabled ()=0
	Whether annotation on current sharing is disabled or not.

virtual IZoomVideoSDKAnnotationHelper *	createAnnotationHelper (void *handle)=0
	Creates annotation helper based on shared view.

virtual ZoomVideoSDKErrors	destroyAnnotationHelper (IZoomVideoSDKAnnotationHelper *helper)=0
	Destroys annotation helper.

virtual ZoomVideoSDKErrors	setAnnotationVanishingToolTime (unsigned int displayTime, unsigned int vanishingTime)=0
	Sets the vanishing tool time.

virtual ZoomVideoSDKErrors	getAnnotationVanishingToolTime (unsigned int &displayTime, unsigned int &vanishingTime)=0
	Gets the current vanishing tool time settings.

virtual ZoomVideoSDKErrors	enablePlaySharingAudioRawdata (bool isPlaying)=0
	Enable or disable local playback of shared audio raw data.

virtual ZoomVideoSDKErrors	startShareWithPreprocessing (const ZoomVideoSDKSharePreprocessParam &param, IZoomVideoSDKSharePreprocessor *preprocessor)=0
	Start share preprocessing.

virtual ZoomVideoSDKErrors	setShareTransparentWindow (void *hWnd, bool bShare)=0
	Sets share transparent window or not when sharing.

virtual IZoomVideoSDKWhiteboardHelper *	getWhiteboardHelper ()=0
	Returns an instance to manage whiteboard during a video SDK session.

Detailed Description

Share helper interface.

Definition at line 408 of file zoom_video_sdk_share_helper_interface.h.

Member Function Documentation

◆ createAnnotationHelper()

virtual IZoomVideoSDKAnnotationHelper * IZoomVideoSDKShareHelper::createAnnotationHelper ( void * handle )

pure virtual

Creates annotation helper based on shared view.

Parameters

handle the shared view handle. Pass the null will return the helper for self sharing.

Returns: If the function succeeds, the return value is the IZoomVideoSDKAnnotationHelper helper object. Otherwise, this function fails and returns nullptr. For more details, see IZoomVideoSDKAnnotationHelper.

Warning: The view passed in this function should be subscribed share view. If the share view aspect mode is set to ZoomVideoSDKVideoAspect_Full_Filled, annotation is not supported. When the share owner not support the feature of annotate, the others should not do annotate in that case.

◆ destroyAnnotationHelper()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareHelper::destroyAnnotationHelper ( IZoomVideoSDKAnnotationHelper * helper )

pure virtual

Destroys annotation helper.

Parameters

helper IZoomVideoSDKAnnotationHelper object.

◆ disableViewerAnnotation()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareHelper::disableViewerAnnotation ( bool bDisable )

pure virtual

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

Parameters

bDisable true to disable, false otherwise.

Warning: Only the share owner can call this function.

◆ enableMultiShare()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareHelper::enableMultiShare ( bool enable )

pure virtual

Enable or disable participants can share simultaneously.

Parameters

enable true to enable, false to disable.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

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

◆ enableOptimizeForSharedVideo()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareHelper::enableOptimizeForSharedVideo ( bool enable )

pure virtual

Enable or disable the optimization of frame rate, you can enable it when there is video in shared content.

Parameters

enable true indicates to enable. false disable.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ enablePlaySharingAudioRawdata()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareHelper::enablePlaySharingAudioRawdata ( bool isPlaying )

pure virtual

Enable or disable local playback of shared audio raw data.

Parameters

isPlaying true to play shared audio raw data, false to not play.

◆ enableShareDeviceAudio()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareHelper::enableShareDeviceAudio ( bool enable )

pure virtual

Enable or disable the computer sound when sharing. The SDK does not support sharing device audio, for example, when you've enabled virtual speaker.

Parameters

enable true to enable, false to disable.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ getAnnotationVanishingToolTime()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareHelper::getAnnotationVanishingToolTime	(	unsigned int &	displayTime,
		unsigned int &	vanishingTime )

pure virtual

Gets the current vanishing tool time settings.

Parameters

displayTime	[out] The time in milliseconds the tool remains visible before fading.
vanishingTime	[out] The time in milliseconds for the tool to fade out after displayTime.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

Note: This function can only retrieve the time settings for your own share.

◆ getMonitorListBuilder()

virtual IMonitorListBuilder * IZoomVideoSDKShareHelper::getMonitorListBuilder ( )

pure virtual

Returns the monitor ID list builder object, the monitor ID list will be cleared after calling startShareMultiScreen.

Returns: If the function succeeds, the return value is the monitor ID list builder object. Otherwise, this function fails and returns nullptr.

◆ getWhiteboardHelper()

virtual IZoomVideoSDKWhiteboardHelper * IZoomVideoSDKShareHelper::getWhiteboardHelper ( )

pure virtual

Returns an instance to manage whiteboard during a video SDK session.

Returns: If the function succeeds, the return value is the whiteboard helper object. Otherwise, this function fails and returns nullptr. For more details, see IZoomVideoSDKWhiteboardHelper.

◆ isAnnotationFeatureSupport()

virtual bool IZoomVideoSDKShareHelper::isAnnotationFeatureSupport ( )

pure virtual

Whether annotation is enabled or not.

Returns: true if the annotation feature is supported. Otherwise, false.

◆ isMultiShareEnabled()

virtual bool IZoomVideoSDKShareHelper::isMultiShareEnabled ( )

pure virtual

Determines whether multi share is enabled or not.

Returns: true if enabled, Otherwise, false.

◆ isOptimizeForSharedVideoEnabled()

virtual bool IZoomVideoSDKShareHelper::isOptimizeForSharedVideoEnabled ( )

pure virtual

Determines if optimization for shared video is enabled.

Returns: true if enabled. Otherwise, false.

◆ isOtherSharing()

virtual bool IZoomVideoSDKShareHelper::isOtherSharing ( )

pure virtual

Determines if other user is sharing.

Returns: true if another user is sharing. Otherwise, false.

◆ isScreenSharingOut()

virtual bool IZoomVideoSDKShareHelper::isScreenSharingOut ( )

pure virtual

Determines whether the current user is sharing the screen.

Returns: true if the current user is sharing the screen. Otherwise, false.

◆ isShareDeviceAudioEnabled()

virtual bool IZoomVideoSDKShareHelper::isShareDeviceAudioEnabled ( )

pure virtual

Determines if the SDK has enabled share device sound. This reflects the execution status of enableShareDeviceAudio instead of startShareComputerAudio.

Returns: true if enabled. Otherwise, false.

◆ isShareLocked()

virtual bool IZoomVideoSDKShareHelper::isShareLocked ( )

pure virtual

Determines whether sharing is locked.

Returns: true if sharing is locked. Otherwise, false.

◆ isShareViewValid()

virtual bool IZoomVideoSDKShareHelper::isShareViewValid ( void * handle )

pure virtual

Determines whether the handle being shared is valid.

Returns: true if the handle is valid. Otherwise, false.

◆ isSharingOut()

virtual bool IZoomVideoSDKShareHelper::isSharingOut ( )

pure virtual

Determines whether the current user is sharing.

Returns: true if the current user is sharing. Otherwise, false.

◆ isViewerAnnotationDisabled()

virtual bool IZoomVideoSDKShareHelper::isViewerAnnotationDisabled ( )

pure virtual

Whether annotation on current sharing is disabled or not.

Returns: true disable, false not disable.

Warning: Only the share owner can call this function.

◆ lockShare()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareHelper::lockShare ( bool lock )

pure virtual

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

Parameters

lock	true to lock sharing, false to unlock.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ pauseShare()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareHelper::pauseShare ( )

pure virtual

Pause share.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ resumeShare()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareHelper::resumeShare ( )

pure virtual

Resume share.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ setAnnotationVanishingToolTime()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareHelper::setAnnotationVanishingToolTime	(	unsigned int	displayTime,
		unsigned int	vanishingTime )

pure virtual

Sets the vanishing tool time.

Parameters

displayTime	The time in milliseconds the tool remains visible before fading.
vanishingTime	The time in milliseconds for the tool to fade out after displayTime.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

Note: This setting only takes effect for the user's own share. The displayTime can be 0 or up to 15000 milliseconds (15 seconds), and the vanishingTime must be greater than 1000 milliseconds (1 second) and less than or equal to 15000 milliseconds (15 seconds).

◆ setShareTransparentWindow()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareHelper::setShareTransparentWindow	(	void *	hWnd,
		bool	bShare )

pure virtual

Sets share transparent window or not when sharing.

Parameters

hWnd	The window handle of the transparent window that you want to share or not.
bShare	true to share the transparent window, false to not share.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

Note: The provided hWnd must point to a transparent window. Otherwise unexpected issues may occur.

◆ startShare2ndCamera()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareHelper::startShare2ndCamera ( const zchar_t * cameraID )

pure virtual

Start sharing a camera feed specified by the cameraID as the second camera.

Parameters

cameraID The camera ID.Warning: This must be a different camera than the one sending your primary video.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ startShareApplication()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareHelper::startShareApplication	(	uint32_t	processID,
		ZoomVideoSDKShareOption	option = {false, false} )

pure virtual

Starts sharing a specific application process.

Parameters

processID	The process identifier of the target application. Must be valid in the current user session.
option	Optional share settings.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

Note: This API is only supported on macOS.

◆ startShareComputerAudio()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareHelper::startShareComputerAudio ( )

pure virtual

Start sharing only the computer audio.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ startShareMultiScreen()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareHelper::startShareMultiScreen ( ZoomVideoSDKShareOption option = { false, false } )

pure virtual

Share all screens in IMonitorListBuilder, if virtual speaker is enabled, don't support share audio.

Parameters

option See ZoomVideoSDKShareOption.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ startSharePureAudioSource()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareHelper::startSharePureAudioSource	(	IZoomVideoSDKShareAudioSource *	pShareAudioSource,
		bool	isPlaying = true )

pure virtual

Starts sharing the pure external audio source.

Parameters

pShareAudioSource	the pointer of external audio source object.
isPlaying	true to play audio raw data locally at the same time, false to not play.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

Note: The feature is similar to share computer audio, except that the shared content is user-defined.

◆ startShareScreen()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareHelper::startShareScreen	(	const zchar_t *	monitorID,
		ZoomVideoSDKShareOption	option = { false, false } )

pure virtual

Share a selected screen, if virtual speaker is enabled, don't support share audio.

Parameters

monitorID	The screen name that will to be share.
option	See ZoomVideoSDKShareOption.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ startShareView()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareHelper::startShareView	(	void *	handle,
		ZoomVideoSDKShareOption	option = {false, false} )

pure virtual

Share a selected window, if virtual speaker is enabled, don't support share audio.

Parameters

handle	The window handle that will to be share.
option	See ZoomVideoSDKShareOption.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ startShareWithPreprocessing()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareHelper::startShareWithPreprocessing	(	const ZoomVideoSDKSharePreprocessParam &	param,
		IZoomVideoSDKSharePreprocessor *	preprocessor )

pure virtual

Start share preprocessing.

Parameters

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

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ startSharingExternalSource()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareHelper::startSharingExternalSource	(	IZoomVideoSDKShareSource *	pSource,
		IZoomVideoSDKShareAudioSource *	pAudioSource = nullptr,
		bool	isPlaying = true )

pure virtual

Shares an external source.

Parameters

pSource	External share source, IZoomVideoSDKShareSource.
pAudioSource	external share audio source.
isPlaying	true to play audio raw data locally at the same time, false to not play.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

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

◆ stopShare()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareHelper::stopShare ( )

pure virtual

Stop share.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ subscribeMyShareCamera()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareHelper::subscribeMyShareCamera ( IZoomVideoSDKRawDataPipeDelegate * data_handler )

pure virtual

Subscribe to the raw data stream of the camera that is shared as the second camera.

Parameters

data_handler Data handler object.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

Deprecated: This interface will be marked as deprecated, then it will be instead by IZoomVideoSDKRawDataPipe->subscribe, please stop using it.

◆ unSubscribeMyShareCamera()

virtual ZoomVideoSDKErrors IZoomVideoSDKShareHelper::unSubscribeMyShareCamera ( )

pure virtual

Unsubscribe to the raw data stream of the camera that is shared as the second camera.

Returns: If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

Deprecated: This interface will be marked as deprecated, then it will be instead by IZoomVideoSDKRawDataPipe->unSubscribe, please stop using it.

Public Member Functions

Detailed Description

Member Function Documentation

◆ createAnnotationHelper()

◆ destroyAnnotationHelper()

◆ disableViewerAnnotation()

◆ enableMultiShare()

◆ enableOptimizeForSharedVideo()

◆ enablePlaySharingAudioRawdata()

◆ enableShareDeviceAudio()

◆ getAnnotationVanishingToolTime()

◆ getMonitorListBuilder()

◆ getWhiteboardHelper()

◆ isAnnotationFeatureSupport()

◆ isMultiShareEnabled()

◆ isOptimizeForSharedVideoEnabled()

◆ isOtherSharing()

◆ isScreenSharingOut()

◆ isShareDeviceAudioEnabled()

◆ isShareLocked()

◆ isShareViewValid()

◆ isSharingOut()

◆ isViewerAnnotationDisabled()

◆ lockShare()

◆ pauseShare()

◆ resumeShare()

◆ setAnnotationVanishingToolTime()

◆ setShareTransparentWindow()

◆ startShare2ndCamera()

◆ startShareApplication()

◆ startShareComputerAudio()

◆ startShareMultiScreen()

◆ startSharePureAudioSource()

◆ startShareScreen()

◆ startShareView()

◆ startShareWithPreprocessing()

◆ startSharingExternalSource()

◆ stopShare()

◆ subscribeMyShareCamera()

◆ unSubscribeMyShareCamera()