IMeetingShareController Class Reference

Meeting share controller interface. More...

#include <meeting_sharing_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IMeetingShareCtrlEvent *pEvent)=0
	Sets meeting share controller callback event handler.
virtual SDKError	IsSupportAdvanceShareOption (AdvanceShareOption option_)=0
	Determines if the specified ADVANCE SHARE OPTION is supported.
virtual SDKError	StopShare ()=0
	Stops 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
	Gets the ID of users who are sharing.
virtual IList< ZoomSDKSharingSourceInfo > *	GetSharingSourceInfoList (unsigned int userID)=0
	Gets the sharing source information list from the specified sharer.
virtual bool	CanStartShare ()=0
	Determines if it is able to share.
virtual bool	CanStartShare (CannotShareReasonType &reason)=0
	Determines whether the current meeting can start sharing.
virtual bool	IsDesktopSharingEnabled ()=0
	Determines if it is able to share desktop in the current meeting.
virtual SDKError	IsShareLocked (bool &bLocked)=0
	Determines if the sharing is locked.
virtual bool	IsSupportEnableShareComputerSound (bool &bCurEnableOrNot)=0
	Determines if the sound of the computer in the current sharing or before share is supported.
virtual bool	IsSupportEnableOptimizeForFullScreenVideoClip (bool &bCurEnableOrNot)=0
	Determines whether to optimize the video fluidity when sharing in full screen mode.
virtual bool	IsSupportShareWithComputerSound (ShareType type)=0
	Determines if the specified share type supports sharing with compute sound or not.
virtual bool	IsCurrentSharingSupportShareWithComputerSound ()=0
	Determines if the current share supports sharing with compute sound or not.
virtual bool	IsEnableShareComputerSoundOn ()=0
	Determines if the current meeting enabled sharing with compute sound or not before sharing.
virtual SDKError	EnableShareComputerSound (bool bEnable)=0
	Enables or disable the computer audio before sharing.
virtual bool	IsEnableShareComputerSoundOnWhenSharing ()=0
	Determines if the current sharing content enabled sharing with compute sound or not.
virtual SDKError	EnableShareComputerSoundWhenSharing (bool bEnable)=0
	Sets to enable or disable the computer audio when sharing.
virtual SDKError	SetAudioShareMode (AudioShareMode mode)=0
	Sets the audio share mode before or during sharing.
virtual SDKError	GetAudioShareMode (AudioShareMode &mode)=0
	Gets the audio share mode.
virtual bool	IsSupportEnableOptimizeForFullScreenVideoClip ()=0
	Determines if the current meeting supports sharing with optimize video or not.
virtual bool	IsEnableOptimizeForFullScreenVideoClipOn ()=0
	Determines if the current meeting enabled sharing with optimize video or not.
virtual SDKError	EnableOptimizeForFullScreenVideoClip (bool bEnable)=0
	Enables or disable the video optimization before sharing.
virtual bool	IsEnableOptimizeForFullScreenVideoClipOnWhenSharing ()=0
	Determines if the current sharing content enabled sharing with optimize video or not.
virtual SDKError	EnableOptimizeForFullScreenVideoClipWhenSharing (bool bEnable)=0
	Enables or disable the video optimization when sharing.
virtual SDKError	SetMultiShareSettingOptions (MultiShareOption shareOption)=0
	Sets the options for multi-participants share.
virtual SDKError	GetMultiShareSettingOptions (MultiShareOption &shareOption)=0
	Gets the options for multi-participants share.
virtual SDKError	CanSwitchToShareNextCamera (bool &bCan)=0
	Determines 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
	Determines whether the user can share video files.

Detailed Description

Meeting share controller interface.

Definition at line 213 of file meeting_sharing_interface.h.

Member Function Documentation

CanShareVideoFile()

virtual bool IMeetingShareController::CanShareVideoFile ( )

pure virtual

Determines 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

Determines if it is able to share.

Returns

Enable or disable to start sharing.

Note

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

Determines whether the current meeting can start sharing.

Parameters

[out]

reason

The reason that no one can start sharing.

Returns

true indicates you can start sharing.

CanSwitchToShareNextCamera()

virtual SDKError IMeetingShareController::CanSwitchToShareNextCamera ( bool & bCan )

pure virtual

Determines 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, this function returns an error.

EnableOptimizeForFullScreenVideoClip()

virtual SDKError IMeetingShareController::EnableOptimizeForFullScreenVideoClip ( bool bEnable )

pure virtual

Enables 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, this function returns an error.

Note

It will be applied when starting share.

EnableOptimizeForFullScreenVideoClipWhenSharing()

virtual SDKError IMeetingShareController::EnableOptimizeForFullScreenVideoClipWhenSharing ( bool bEnable )

pure virtual

Enables 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, this function returns an error.

Note

Valid for both ZOOM style and user custom interface mode.

EnableShareComputerSound()

virtual SDKError IMeetingShareController::EnableShareComputerSound ( bool bEnable )

pure virtual

Enables 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, this function returns an error.

Note

It will be applied when starting share.

EnableShareComputerSoundWhenSharing()

