Meeting share controller interface. More...

#include <meeting_sharing_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IMeetingShareCtrlEvent *pEvent)=0
	Set meeting share controller callback event handler. More...

virtual SDKError	StartAppShare (HWND hwndSharedApp)=0
	Share the specified application. More...

virtual SDKError	StartMonitorShare (const wchar_t *monitorID)=0
	Share the specified monitor. More...

virtual SDKError	StartAirPlayShare ()=0
	Start sharing with mobile device. More...

virtual SDKError	StartWhiteBoardShare ()=0
	Start sharing with White board. More...

virtual SDKError	ShowSharingAppSelectWnd ()=0
	A dialog box pops up that enable the user to choose the application or window to share. More...

virtual SDKError	IsSupportAdvanceShareOption (AdvanceShareOption option_)=0
	Determine if the specified ADVANCE SHARE OPTION is supported. More...

virtual SDKError	StartShareFrame ()=0
	Start sharing frame. More...

virtual SDKError	StartSharePureComputerAudio ()=0
	Start sharing only the computer audio. More...

virtual SDKError	StartShareCamera ()=0
	Start sharing camera. More...

virtual SDKError	StopShare ()=0
	Stop the current sharing. More...

virtual SDKError	BlockWindowFromScreenshare (bool bBlock, HWND hWnd, bool bChangeWindowStyle=true)=0
	Block the window when sharing in full screen. Once the function is called, you need to redraw the window to take effect. More...

virtual SDKError	SwitchToFitWindowModeWhenViewShare (SDKViewType type)=0
	Switch to auto-adjust mode from sharing window by the function when watching the share on the specified view. More...

virtual SDKError	SwitchToOriginalSizeModeWhenViewShare (SDKViewType type)=0
	Switch the window size to originality by the function when watching the share on the specified view. More...

virtual SDKError	SwitchZoomRatioWhenViewShare (unsigned int userid, SDKShareViewZoomRatio shareViewZoomRatio)=0
	Switch the window size by the function when watching the share on the specified view. More...

virtual SDKError	EnableFollowPresenterPointerWhenViewShare (unsigned int userid, bool bEnable)=0
	Enable follow presenter's pointer by the function when watching the share on the specified view. More...

virtual SDKError	CanEnableFollowPresenterPointerWhenViewShare (unsigned int userid, bool &bCan)=0
	Determine if the follow presenter's pointer can be enabled when watching the share on the specified view. More...

virtual SDKError	PauseCurrentSharing ()=0
	Pause the current sharing. More...

virtual SDKError	ResumeCurrentSharing ()=0
	Resume the current sharing. More...

virtual IList< unsigned int > *	GetViewableShareSourceList ()=0
	Get the list of all the sharers in the current meeting. More...

virtual SDKError	GetViewabltShareSourceByUserID (unsigned int userid, ViewableShareSource &shareSource)=0
	Get the sharing information from the specified sharer. More...

virtual SDKError	ViewShare (unsigned int userid, SDKViewType type)=0
	View the share from the specified user. More...

virtual SDKError	ShowShareOptionDialog ()=0
	Display the dialog of sharing configuration. More...

virtual bool	CanStartShare ()=0
	Determine if it is able to share. More...

virtual SDKError	IsShareLocked (bool &bLocked)=0
	Determine if the sharing is locked. More...

virtual bool	IsSupportEnableShareComputerSound (bool &bCurEnableOrNot)=0
	Determine if the sound of the computer in the current sharing or before share is supported. More...

virtual bool	IsSupportEnableOptimizeForFullScreenVideoClip (bool &bCurEnableOrNot)=0
	Determine whether to optimize the video fluidity when sharing in full screen mode. More...

virtual SDKError	EnableShareComputerSound (bool bEnable)=0
	Set to enable or disable the audio before sharing. More...

virtual SDKError	EnableShareComputerSoundWhenSharing (bool bEnable)=0
	Set to enable or disable the audio when sharing. More...

virtual SDKError	SetAudioShareMode (AudioShareMode mode)=0
	Set the audio share mode before or during sharing. More...

