IMeetingShareController Class Reference

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.
virtual SDKError	StartAppShare (HWND hwndSharedApp)=0
	Share the specified application.
virtual bool	IsShareAppValid (HWND hwndSharedApp)=0
	Determine if the window handle can be shared.If the hwndSharedApp is nullptr, the return value is FALSE.
virtual SDKError	StartMonitorShare (const zchar_t *monitorID)=0
	Share the specified monitor.
virtual SDKError	ShowSharingAppSelectWnd ()=0
	A dialog box pops up that enable the user to choose the application or window to share.
virtual SDKError	StartAirPlayShare ()=0
	Start sharing with mobile device.
virtual SDKError	StartShareCamera ()=0
	Start sharing camera.
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.
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.
virtual SDKError	SwitchZoomRatioWhenViewShare (unsigned int shareSourceID, SDKShareViewZoomRatio shareViewZoomRatio)=0
	Switch the window size by the function when watching the share on the specified view.
virtual SDKError	EnableFollowPresenterPointerWhenViewShare (unsigned int shareSourceID, bool bEnable)=0
	Enable follow presenter's pointer by the function when watching the share on the specified view.
virtual SDKError	CanEnableFollowPresenterPointerWhenViewShare (unsigned int shareSourceID, bool &bCan)=0
	Determine if the follow presenter's pointer can be enabled when watching the share on the specified view.
virtual SDKError	ViewShare (unsigned int shareSourceID, SDKViewType type)=0
	View the share from the specified user.
virtual SDKError	StartWhiteBoardShare ()=0
	Start sharing with White board.
virtual SDKError	StartShareFrame ()=0
	Start sharing frame.
virtual SDKError	StartSharePureComputerAudio ()=0
	Start sharing only the computer audio.
virtual SDKError	StartShareCamera (const zchar_t *deviceID, HWND hWnd)=0
	Start sharing camera.
virtual SDKError	ShowShareOptionDialog ()=0
	Display the dialog of sharing configuration.
virtual SDKError	IsSupportAdvanceShareOption (AdvanceShareOption option_)=0
	Determine if the specified ADVANCE SHARE OPTION is supported.
virtual SDKError	StopShare ()=0
	Stop the current sharing.
virtual SDKError	LockShare (bool isLock)=0
	host / co - host can use this function to lock current meeting share.
virtual SDKError	PauseCurrentSharing ()=0
	Pause the current sharing.
virtual SDKError	ResumeCurrentSharing ()=0
	Resume the current sharing.
virtual IList< unsigned int > *	GetViewableSharingUserList ()=0
	Get the ID of users who are sharing.
virtual IList< ZoomSDKSharingSourceInfo > *	GetSharingSourceInfoList (unsigned int userID)=0
	Get the sharing source information list from the specified sharer.
virtual bool	CanStartShare ()=0
	Determine if it is able to share.
virtual bool	CanStartShare (CannotShareReasonType &reason)=0
	Determine whether the current meeting can start sharing.
virtual bool	IsDesktopSharingEnabled ()=0
	Determine if it is able to share desktop in the current meeting.
virtual SDKError	IsShareLocked (bool &bLocked)=0
	Determine if the sharing is locked.
virtual bool	IsSupportEnableShareComputerSound (bool &bCurEnableOrNot)=0
	Determine if the sound of the computer in the current sharing or before share is supported.
virtual bool	IsSupportEnableOptimizeForFullScreenVideoClip (bool &bCurEnableOrNot)=0
	Determine whether to optimize the video fluidity when sharing in full screen mode.
virtual bool	IsSupportShareWithComputerSound (ShareType type)=0
	Determine if the specified share type supports sharing with compute sound or not.
virtual bool	IsCurrentSharingSupportShareWithComputerSound ()=0
	Determine if the current share supports sharing with compute sound or not.
virtual bool	IsEnableShareComputerSoundOn ()=0
virtual SDKError	EnableShareComputerSound (bool bEnable)=0
	Enable or disable the computer audio before sharing.
virtual bool	IsEnableShareComputerSoundOnWhenSharing ()=0
virtual SDKError	EnableShareComputerSoundWhenSharing (bool bEnable)=0
	Set to enable or disable the computer audio when sharing.
virtual SDKError	SetAudioShareMode (AudioShareMode mode)=0
	Set the audio share mode before or during sharing.
virtual SDKError	GetAudioShareMode (AudioShareMode &mode)=0
	Get the audio share mode.
virtual bool	IsSupportEnableOptimizeForFullScreenVideoClip ()=0
virtual bool	IsEnableOptimizeForFullScreenVideoClipOn ()=0
virtual SDKError	EnableOptimizeForFullScreenVideoClip (bool bEnable)=0
	Enable or disable the video optimization before sharing.