virtual SDKError IMeetingShareController::EnableShareComputerSoundWhenSharing ( bool bEnable )

pure virtual

Sets 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, this function returns an error.

Note

Valid for both ZOOM style and user custom interface mode.

GetAudioShareMode()

virtual SDKError IMeetingShareController::GetAudioShareMode ( AudioShareMode & mode )

pure virtual

Gets 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, this function returns an error.

Note

Valid for both ZOOM style and user custom interface mode.

GetMultiShareSettingOptions()

virtual SDKError IMeetingShareController::GetMultiShareSettingOptions ( MultiShareOption & shareOption )

pure virtual

Gets the options for multi-participants share.

Parameters

[out]

shareOption

Options for sharing.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

GetSharingSourceInfoList()

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

pure virtual

Gets the sharing source information list from the specified sharer.

Parameters

userID

The ID of the user who is sharing.

Returns

If the function succeeds, it returns the viewable sharing information list.

Note

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

Gets 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.

Note

Valid for both ZOOM style and user custom interface mode.

IsCurrentSharingSupportShareWithComputerSound()

virtual bool IMeetingShareController::IsCurrentSharingSupportShareWithComputerSound ( )

pure virtual

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

Returns

true indicates that is supported.

IsDesktopSharingEnabled()

virtual bool IMeetingShareController::IsDesktopSharingEnabled ( )

pure virtual

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

Returns

true if it is able to share desktop in the current meeting. Otherwise, false.

Note

Valid for both ZOOM style and user custom interface mode.

IsEnableOptimizeForFullScreenVideoClipOn()

virtual bool IMeetingShareController::IsEnableOptimizeForFullScreenVideoClipOn ( )

pure virtual

Determines if the current meeting enabled sharing with optimize video or not.

Returns

true indicates this is enabled.

IsEnableOptimizeForFullScreenVideoClipOnWhenSharing()

virtual bool IMeetingShareController::IsEnableOptimizeForFullScreenVideoClipOnWhenSharing ( )

pure virtual

Determines if the current sharing content enabled sharing with optimize video or not.

Returns

true indicates this is enabled.

IsEnableShareComputerSoundOn()

virtual bool IMeetingShareController::IsEnableShareComputerSoundOn ( )

pure virtual

Determines if the current meeting enabled sharing with compute sound or not before sharing.

Returns

true indicates that this is enabled.

IsEnableShareComputerSoundOnWhenSharing()

virtual bool IMeetingShareController::IsEnableShareComputerSoundOnWhenSharing ( )

pure virtual

Determines if the current sharing content enabled sharing with compute sound or not.

Returns

true indicates that this is enabled.

IsShareLocked()

virtual SDKError IMeetingShareController::IsShareLocked ( bool & bLocked )

pure virtual

Determines 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, this function returns an error.

Note

Valid for both ZOOM style and user custom interface mode.

IsSupportAdvanceShareOption()

virtual SDKError IMeetingShareController::IsSupportAdvanceShareOption ( AdvanceShareOption option_ )

pure virtual

Determines if the specified ADVANCE SHARE OPTION is supported.

Parameters

option_

The ADVANCE SHARE OPTION to be determined.

Returns

If it is supported, the return value is SDKERR_SUCCESS. Otherwise not.

Note

Valid for both ZOOM style and user custom interface mode.

IsSupportEnableOptimizeForFullScreenVideoClip() [1/2]

virtual bool IMeetingShareController::IsSupportEnableOptimizeForFullScreenVideoClip ( )

pure virtual

Determines if the current meeting supports sharing with optimize video or not.

Returns

true indicates this is supported.

IsSupportEnableOptimizeForFullScreenVideoClip() [2/2]

virtual bool IMeetingShareController::IsSupportEnableOptimizeForFullScreenVideoClip ( bool & bCurEnableOrNot )

pure virtual

Determines 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.

Note

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

Determines 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.

Note

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

Determines 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.

LockShare()

virtual SDKError IMeetingShareController::LockShare ( bool isLock )

pure virtual

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

Parameters

isLock

true indicates to lock the meeting share, false not.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

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, this function returns an error.

Note

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, this function returns an error.

Note

Valid for both ZOOM style and user custom interface mode.

SetAudioShareMode()

virtual SDKError IMeetingShareController::SetAudioShareMode ( AudioShareMode mode )

pure virtual

Sets the audio share mode before or during sharing.

Parameters

mode	The mode for audio share.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Note

Valid for both ZOOM style and user custom interface mode.

SetEvent()

virtual SDKError IMeetingShareController::SetEvent ( IMeetingShareCtrlEvent * pEvent )

pure virtual

Sets 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, this function returns an error.

SetMultiShareSettingOptions()

virtual SDKError IMeetingShareController::SetMultiShareSettingOptions ( MultiShareOption shareOption )

pure virtual

Sets the options for multi-participants share.

Parameters

[in]

shareOption

New options for sharing.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

StopShare()

virtual SDKError IMeetingShareController::StopShare ( )

pure virtual

Stops the current sharing.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Note

Valid for both ZOOM style and user custom 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, this function returns an error.