virtual SDKError	GetAudioShareMode (AudioShareMode &mode)=0
	Get the audio share mode. More...

virtual SDKError	EnableOptimizeForFullScreenVideoClip (bool bEnable)=0
	Set to enable the video optimization before sharing. More...

virtual SDKError	EnableOptimizeForFullScreenVideoClipWhenSharing (bool bEnable)=0
	Set to enable the video optimization when sharing. More...

virtual SDKError	SetMultiShareSettingOptions (MultiShareOption shareOption)=0
	Set the options for multi-participants share. More...

virtual SDKError	GetMultiShareSettingOptions (MultiShareOption &shareOption)=0
	Get the options for multi-participants share. More...

virtual SDKError	CanSwitchToShareNextCamera (bool &bCan)=0
	Determine whether can switch to next camera, when share camera. More...

virtual SDKError	SwitchToShareNextCamera ()=0
	switch to next camera, when you are sharing the camera. More...

virtual bool	IsWhiteboardLegalNoticeAvailable ()=0
	Determine whether the legal notice for white board is available. More...

virtual const wchar_t *	getWhiteboardLegalNoticesPrompt ()=0
	Get the white board legal notices prompt. More...

virtual const wchar_t *	getWhiteboardLegalNoticesExplained ()=0
	Get the white board legal notices explained. More...

Detailed Description

Meeting share controller interface.

Definition at line 154 of file meeting_sharing_interface.h.

Member Function Documentation

◆ BlockWindowFromScreenshare()

virtual SDKError IMeetingShareController::BlockWindowFromScreenshare	(	bool	bBlock,
		HWND	hWnd,
		bool	bChangeWindowStyle = `true`
	)

pure virtual

Block the window when sharing in full screen. Once the function is called, you need to redraw the window to take effect.

Parameters

bBlock	TRUE indicates to block the window when sharing in full screen.
hWnd	Specify the window to be blocked.
bChangeWindowStyle	If it is FALSE, please call this function either after the StartMonitorShare is called or when you get the callback event of the onSharingStatus with Sharing_Self_Send_Begin.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid only for ZOOM style user interface mode. It is not suggested to use this function for it will change the property of the window and leads to some unknown errors. It won't work until the IMeetingShareController::StartMonitorShare() is called if the bChangeWindowStyle is set to FALSE. If you want to use the specified window during the share, you need to redraw the window. Set the bBlock to FALSE before ending the share and call the function for the specified window to resume the property of the window.

◆ CanEnableFollowPresenterPointerWhenViewShare()

virtual SDKError IMeetingShareController::CanEnableFollowPresenterPointerWhenViewShare	(	unsigned int	userid,
		bool &	bCan
	)

pure virtual

Determine if the follow presenter's pointer can be enabled when watching the share on the specified view.

Parameters

	userid	Specify the user ID that you want to follow his pointer.
[out]	bCan	TRUE indicates that the pointer can be enabled. FALSE indicates that it can't.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise it fails. To get extended error information, see SDKError enum.

◆ CanStartShare()

virtual bool IMeetingShareController::CanStartShare ( )

pure virtual

Determine if it is able to share.

Returns: Enable or disable to start sharing.

Remarks: Valid for both ZOOM style and user custom interface mode.

◆ CanSwitchToShareNextCamera()

virtual SDKError IMeetingShareController::CanSwitchToShareNextCamera ( bool & bCan )

pure virtual

Determine whether can switch to next camera, when share camera.

Parameters

[Out] bCan, if bCan is true it means you can switch, else can not.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableFollowPresenterPointerWhenViewShare()

virtual SDKError IMeetingShareController::EnableFollowPresenterPointerWhenViewShare	(	unsigned int	userid,
		bool	bEnable
	)

pure virtual

Enable follow presenter's pointer by the function when watching the share on the specified view.

Parameters

userid	Specify the user ID that you want to follow his pointer.
bEnable	TRUE indicates to enable. FALSE not.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableOptimizeForFullScreenVideoClip()

virtual SDKError IMeetingShareController::EnableOptimizeForFullScreenVideoClip ( bool bEnable )

pure virtual

