Meeting Share helper interface. More...

#include <IMeetingShareHelper.h>

Public Member Functions
virtual	~IMeetingShareHelper ()

virtual ZRCSDKError	RegisterSink (IMeetingShareHelperSink *pSink)=0
	Register meeting share helper callback sink.

virtual ZRCSDKError	DeregisterSink (IMeetingShareHelperSink *pSink)=0
	Deregister meeting share helper callback sink.

virtual ZRCSDKError	LaunchSharingMeeting (bool isInLocalShare, SharingInstructionDisplayState displayState)=0
	Launch a sharing meeting.

virtual ZRCSDKError	SwitchFromLocalPresentationToNormalMeeting ()=0
	Switch local presentation to normal meeting.

virtual ZRCSDKError	ShowSharingInstruction (bool show, SharingInstructionDisplayState instructionState)=0
	Show or dismiss the sharing instruction on Zoom Room's screen.

virtual ZRCSDKError	ShareBlackMagic (bool isStart, bool isViewLocally)=0
	Share HDMI.

virtual ZRCSDKError	ShareCamera (bool isStart, const std::string &deviceId)=0
	Share camera.

virtual ZRCSDKError	ShareToBreakoutRooms ()=0
	Share the current source to all breakout rooms.

virtual ZRCSDKError	StopShareToBreakoutRooms ()=0
	Stop share to breakout rooms.

virtual ZRCSDKError	StopSharing ()=0
	Stop Zoom Room's sharing.

virtual ZRCSDKError	StopZRWSharing ()=0
	Stop Zoom Room Companion Whiteboard's sharing.

virtual ZRCSDKError	EnableMultiShare (bool enabled)=0
	Turn on or off multi share function for current meeting.

virtual ZRCSDKError	ShowPinShareInstruction (bool show)=0
	Show the screen index of each display.

virtual ZRCSDKError	PinShareOnZRScreen (const ShareSource &shareSource, int32_t screenIndex, bool confirmed)=0
	Pin share source on Zoom Room's screen.

virtual ZRCSDKError	PinShareOnZRWScreen (const ShareSource &shareSource, int32_t screenIndex)=0
	Pin share source on Zoom Room Companion Whiteboard's screen.

virtual ZRCSDKError	PinIncomingMeetingShare (const ShareSource &incomingShare, CurrentShareType currentShare, bool pin)=0
	Pin incoming meeting share.

virtual ZRCSDKError	ControlSlide (const SlideControlInfo &slideInfo, SlideOperationType type)=0
	Control slide.

virtual ZRCSDKError	MuteShareAudio (const ShareSource &source, bool mute)=0
	Mute or unmute the sharing audio.

virtual ZRCSDKError	EnableHDMI60FPSShare (bool enable)=0
	Enable HDMI share in 60fps.

virtual ZRCSDKError	GetLocalHDMIShareAudioPlaybackStatus (bool &isSupport, bool &isEnabled)=0
	Query local HDMI share audio playback status.

virtual ZRCSDKError	EnableLocalHDMIShareAudioPlayback (bool enable)=0
	Enable local HDMI share audio playback.

virtual ZRCSDKError	SetMeetingShareSetting (MeetingSharePrivilegeType type)=0
	Set meeting share privilege type.

virtual ZRCSDKError	SetMeetingShareViewPrivilege (MeetingShareViewPrivilege type)=0
	Set meeting share view privilege.

virtual ZRCSDKError	OptimizeVideoSharing (bool optimize)=0
	Optimize video sharing.

virtual ZRCSDKError	AllowParticipantsShareDocs (bool allow)=0
	Allow participants share docs.

virtual ZRCSDKError	ChangeDocsSharePrivilege (DocsSharePrivilegeType type)=0
	Change docs share privilege type.

virtual ZRCSDKError	ChangeDocsInitiatePrivilege (DocsInitiatePrivilegeType type)=0
	Change docs initiate privilege type.

virtual ZRCSDKError	GetDocsShareSettingsInfo (DocsShareSettingsInfo &info)=0
	Get docs share settings info.

