Meeting Control helper interface. More...

#include <IMeetingControlHelper.h>

Public Member Functions
virtual	~IMeetingControlHelper ()

virtual ZRCSDKError	RegisterSink (IMeetingControlHelperSink *pSink)=0
	Register meeting control helper callback sink.

virtual ZRCSDKError	DeregisterSink (IMeetingControlHelperSink *pSink)=0
	Deregister meeting control helper callback sink.

virtual ZRCSDKError	ShowTopBanner (bool show)=0
	Show the top banner.

virtual ZRCSDKError	LockMeeting (bool lock)=0
	Lock meeting.

virtual ZRCSDKError	StartFocusMode (bool start)=0
	Start focus mode.

virtual ZRCSDKError	EnableHiFiMusicMode (bool enable)=0
	Enable High-fidelity music mode.

virtual ZRCSDKError	HasNewAppSignaling (bool &has)=0
	Query if has new app signaling.

virtual ZRCSDKError	ListSignalingApps ()=0
	List signaling apps.

virtual ZRCSDKError	ListSignalingAppAccessedUsers (const std::string &appID)=0
	List signaling app accessed users.

virtual ZRCSDKError	GetSignalingAppPermissionLink (const std::string &appID)=0
	Get signaling app permission link.

virtual ZRCSDKError	StartMeetingSummary (bool start)=0
	Start meeting summary.

virtual ZRCSDKError	StartMeetingQuery (bool start)=0
	Start meeting query.

virtual ZRCSDKError	ChangeMeetingQueryPrivilegeSetting (int32_t privilegeSettingID)=0
	Change meeting query privilege setting.

virtual ZRCSDKError	SetMeetingSummaryNotificationEmail (const std::string &email)=0
	Set meeting summary notification email.

virtual ZRCSDKError	TurnOnAICompanion (int64_t AICFeatures)=0
	Turn on some AI Companion features (Excluding AICompanionOptionSmartRecording).

virtual ZRCSDKError	TurnOffAICompanion (int64_t AICFeatures, bool deleteAssets)=0
	Turn off any AI Companion features.

virtual ZRCSDKError	RespondToTurnOnAICompanion (bool agree)=0
	Respond to participant's request of turn on AI Companion.

virtual ZRCSDKError	RespondToTurnOffAICompanion (bool agree, bool deleteAssets)=0
	Respond to participant's request of turn off AI Companion.

virtual ZRCSDKError	AskHostToTurnOnAICompanion (int64_t AICFeatures)=0
	Request host to turn on some AI Companion features (Excluding AICompanionOptionSmartRecording).

virtual ZRCSDKError	AskHostToTurnOffAllAICompanion ()=0
	Request host to turn off all AI Companion features.

virtual ZRCSDKError	ConfirmAICompanionStatusWhenJoin (bool agree)=0
	Confirm AI Companion status modified by participant while host join meeting.

virtual ZRCSDKError	AskToEnableAICompanion (AICompanionOption feature)=0
	Ask the account admins to enable AI Companion features (Excluding AICompanionOptionSmartRecording).

virtual ZRCSDKError	ControlSidePanel (PanelType type, PanelAction action)=0
	Control the side panel on ZR.

Detailed Description

Meeting Control helper interface.

Definition at line 370 of file IMeetingControlHelper.h.

Constructor & Destructor Documentation

◆ ~IMeetingControlHelper()

virtual IMeetingControlHelper::~IMeetingControlHelper ( )

inlinevirtual

Definition at line 373 of file IMeetingControlHelper.h.

373{}

Member Function Documentation

◆ AskHostToTurnOffAllAICompanion()

virtual ZRCSDKError IMeetingControlHelper::AskHostToTurnOffAllAICompanion ( )

pure virtual

Request host to turn off all AI Companion features.

Since: 6.10

Zoom Rooms minimum version: 6.1.0

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

◆ AskHostToTurnOnAICompanion()

virtual ZRCSDKError IMeetingControlHelper::AskHostToTurnOnAICompanion ( int64_t AICFeatures )

pure virtual

Request host to turn on some AI Companion features (Excluding AICompanionOptionSmartRecording).

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

AICFeatures AI Companion features, see AICompanionOption

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

◆ AskToEnableAICompanion()

virtual ZRCSDKError IMeetingControlHelper::AskToEnableAICompanion ( AICompanionOption feature )

pure virtual

Ask the account admins to enable AI Companion features (Excluding AICompanionOptionSmartRecording).

Since: 6.3.0

Zoom Rooms minimum version: 6.2.0

Parameters

feature AI Companion feature, see AICompanionOption

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

◆ ChangeMeetingQueryPrivilegeSetting()

virtual ZRCSDKError IMeetingControlHelper::ChangeMeetingQueryPrivilegeSetting ( int32_t privilegeSettingID )

pure virtual

Change meeting query privilege setting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

privilegeSettingID Specify the setting ID.

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

◆ ConfirmAICompanionStatusWhenJoin()

virtual ZRCSDKError IMeetingControlHelper::ConfirmAICompanionStatusWhenJoin ( bool agree )

pure virtual

Confirm AI Companion status modified by participant while host join meeting.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

agree TRUE indicates to turn off AI Companion and delete assets. Otherwise not

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

◆ ControlSidePanel()

virtual ZRCSDKError IMeetingControlHelper::ControlSidePanel	(	PanelType	type,
		PanelAction	action
	)

pure virtual

Control the side panel on ZR.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

type	Panel type, see PanelType enum.
action	Panel action, see PanelAction 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 IMeetingControlHelper::DeregisterSink ( IMeetingControlHelperSink * pSink )