Set to enable the video optimization before sharing.

Parameters

bEnable TRUE indicates to enable. FALSE not.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode.

◆ EnableOptimizeForFullScreenVideoClipWhenSharing()

virtual SDKError IMeetingShareController::EnableOptimizeForFullScreenVideoClipWhenSharing ( bool bEnable )

pure virtual

Set to enable the video optimization when sharing.

Parameters

bEnable TRUE indicates to enable. FALSE not.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode.

◆ EnableShareComputerSound()

virtual SDKError IMeetingShareController::EnableShareComputerSound ( bool bEnable )

pure virtual

Set to enable or disable the audio before sharing.

Parameters

bEnable TRUE indicates to enable. FALSE not.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode.

◆ EnableShareComputerSoundWhenSharing()

virtual SDKError IMeetingShareController::EnableShareComputerSoundWhenSharing ( bool bEnable )

pure virtual

Set to enable or disable the audio when sharing.

Parameters

bEnable TRUE indicates to enable. FALSE not.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode.

◆ GetAudioShareMode()

virtual SDKError IMeetingShareController::GetAudioShareMode ( AudioShareMode & mode )

pure virtual

Get the audio share mode.

Parameters

mode	The mode for audio share, see AudioShareMode enum.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode.

◆ GetMultiShareSettingOptions()

virtual SDKError IMeetingShareController::GetMultiShareSettingOptions ( MultiShareOption & shareOption )

pure virtual

Get the options for multi-participants share.

Parameters

[out] shareOption Options for sharing, see MultiShareOption enum.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ GetViewableShareSourceList()

virtual IList< unsigned int > * IMeetingShareController::GetViewableShareSourceList ( )

pure virtual

Get the list of all the sharers in the current meeting.

Returns: If the function succeeds, the return value is list of user ID. If the function fails, the return value is NULL.

Remarks: Valid for both ZOOM style and user custom interface mode.

◆ GetViewabltShareSourceByUserID()

virtual SDKError IMeetingShareController::GetViewabltShareSourceByUserID	(	unsigned int	userid,
		ViewableShareSource &	shareSource
	)

pure virtual

Get the sharing information from the specified sharer.

Parameters

	userid	Specify the user ID that you want to get his sharing information.
[out]	shareSource	Store the viewable sharing information. For more details, see ViewableShareSource structure.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode.

◆ getWhiteboardLegalNoticesExplained()

virtual const wchar_t * IMeetingShareController::getWhiteboardLegalNoticesExplained ( )

pure virtual

Get the white board legal notices explained.

◆ getWhiteboardLegalNoticesPrompt()

virtual const wchar_t * IMeetingShareController::getWhiteboardLegalNoticesPrompt ( )

pure virtual

Get the white board legal notices prompt.

◆ IsShareLocked()

virtual SDKError IMeetingShareController::IsShareLocked ( bool & bLocked )

pure virtual

Determine if the sharing is locked.

Parameters

bLocked TRUE indicates that the sharing is locked.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode.

◆ IsSupportAdvanceShareOption()

virtual SDKError IMeetingShareController::IsSupportAdvanceShareOption ( AdvanceShareOption option_ )

pure virtual

Determine if the specified ADVANCE SHARE OPTION is supported.

Parameters

option_ The ADVANCE SHARE OPTION to be determined. For more information, see AdvanceShareOption enum.

Returns: If it is supported, the return value is SDKErr_Success. Otherwise not. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode.

◆ IsSupportEnableOptimizeForFullScreenVideoClip()

virtual bool IMeetingShareController::IsSupportEnableOptimizeForFullScreenVideoClip ( bool & bCurEnableOrNot )

pure virtual

Determine whether to optimize the video fluidity when sharing in full screen mode.

Parameters

bCurEnableOrNot This parameter is valid only when the return value is TRUE. And TRUE indicates to optimize video for the moment.

Returns: If it is TRUE, the value of bCurEnableOrNot can be used to check whether to support optimize video fluidity or not. FALSE not.

Remarks: Valid for both ZOOM style and user custom interface mode.

◆ IsSupportEnableShareComputerSound()