virtual bool	IsEnableOptimizeForFullScreenVideoClipOnWhenSharing ()=0
virtual SDKError	EnableOptimizeForFullScreenVideoClipWhenSharing (bool bEnable)=0
	Enable or disable the video optimization when sharing.
virtual SDKError	SetMultiShareSettingOptions (MultiShareOption shareOption)=0
	Set the options for multi-participants share.
virtual SDKError	GetMultiShareSettingOptions (MultiShareOption &shareOption)=0
	Get the options for multi-participants share.
virtual SDKError	CanSwitchToShareNextCamera (bool &bCan)=0
	Determine whether can switch to next camera, when share camera.
virtual SDKError	SwitchToShareNextCamera ()=0
	switch to next camera, when you are sharing the camera.
virtual bool	CanShareVideoFile ()=0
	Determine whether the user can share video files.
virtual SDKError	CanEnableShareToBO (bool &bCan)=0
	Determine whether the user can share to the breakout room.
virtual SDKError	EnableShareToBO (bool bEnable)=0
	Set to enable sharing to the breakout room.
virtual SDKError	IsShareToBOEnabled (bool &bEnabled)=0
	Determine if sharing to the breakout room is enabled.
virtual SDKError	StartVideoFileShare (const zchar_t *filePath)=0
	Share the video file.
virtual bool	IsWhiteboardLegalNoticeAvailable ()=0
	Determine whether the legal notice for white board is available.
virtual const zchar_t *	getWhiteboardLegalNoticesPrompt ()=0
	Get the white board legal notices prompt.
virtual const zchar_t *	getWhiteboardLegalNoticesExplained ()=0
	Get the white board legal notices explained.

Detailed Description

Meeting share controller interface.

Definition at line 156 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 shareSourceID, bool & bCan )

pure virtual

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

Parameters

	shareSourceID	Specify the share scource 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.

CanEnableShareToBO()

virtual SDKError IMeetingShareController::CanEnableShareToBO ( bool & bCan )

pure virtual

Determine whether the user can share to the breakout room.

Returns

True indicates that the user can share to the breakout room. Otherwise the function fails. To get extended error information, see SDKError enum.

Remarks

Valid for user custom interface mode only.

CanShareVideoFile()

virtual bool IMeetingShareController::CanShareVideoFile ( )

pure virtual

Determine whether the user can share video files.

Returns

True indicates that the user can share video files. Otherwise False.

CanStartShare() [1/2]

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.

Deprecated

This interface is marked as deprecated, and is replaced by CanStartShare(CannotShareReasonType& reason).

CanStartShare() [2/2]

virtual bool IMeetingShareController::CanStartShare ( CannotShareReasonType & reason )

pure virtual

Determine whether the current meeting can start sharing.

Parameters

[out]

reason

The reason that no one can start sharing. See CannotShareReasonType enum.

Returns

True indicates you can start sharing.

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 shareSourceID, bool bEnable )

pure virtual

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

Parameters

shareSourceID	Specify the sharing source ID that you want to follow the presenter's 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

Enable or disable 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

It will be applied when starting share.

EnableOptimizeForFullScreenVideoClipWhenSharing()

virtual SDKError IMeetingShareController::EnableOptimizeForFullScreenVideoClipWhenSharing ( bool bEnable )

pure virtual

Enable or disable 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

Enable or disable the computer 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

It will be applied when starting share.

EnableShareComputerSoundWhenSharing()

virtual SDKError IMeetingShareController::EnableShareComputerSoundWhenSharing ( bool bEnable )

pure virtual

Set to enable or disable the computer 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.

EnableShareToBO()

virtual SDKError IMeetingShareController::EnableShareToBO ( bool bEnable )

pure virtual

Set to enable sharing to the breakout room.

Parameters

bEnable

TRUE indicates to enable. FALSE indicates that sharing to the breakout room is not enabled.

Returns

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

Remarks

Valid for user custom interface mode only.

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.

GetSharingSourceInfoList()

virtual IList< ZoomSDKSharingSourceInfo > * IMeetingShareController::GetSharingSourceInfoList ( unsigned int userID )

pure virtual

Get the sharing source information list from the specified sharer.

Parameters

userID

The ID of the user who is sharing.

Returns

If the function succeeds, the return value is the viewable sharing information list. For more details, see ZoomSDKSharingSourceInfo structure.

Remarks

Valid for both ZOOM style and user custom interface mode. For custom interface mode, this interface is only valid after subscribing the sharing content from the specified user by calling ICustomizedShareRender::SetUserID(unsigned int userid) successfully.

GetViewableSharingUserList()

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

pure virtual

Get the ID of users who are sharing.