virtual ZRCSDKError	EnableAnnotationOverHDMI (bool enable)=0
	Enable annotation over HDMI (disabled by default in Android ZR due to performance)

Detailed Description

Meeting Share helper interface.

Definition at line 434 of file IMeetingShareHelper.h.

Constructor & Destructor Documentation

◆ ~IMeetingShareHelper()

virtual IMeetingShareHelper::~IMeetingShareHelper ( )

inlinevirtual

Definition at line 437 of file IMeetingShareHelper.h.

437{}

Member Function Documentation

◆ AllowParticipantsShareDocs()

virtual ZRCSDKError IMeetingShareHelper::AllowParticipantsShareDocs ( bool allow )

pure virtual

Allow participants share docs.

Since: 6.4.0

Zoom Rooms minimum version: 6.4.0

Parameters

allow TRUE indicates to allow participant to share docs. Otherwise not.

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

◆ ChangeDocsInitiatePrivilege()

virtual ZRCSDKError IMeetingShareHelper::ChangeDocsInitiatePrivilege ( DocsInitiatePrivilegeType type )

pure virtual

Change docs initiate privilege type.

Since: 6.4.0

Zoom Rooms minimum version: 6.4.0

Parameters

type	Specify the docs initiate privilege type.

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

◆ ChangeDocsSharePrivilege()

virtual ZRCSDKError IMeetingShareHelper::ChangeDocsSharePrivilege ( DocsSharePrivilegeType type )

pure virtual

Change docs share privilege type.

Since: 6.4.0

Zoom Rooms minimum version: 6.4.0

Parameters

type	Specify the docs share privilege type.

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

◆ ControlSlide()

virtual ZRCSDKError IMeetingShareHelper::ControlSlide	(	const SlideControlInfo &	slideInfo,
		SlideOperationType	type
	)

pure virtual

Control slide.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

slideInfo	The slide info that you want to control. Changed in version 6.3.0 for multi-session-share.
type	Operation type, see SlideOperationType enum.

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

◆ DeregisterSink()

virtual ZRCSDKError IMeetingShareHelper::DeregisterSink ( IMeetingShareHelperSink * pSink )

pure virtual

Deregister meeting share helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IMeetingShareHelperSink that receives the meeting share helper callback.

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

◆ EnableAnnotationOverHDMI()

virtual ZRCSDKError IMeetingShareHelper::EnableAnnotationOverHDMI ( bool enable )

pure virtual

Enable annotation over HDMI (disabled by default in Android ZR due to performance)

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

enable TRUE indicates to enable annotation over HDMI, otherwise not.

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

◆ EnableHDMI60FPSShare()

virtual ZRCSDKError IMeetingShareHelper::EnableHDMI60FPSShare ( bool enable )

pure virtual

Enable HDMI share in 60fps.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

enable TRUE indicates to enable HDMI share in 60fps. Otherwise not.

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

◆ EnableLocalHDMIShareAudioPlayback()

virtual ZRCSDKError IMeetingShareHelper::EnableLocalHDMIShareAudioPlayback ( bool enable )

pure virtual

Enable local HDMI share audio playback.

Since: 6.4.0

Zoom Rooms minimum version: 6.4.0

Parameters

enable TRUE indicates to enable HDMI share audio playback.

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

◆ EnableMultiShare()

virtual ZRCSDKError IMeetingShareHelper::EnableMultiShare ( bool enabled )

pure virtual

Turn on or off multi share function for current meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

This API can only be called by host or co-host.

Parameters

enabled TRUE indicates to turn on multi share. Otherwise not.

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

◆ GetDocsShareSettingsInfo()

virtual ZRCSDKError IMeetingShareHelper::GetDocsShareSettingsInfo ( DocsShareSettingsInfo & info )

pure virtual

Get docs share settings info.

Since: 6.4.0

Zoom Rooms minimum version: 6.4.0

Parameters

[out] info The share docs setting info.

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