virtual bool IMeetingShareController::IsSupportEnableShareComputerSound ( bool & bCurEnableOrNot )

pure virtual

Determine if the sound of the computer in the current sharing or before share is supported.

Parameters

[out] bCurEnableOrNot The parameter is valid only when the return value is TRUE. And TRUE indicates to sharing the sound of the computer for the moment.

Returns: If it is TRUE, the value of bCurEnableOrNot can be used to check whether the computer sound is supported or not when sharing. FALSE not.

Remarks: Valid for both ZOOM style and user custom interface mode.

◆ IsWhiteboardLegalNoticeAvailable()

virtual bool IMeetingShareController::IsWhiteboardLegalNoticeAvailable ( )

pure virtual

Determine whether the legal notice for white board is available.

Returns: True indicates the legal notice for white board is available. Otherwise False.

◆ PauseCurrentSharing()

virtual SDKError IMeetingShareController::PauseCurrentSharing ( )

pure virtual

Pause the current sharing.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode.

◆ ResumeCurrentSharing()

virtual SDKError IMeetingShareController::ResumeCurrentSharing ( )

pure virtual

Resume the current sharing.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode.

◆ SetAudioShareMode()

virtual SDKError IMeetingShareController::SetAudioShareMode ( AudioShareMode mode )

pure virtual

Set the audio share mode before or during sharing.

Parameters

mode	The mode for audio share, see AudioShareMode enum.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode.

◆ SetEvent()

virtual SDKError IMeetingShareController::SetEvent ( IMeetingShareCtrlEvent * pEvent )

pure virtual

Set meeting share controller callback event handler.

Parameters

pEvent A pointer to the IMeetingShareCtrlEvent that receives sharing event.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SetMultiShareSettingOptions()

virtual SDKError IMeetingShareController::SetMultiShareSettingOptions ( MultiShareOption shareOption )

pure virtual

Set the options for multi-participants share.

Parameters

[in] shareOption New options for sharing, see MultiShareOption enum.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ ShowShareOptionDialog()

virtual SDKError IMeetingShareController::ShowShareOptionDialog ( )

pure virtual

Display the dialog of sharing configuration.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid only for ZOOM style user interface mode.

◆ ShowSharingAppSelectWnd()

virtual SDKError IMeetingShareController::ShowSharingAppSelectWnd ( )

pure virtual

A dialog box pops up that enable the user to choose the application or window to share.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid only for ZOOM style mode.

◆ StartAirPlayShare()

virtual SDKError IMeetingShareController::StartAirPlayShare ( )

pure virtual

Start sharing with mobile device.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode.

◆ StartAppShare()

virtual SDKError IMeetingShareController::StartAppShare ( HWND hwndSharedApp )

pure virtual

Share the specified application.

Parameters

hwndSharedApp Specify the window handle of the application to be shared. If the hwndSharedApp can't be shared, the return value is the SDKERR_INVALID_PARAMETER error code. If the hwndSharedApp is NULL, the primary monitor will be shared.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode.

◆ StartMonitorShare()

virtual SDKError IMeetingShareController::StartMonitorShare ( const wchar_t * monitorID )

pure virtual

Share the specified monitor.

Parameters

monitorID Specify the monitor ID to be shared. You may get the value via EnumDisplayMonitors System API. If the monitorID is NULL, the primary monitor will be shared. For more details, see szDevice in MONITORINFOEX structure.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode.

◆ StartShareCamera()

virtual SDKError IMeetingShareController::StartShareCamera ( )

pure virtual

Start sharing camera.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for ZOOM style only.

◆ StartShareFrame()

virtual SDKError IMeetingShareController::StartShareFrame ( )

pure virtual

Start sharing frame.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode.

◆ StartSharePureComputerAudio()

virtual SDKError IMeetingShareController::StartSharePureComputerAudio ( )

pure virtual

Start sharing only the computer audio.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode.

◆ StartWhiteBoardShare()

virtual SDKError IMeetingShareController::StartWhiteBoardShare ( )

pure virtual