Returns

If the function succeeds, the return value is a list of user ID of all users who are sharing. If the function fails, the return value is nullptr.

Remarks

Valid for both ZOOM style and user custom interface mode.

getWhiteboardLegalNoticesExplained()

virtual const zchar_t * IMeetingShareController::getWhiteboardLegalNoticesExplained ( )

pure virtual

Get the white board legal notices explained.

getWhiteboardLegalNoticesPrompt()

virtual const zchar_t * IMeetingShareController::getWhiteboardLegalNoticesPrompt ( )

pure virtual

Get the white board legal notices prompt.

IsCurrentSharingSupportShareWithComputerSound()

virtual bool IMeetingShareController::IsCurrentSharingSupportShareWithComputerSound ( )

pure virtual

Determine if the current share supports sharing with compute sound or not.

Returns

True indicates that is supported.

IsDesktopSharingEnabled()

virtual bool IMeetingShareController::IsDesktopSharingEnabled ( )

pure virtual

Determine if it is able to share desktop in the current meeting.

Returns

True indicates it is able to share desktop in the current meeting. False not.

Remarks

Valid for both ZOOM style and user custom interface mode.

IsEnableOptimizeForFullScreenVideoClipOn()

virtual bool IMeetingShareController::IsEnableOptimizeForFullScreenVideoClipOn ( )

pure virtual

Returns

True indicates this is enabled.

IsEnableOptimizeForFullScreenVideoClipOnWhenSharing()

virtual bool IMeetingShareController::IsEnableOptimizeForFullScreenVideoClipOnWhenSharing ( )

pure virtual

Returns

True indicates this is enabled.

IsEnableShareComputerSoundOn()

virtual bool IMeetingShareController::IsEnableShareComputerSoundOn ( )

pure virtual

Returns

True indicates that this is enabled.

IsEnableShareComputerSoundOnWhenSharing()

virtual bool IMeetingShareController::IsEnableShareComputerSoundOnWhenSharing ( )

pure virtual

Returns

True indicates that this is enabled.

IsShareAppValid()

virtual bool IMeetingShareController::IsShareAppValid ( HWND hwndSharedApp )

pure virtual

Determine if the window handle can be shared.If the hwndSharedApp is nullptr, the return value is FALSE.

Returns

True indicates the window handle can be shared. False means the app's window handle can't be shared.

Remarks

Valid for both ZOOM style and user custom interface mode.

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.

IsShareToBOEnabled()

virtual SDKError IMeetingShareController::IsShareToBOEnabled ( bool & bEnabled )

pure virtual

Determine if sharing to the breakout room is enabled.

Parameters

bEnabled

TRUE indicates that the sharing is locked.

Returns

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

Remarks

Valid for user custom interface mode only.

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() [1/2]

virtual bool IMeetingShareController::IsSupportEnableOptimizeForFullScreenVideoClip ( )

pure virtual

Returns

True indicates this is supported.

IsSupportEnableOptimizeForFullScreenVideoClip() [2/2]

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.

Deprecated

This interface is marked as deprecated.

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.

Deprecated

This interface is marked as deprecated.

IsSupportShareWithComputerSound()

virtual bool IMeetingShareController::IsSupportShareWithComputerSound ( ShareType type )

pure virtual

Determine if the specified share type supports sharing with compute sound or not.

Parameters

type	The type of sharing content.

Returns

True indicates that this is supported.

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.

LockShare()

virtual SDKError IMeetingShareController::LockShare ( bool isLock )

pure virtual

host / co - host can use this function to lock current meeting share.

Parameters

isLock

TRUE means to lock the meeting share, FALSE not.

Returns

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

Deprecated

This interface is marked as deprecated, and is replaced by SetMultiShareSettingOptions(MultiShareOption shareOption).

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 nullptr, 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 zchar_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 nullptr, 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() [1/2]

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.

StartShareCamera() [2/2]

virtual SDKError IMeetingShareController::StartShareCamera ( const zchar_t * deviceID, HWND hWnd )

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 user custom interface mode 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.

StartVideoFileShare()

virtual SDKError IMeetingShareController::StartVideoFileShare ( const zchar_t * filePath )

pure virtual

Share the video file.

Parameters

filePath

Specify the video file path. Only supports mov, mp4, or avi format.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise the function fails and returns error. To get extended error information, see SDKError enum.

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.

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 shareSourceID, SDKShareViewZoomRatio shareViewZoomRatio )

pure virtual

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

Parameters

shareSourceID	Specify the share scource 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 shareSourceID, SDKViewType type )

pure virtual

View the share from the specified user.

Parameters

shareSourceID	Specify the share scource 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.

Deprecated

This interface is marked as deprecated