Meeting SDK for Linux API Reference
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
IMeetingShareController Class Referenceabstract

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 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 SDKError EnableShareComputerSound (bool bEnable)=0
 Set to enable or disable the audio before sharing.
 
virtual SDKError EnableShareComputerSoundWhenSharing (bool bEnable)=0
 Set to enable or disable the 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 SDKError EnableOptimizeForFullScreenVideoClip (bool bEnable)=0
 Set to enable the video optimization before sharing.
 
virtual SDKError EnableOptimizeForFullScreenVideoClipWhenSharing (bool bEnable)=0
 Set to enable 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.
 

Detailed Description

Meeting share controller interface.

Definition at line 156 of file meeting_sharing_interface.h.

Member Function Documentation

◆ 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]reasonThe 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.

◆ EnableOptimizeForFullScreenVideoClip()

virtual SDKError IMeetingShareController::EnableOptimizeForFullScreenVideoClip ( bool bEnable)
pure virtual

Set to enable the video optimization before sharing.

Parameters
bEnableTRUE 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
bEnableTRUE 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
bEnableTRUE 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
bEnableTRUE 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
modeThe 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]shareOptionOptions 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
userIDThe 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.

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

◆ IsShareLocked()

virtual SDKError IMeetingShareController::IsShareLocked ( bool & bLocked)
pure virtual

Determine if the sharing is locked.

Parameters
bLockedTRUE 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
bCurEnableOrNotThis 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]bCurEnableOrNotThe 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.

◆ LockShare()

virtual SDKError IMeetingShareController::LockShare ( bool isLock)
pure virtual

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

Parameters
isLockTRUE 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
modeThe 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
pEventA 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]shareOptionNew 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.

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

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