◆ GetLocalHDMIShareAudioPlaybackStatus()

virtual ZRCSDKError IMeetingShareHelper::GetLocalHDMIShareAudioPlaybackStatus	(	bool &	isSupport,
		bool &	isEnabled
	)

pure virtual

Query local HDMI share audio playback status.

Since: 6.4.0

Zoom Rooms minimum version: 6.4.0

Parameters

isSupport	TRUE indicates that enabling or disabling audio playback is supported. Otherwise not.
isEnabled	TRUE indicates that HDMI share audio playback is enabled. Otherwise not.

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

◆ LaunchSharingMeeting()

virtual ZRCSDKError IMeetingShareHelper::LaunchSharingMeeting	(	bool	isInLocalShare,
		SharingInstructionDisplayState	displayState
	)

pure virtual

Launch a sharing meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

isInLocalShare	TRUE indicate to start a local presentation, FALSE indicates to start a sharing meeting.
displayState	Specify the init display state, see SharingInstructionDisplayState enum.

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

◆ MuteShareAudio()

virtual ZRCSDKError IMeetingShareHelper::MuteShareAudio	(	const ShareSource &	source,
		bool	mute
	)

pure virtual

Mute or unmute the sharing audio.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

source	The Share source to control. Changed in version 6.3.0 for multi-session-share.
mute	TRUE indicates to mute the sharing audio, FALSE indicates to unmute the sharing audio.

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

◆ OptimizeVideoSharing()

virtual ZRCSDKError IMeetingShareHelper::OptimizeVideoSharing ( bool optimize )

pure virtual

Optimize video sharing.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

optimize TRUE indicates to enable optimize video sharing. Otherwise disable.

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

◆ PinIncomingMeetingShare()

virtual ZRCSDKError IMeetingShareHelper::PinIncomingMeetingShare	(	const ShareSource &	incomingShare,
		CurrentShareType	currentShare,
		bool	pin
	)

pure virtual

Pin incoming meeting share.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

incomingShare	The source of the incoming share, see MeetingScreen enum.
currentShare	Current pinned share type, see CurrentShareType enum.
pin	TRUE indicates to pin incoming share source. Otherwise not.

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

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

◆ PinShareOnZRScreen()

virtual ZRCSDKError IMeetingShareHelper::PinShareOnZRScreen	(	const ShareSource &	shareSource,
		int32_t	screenIndex,
		bool	confirmed
	)

pure virtual

Pin share source on Zoom Room's screen.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

When PinShareWarningType from OnUpdateScreenStatusForPinNotification is PinShareWarningTypeNoAnnotationForSelf or PinShareWarningTypeStopCameraShare, Need to set confirmed=TRUE to double confirm replace pin share on ZR screen.

Parameters

shareSource	Share source to pin. Changed in version 6.3.0 for multi-session-share.
screenIndex	Index of the screen to pin share, see MeetingScreen enum.
confirmed	When screen already pinned other share source, replace to pin new share source on the screen needs set confirmed to TRUE.

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

◆ PinShareOnZRWScreen()

virtual ZRCSDKError IMeetingShareHelper::PinShareOnZRWScreen	(	const ShareSource &	shareSource,
		int32_t	screenIndex
	)

pure virtual

Pin share source on Zoom Room Companion Whiteboard's screen.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

shareSource	The Share source to pin. Changed in version 6.3.0 for multi-session-share.
screenIndex	Index of ZRW's screen to pin share, see MeetingScreen enum.

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

◆ RegisterSink()

virtual ZRCSDKError IMeetingShareHelper::RegisterSink ( IMeetingShareHelperSink * pSink )

pure virtual

Register meeting share helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IMeetingShareHelperSink that receives the meeting share helper callback.

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

◆ SetMeetingShareSetting()

virtual ZRCSDKError IMeetingShareHelper::SetMeetingShareSetting ( MeetingSharePrivilegeType type )

pure virtual

Set meeting share privilege type.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

type	Meeting share privilege type, see MeetingSharePrivilegeType enum.

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

