Meeting Share helper event callback. More...

#include <IMeetingShareHelper.h>

Public Member Functions
virtual	~IMeetingShareHelperSink ()

virtual void	OnStartLocalPresentNotification (const LocalPresentationInfo &info)=0
	Start local present meeting notification.

virtual void	OnStartLocalPresentResult (bool isSharingMeeting, SharingInstructionDisplayState displayState)=0
	Start local present meeting response.

virtual void	OnSwitchToNormalMeetingResult (int result)=0
	Switch local presentation to normal meeting result.

virtual void	OnShowSharingInstructionResult (int result, bool show, SharingInstructionDisplayState instructionState)=0
	Show or dismiss the sharing instruction on Zoom Room's screen result.

virtual void	OnShareSettingNotification (const ShareSetting &setting)=0
	Share setting changed callback.

virtual void	OnSharingStatusNotification (const SharingStatus &status)=0
	Sharing status changed callback.

virtual void	OnUpdateAirPlayBlackMagicStatus (const AirplayBlackMagicStatus &status)=0
	Airplay black magic status changed callback.

virtual void	OnUpdateCameraSharingStatus (const CameraSharingStatus &status)=0
	Camera sharing status changed callback.

virtual void	OnSharingSourceNotification (const std::vector< ShareSource > &zrShareSources, const std::vector< ShareSource > &zrwShareSources)=0
	Sharing source changed callback.

virtual void	OnHDMI60FPSShareInfoNotification (bool isAllow, bool isOn, HDMI60FPSShareDisableReason disableReason)=0
	HDMI 60 FPS share info notification.

virtual void	OnLocalHDMIShareAudioPlaybackNotification (bool isEnabled)=0
	Local HDMI share audio playback notification.

virtual void	OnUpdateWhiteboardShareStatusNotification (bool isSharing)=0
	Whiteboard share status notification.

virtual void	OnZRWSharingStatusNotification (const ZRWSharingStatus &status)=0
	ZRW Sharing status changed callback.

virtual void	OnUpdateLocalViewStatus (bool isOn)=0
	Update local view status notification.

virtual void	OnIncomingMeetingShareNotification (const IncomingMeetingShareNot &noti)=0
	Incoming meeting share notification.

virtual void	OnSlideControlNotification (const std::vector< SlideControlInfo > &slideControlInfos)=0
	Slide control notification.

virtual void	OnDocsShareSettingsNotification (const DocsShareSettingsInfo &info)=0
	Docs share settings notification.

Detailed Description

Meeting Share helper event callback.

Definition at line 244 of file IMeetingShareHelper.h.

Constructor & Destructor Documentation

◆ ~IMeetingShareHelperSink()

virtual IMeetingShareHelperSink::~IMeetingShareHelperSink ( )

inlinevirtual

Definition at line 247 of file IMeetingShareHelper.h.

247{}

Member Function Documentation

◆ OnDocsShareSettingsNotification()

virtual void IMeetingShareHelperSink::OnDocsShareSettingsNotification ( const DocsShareSettingsInfo & info )

pure virtual

Docs share settings notification.

Since: 6.4.0

Zoom Rooms minimum version: 6.4.0

Parameters

info	The docs share settings info.

◆ OnHDMI60FPSShareInfoNotification()

virtual void IMeetingShareHelperSink::OnHDMI60FPSShareInfoNotification	(	bool	isAllow,
		bool	isOn,
		HDMI60FPSShareDisableReason	disableReason
	)

pure virtual

HDMI 60 FPS share info notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

isAllow	TRUE indicates hdmi 60 fps share is allowed.
isOn	TRUE indicates hdmi 60 fps share is on.
disableReason	Disable reason, see HDMI60FPSShareDisableReason enum.

◆ OnIncomingMeetingShareNotification()

virtual void IMeetingShareHelperSink::OnIncomingMeetingShareNotification ( const IncomingMeetingShareNot & noti )

pure virtual

Incoming meeting share notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

noti	The notification info.

Changelog

6.4.0: In addition to the existing local HDMI share type, other CurrentShareType options have been added.

◆ OnLocalHDMIShareAudioPlaybackNotification()

virtual void IMeetingShareHelperSink::OnLocalHDMIShareAudioPlaybackNotification ( bool isEnabled )

pure virtual

Local HDMI share audio playback notification.

Since: 6.4.0

Zoom Rooms minimum version: 6.4.0

Parameters

isEnabled TRUE indicates local HDMI share audio playback is enabled.

◆ OnShareSettingNotification()

virtual void IMeetingShareHelperSink::OnShareSettingNotification ( const ShareSetting & setting )

pure virtual

Share setting changed callback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