Start sharing with White board.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum. You need to draw your own annotation bar for custom mode when you get the onShareContentNotification with SHARE_TYPE_WB.

Remarks: Valid for both ZOOM style and user custom interface mode.

◆ StopShare()

virtual SDKError IMeetingShareController::StopShare ( )

pure virtual

Stop the current sharing.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid for both ZOOM style and user custom interface mode.

◆ SwitchToFitWindowModeWhenViewShare()

virtual SDKError IMeetingShareController::SwitchToFitWindowModeWhenViewShare ( SDKViewType type )

pure virtual

Switch to auto-adjust mode from sharing window by the function when watching the share on the specified view.

Parameters

type	Specify the view you want to set, either primary or secondary. For more details, see SDKViewType enum.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid only for ZOOM style user interface mode.

◆ SwitchToOriginalSizeModeWhenViewShare()

virtual SDKError IMeetingShareController::SwitchToOriginalSizeModeWhenViewShare ( SDKViewType type )

pure virtual

Switch the window size to originality by the function when watching the share on the specified view.

Parameters

type	Specify the view you want to set, either primary or secondary. For more details, see SDKViewType enum.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid only for ZOOM style user interface mode.

Deprecated:: This interface will be deprecated, please stop using it.

◆ SwitchToShareNextCamera()

virtual SDKError IMeetingShareController::SwitchToShareNextCamera ( )

pure virtual

switch to next camera, when you are sharing the camera.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SwitchZoomRatioWhenViewShare()

virtual SDKError IMeetingShareController::SwitchZoomRatioWhenViewShare	(	unsigned int	userid,
		SDKShareViewZoomRatio	shareViewZoomRatio
	)

pure virtual

Switch the window size by the function when watching the share on the specified view.

Parameters

userid	Specify the user ID that you want to switch zoom ratio.
shareViewZoomRatio	Specify the size you want to set. For more details, see ZMBShareViewZoomRatio enum.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ ViewShare()

virtual SDKError IMeetingShareController::ViewShare	(	unsigned int	userid,
		SDKViewType	type
	)

pure virtual

View the share from the specified user.

Parameters

userid	Specify the user ID that you want to view his share.
type	Specify the view that you want to display the share, either primary or secondary. For more details, see SDKViewType enum.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid only for ZOOM style user interface mode.

Public Member Functions

Detailed Description

Member Function Documentation

◆ BlockWindowFromScreenshare()

◆ CanEnableFollowPresenterPointerWhenViewShare()

◆ CanStartShare()

◆ CanSwitchToShareNextCamera()

◆ EnableFollowPresenterPointerWhenViewShare()

◆ EnableOptimizeForFullScreenVideoClip()

◆ EnableOptimizeForFullScreenVideoClipWhenSharing()

◆ EnableShareComputerSound()

◆ EnableShareComputerSoundWhenSharing()

◆ GetAudioShareMode()

◆ GetMultiShareSettingOptions()

◆ GetViewableShareSourceList()

◆ GetViewabltShareSourceByUserID()

◆ getWhiteboardLegalNoticesExplained()

◆ getWhiteboardLegalNoticesPrompt()

◆ IsShareLocked()

◆ IsSupportAdvanceShareOption()

◆ IsSupportEnableOptimizeForFullScreenVideoClip()

◆ IsSupportEnableShareComputerSound()

◆ IsWhiteboardLegalNoticeAvailable()

◆ PauseCurrentSharing()

◆ ResumeCurrentSharing()

◆ SetAudioShareMode()

◆ SetEvent()

◆ SetMultiShareSettingOptions()

◆ ShowShareOptionDialog()

◆ ShowSharingAppSelectWnd()

◆ StartAirPlayShare()

◆ StartAppShare()

◆ StartMonitorShare()

◆ StartShareCamera()

◆ StartShareFrame()

◆ StartSharePureComputerAudio()

◆ StartWhiteBoardShare()

◆ StopShare()

◆ SwitchToFitWindowModeWhenViewShare()

◆ SwitchToOriginalSizeModeWhenViewShare()

◆ SwitchToShareNextCamera()

◆ SwitchZoomRatioWhenViewShare()

◆ ViewShare()