pure virtual

Deregister meeting control helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IMeetingControlHelperSink that receives the meeting control helper event callback.

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

◆ EnableHiFiMusicMode()

virtual ZRCSDKError IMeetingControlHelper::EnableHiFiMusicMode ( bool enable )

pure virtual

Enable High-fidelity music mode.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

enable TRUE indicates to enable HiFi music mode.

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

Changelog

6.6.0: Added a restriction can't enable HiFi music mode when microphone stethoscope mode is enabled. Whether the microphone stethoscope mode is enabled, please refer to ISettingServiceSink::OnUpdateMicStethoscopeModeEnabledStatus.

◆ GetSignalingAppPermissionLink()

virtual ZRCSDKError IMeetingControlHelper::GetSignalingAppPermissionLink ( const std::string & appID )

pure virtual

Get signaling app permission link.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

appID Specify the app ID

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

◆ HasNewAppSignaling()

virtual ZRCSDKError IMeetingControlHelper::HasNewAppSignaling ( bool & has )

pure virtual

Query if has new app signaling.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] has TRUE indicates has new app signaling now.

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

◆ ListSignalingAppAccessedUsers()

virtual ZRCSDKError IMeetingControlHelper::ListSignalingAppAccessedUsers ( const std::string & appID )

pure virtual

List signaling app accessed users.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

appID Specify the app ID to list.

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

◆ ListSignalingApps()

virtual ZRCSDKError IMeetingControlHelper::ListSignalingApps ( )

pure virtual

List signaling apps.

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.

◆ LockMeeting()

virtual ZRCSDKError IMeetingControlHelper::LockMeeting ( bool lock )

pure virtual

Lock meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

lock	TRUE indicates to lock current meeting.

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

◆ RegisterSink()

virtual ZRCSDKError IMeetingControlHelper::RegisterSink ( IMeetingControlHelperSink * pSink )

pure virtual

Register meeting control helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IMeetingControlHelperSink that receives the meeting control helper event callback.

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

◆ RespondToTurnOffAICompanion()

virtual ZRCSDKError IMeetingControlHelper::RespondToTurnOffAICompanion	(	bool	agree,
		bool	deleteAssets
	)

pure virtual

Respond to participant's request of turn off AI Companion.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

agree	TRUE indicates to turn off AI Companion. Otherwise not
deleteAssets	TRUE indicates to delete assets generated by AI Companion. Otherwise not.

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

◆ RespondToTurnOnAICompanion()

virtual ZRCSDKError IMeetingControlHelper::RespondToTurnOnAICompanion ( bool agree )

pure virtual

Respond to participant's request of turn on AI Companion.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

agree TRUE indicates to turn on AI Companion. Otherwise not

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

◆ SetMeetingSummaryNotificationEmail()

virtual ZRCSDKError IMeetingControlHelper::SetMeetingSummaryNotificationEmail ( const std::string & email )

pure virtual

Set meeting summary notification email.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

email The email to receive notification.

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

◆ ShowTopBanner()

virtual ZRCSDKError IMeetingControlHelper::ShowTopBanner ( bool show )

pure virtual

Show the top banner.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

show	TRUE indicates to show Zoom Room top banner.

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

◆ StartFocusMode()

virtual ZRCSDKError IMeetingControlHelper::StartFocusMode ( bool start )

pure virtual

Start focus mode.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

start TRUE indicates to start focus mode.

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

◆ StartMeetingQuery()

virtual ZRCSDKError IMeetingControlHelper::StartMeetingQuery ( bool start )

pure virtual

Start meeting query.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

start TRUE indicates to start meeting query. Otherwise stop.

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

◆ StartMeetingSummary()

virtual ZRCSDKError IMeetingControlHelper::StartMeetingSummary ( bool start )

pure virtual

Start meeting summary.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

start TRUE indicates to start meeting summary. Otherwise stop.

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

◆ TurnOffAICompanion()

virtual ZRCSDKError IMeetingControlHelper::TurnOffAICompanion	(	int64_t	AICFeatures,
		bool	deleteAssets
	)

pure virtual

Turn off any AI Companion features.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

AICFeatures	AI Companion features , see AICompanionOption
deleteAssets	TRUE indicates to delete assets generated by AI Companion. Otherwise not

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

◆ TurnOnAICompanion()

virtual ZRCSDKError IMeetingControlHelper::TurnOnAICompanion ( int64_t AICFeatures )

pure virtual

Turn on some AI Companion features (Excluding AICompanionOptionSmartRecording).

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

AICFeatures AI Companion features , see AICompanionOption

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

◆ ~IMeetingControlHelper()

Member Function Documentation

◆ AskHostToTurnOffAllAICompanion()

◆ AskHostToTurnOnAICompanion()

◆ AskToEnableAICompanion()

◆ ChangeMeetingQueryPrivilegeSetting()

◆ ConfirmAICompanionStatusWhenJoin()

◆ ControlSidePanel()

◆ DeregisterSink()

◆ EnableHiFiMusicMode()

◆ GetSignalingAppPermissionLink()

◆ HasNewAppSignaling()

◆ ListSignalingAppAccessedUsers()

◆ ListSignalingApps()

◆ LockMeeting()

◆ RegisterSink()

◆ RespondToTurnOffAICompanion()

◆ RespondToTurnOnAICompanion()

◆ SetMeetingSummaryNotificationEmail()

◆ ShowTopBanner()

◆ StartFocusMode()

◆ StartMeetingQuery()

◆ StartMeetingSummary()

◆ TurnOffAICompanion()

◆ TurnOnAICompanion()