◆ SetMeetingShareViewPrivilege()

virtual ZRCSDKError IMeetingShareHelper::SetMeetingShareViewPrivilege ( MeetingShareViewPrivilege type )

pure virtual

Set meeting share view privilege.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

type	Meeting share view privilege, see MeetingShareViewPrivilege enum.

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

◆ ShareBlackMagic()

virtual ZRCSDKError IMeetingShareHelper::ShareBlackMagic	(	bool	isStart,
		bool	isViewLocally
	)

pure virtual

Share HDMI.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

isStart	TRUE indicates to start to share HDMI, FALSE indicates to stop to share HDMI.
isViewLocally	TRUE indicates to share HDMI locally, FALSE indicates to share HDMI to the meeting.

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

◆ ShareCamera()

virtual ZRCSDKError IMeetingShareHelper::ShareCamera	(	bool	isStart,
		const std::string &	deviceId
	)

pure virtual

Share camera.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

isStart	TRUE indicates to show the instruction on ZR screen, FALSE indicates to dismiss the instruction on ZR screen.
deviceId	Device ID of the camera.

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

Changelog

6.4.0: Added a restriction preventing an NDI camera that is currently selected as the main camera, multiple camera or intelligent director camera from being shared.

◆ ShareToBreakoutRooms()

virtual ZRCSDKError IMeetingShareHelper::ShareToBreakoutRooms ( )

pure virtual

Share the current source to all breakout rooms.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ ShowPinShareInstruction()

virtual ZRCSDKError IMeetingShareHelper::ShowPinShareInstruction ( bool show )

pure virtual

Show the screen index of each display.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

show	TRUE indicates to show the instruction on ZR screen. Otherwise not.

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

◆ ShowSharingInstruction()

virtual ZRCSDKError IMeetingShareHelper::ShowSharingInstruction	(	bool	show,
		SharingInstructionDisplayState	instructionState
	)

pure virtual

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

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

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.

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

◆ StopShareToBreakoutRooms()

virtual ZRCSDKError IMeetingShareHelper::StopShareToBreakoutRooms ( )

pure virtual

Stop share to breakout rooms.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ StopSharing()

virtual ZRCSDKError IMeetingShareHelper::StopSharing ( )

pure virtual

Stop Zoom Room's sharing.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ StopZRWSharing()

virtual ZRCSDKError IMeetingShareHelper::StopZRWSharing ( )

pure virtual

Stop Zoom Room Companion Whiteboard's sharing.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ SwitchFromLocalPresentationToNormalMeeting()

virtual ZRCSDKError IMeetingShareHelper::SwitchFromLocalPresentationToNormalMeeting ( )

pure virtual

Switch local presentation to normal meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IMeetingShareHelper()

Member Function Documentation

◆ AllowParticipantsShareDocs()

◆ ChangeDocsInitiatePrivilege()

◆ ChangeDocsSharePrivilege()

◆ ControlSlide()

◆ DeregisterSink()

◆ EnableAnnotationOverHDMI()

◆ EnableHDMI60FPSShare()

◆ EnableLocalHDMIShareAudioPlayback()

◆ EnableMultiShare()

◆ GetDocsShareSettingsInfo()

◆ GetLocalHDMIShareAudioPlaybackStatus()

◆ LaunchSharingMeeting()

◆ MuteShareAudio()

◆ OptimizeVideoSharing()

◆ PinIncomingMeetingShare()

◆ PinShareOnZRScreen()

◆ PinShareOnZRWScreen()

◆ RegisterSink()

◆ SetMeetingShareSetting()

◆ SetMeetingShareViewPrivilege()

◆ ShareBlackMagic()

◆ ShareCamera()

◆ ShareToBreakoutRooms()

◆ ShowPinShareInstruction()

◆ ShowSharingInstruction()

◆ StopShareToBreakoutRooms()

◆ StopSharing()

◆ StopZRWSharing()

◆ SwitchFromLocalPresentationToNormalMeeting()