setting The updated share setting.

◆ OnSharingSourceNotification()

virtual void IMeetingShareHelperSink::OnSharingSourceNotification	(	const std::vector< ShareSource > &	zrShareSources,
		const std::vector< ShareSource > &	zrwShareSources
	)

pure virtual

Sharing source changed callback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

zrShareSources	All of meeting's sharing source list.
zrwShareSources	Zoom Room Companion Whiteboard received share source list.

◆ OnSharingStatusNotification()

virtual void IMeetingShareHelperSink::OnSharingStatusNotification ( const SharingStatus & status )

pure virtual

Sharing status changed callback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

status The updated sharing status.

◆ OnShowSharingInstructionResult()

virtual void IMeetingShareHelperSink::OnShowSharingInstructionResult	(	int	result,
		bool	show,
		SharingInstructionDisplayState	instructionState
	)

pure virtual

Show or dismiss the sharing instruction on Zoom Room's screen result.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

result	[0] success.
show	TRUE indicates to show the instruction on ZR screen, FALSE indicates to dismiss the instruction on ZR screen.
instructionState	The sharing instruction display state to show, see SharingInstructionDisplayState enum.

◆ OnSlideControlNotification()

virtual void IMeetingShareHelperSink::OnSlideControlNotification ( const std::vector< SlideControlInfo > & slideControlInfos )

pure virtual

Slide control notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

slideControlInfos Available slide control infos.

Changelog

6.3.0: Changed from std::vector<MeetingParticipant>& slideControlUsers to std::vector<SlideControlInfo>& slideControlInfos for multi-session-share.

◆ OnStartLocalPresentNotification()

virtual void IMeetingShareHelperSink::OnStartLocalPresentNotification ( const LocalPresentationInfo & info )

pure virtual

Start local present meeting notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

info	Local presentation info.

◆ OnStartLocalPresentResult()

virtual void IMeetingShareHelperSink::OnStartLocalPresentResult	(	bool	isSharingMeeting,
		SharingInstructionDisplayState	displayState
	)

pure virtual

Start local present meeting response.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

isSharingMeeting	Start local present meeting request sharing meeting.
displayState	Start local present meeting requested display state, see SharingInstructionDisplayState enum.

◆ OnSwitchToNormalMeetingResult()

virtual void IMeetingShareHelperSink::OnSwitchToNormalMeetingResult ( int result )

pure virtual

Switch local presentation to normal meeting result.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

result [0] success.

◆ OnUpdateAirPlayBlackMagicStatus()

virtual void IMeetingShareHelperSink::OnUpdateAirPlayBlackMagicStatus ( const AirplayBlackMagicStatus & status )

pure virtual

Airplay black magic status changed callback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

status The updated Airplay black magic status.

◆ OnUpdateCameraSharingStatus()

virtual void IMeetingShareHelperSink::OnUpdateCameraSharingStatus ( const CameraSharingStatus & status )

pure virtual

Camera sharing status changed callback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

status The updated camera sharing status.

◆ OnUpdateLocalViewStatus()

virtual void IMeetingShareHelperSink::OnUpdateLocalViewStatus ( bool isOn )

pure virtual

Update local view status notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

isOn	TRUE indicates local view for triple screens is configured and enabled. Otherwise not.

◆ OnUpdateWhiteboardShareStatusNotification()

virtual void IMeetingShareHelperSink::OnUpdateWhiteboardShareStatusNotification ( bool isSharing )

pure virtual

Whiteboard share status notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

isSharing TRUE indicates is sharing whiteboard.

◆ OnZRWSharingStatusNotification()

virtual void IMeetingShareHelperSink::OnZRWSharingStatusNotification ( const ZRWSharingStatus & status )

pure virtual

ZRW Sharing status changed callback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

status The updated ZRW sharing status.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IMeetingShareHelperSink()

Member Function Documentation

◆ OnDocsShareSettingsNotification()

◆ OnHDMI60FPSShareInfoNotification()

◆ OnIncomingMeetingShareNotification()

◆ OnLocalHDMIShareAudioPlaybackNotification()

◆ OnShareSettingNotification()

◆ OnSharingSourceNotification()

◆ OnSharingStatusNotification()

◆ OnShowSharingInstructionResult()

◆ OnSlideControlNotification()

◆ OnStartLocalPresentNotification()

◆ OnStartLocalPresentResult()

◆ OnSwitchToNormalMeetingResult()

◆ OnUpdateAirPlayBlackMagicStatus()

◆ OnUpdateCameraSharingStatus()

◆ OnUpdateLocalViewStatus()

◆ OnUpdateWhiteboardShareStatusNotification()

◆ OnZRWSharingStatusNotification()