Zoom Rooms Controller SDK Reference 6.5.0
Loading...
Searching...
No Matches
IMeetingControlHelperSink Class Referenceabstract

Meeting Control helper event callback. More...

#include <IMeetingControlHelper.h>

Public Member Functions

virtual ~IMeetingControlHelperSink ()
 
virtual void OnUpdateIsDisplayTopBannerNotification (bool isDisplayTopBanner)=0
 Display top banner status notification.
 
virtual void OnUpdateMeetingLockStatus (bool meetingLocked)=0
 Meeting lock status notification.
 
virtual void OnUpdateFocusModeOptionsNotification (bool enable, FocusModeStatus status)=0
 Focus mode options update notification.
 
virtual void OnUpdateLiveStreamStatus (const LiveStreamStatus &status)=0
 Live streaming status notification.
 
virtual void OnHiFiMusicModeNotification (bool isAllow, bool isEnable)=0
 HiFi music mode notification.
 
virtual void OnHasAppSignalingChanged (bool hasNewAppSignaling)=0
 Has new app signaling notification.
 
virtual void OnUpdateSignalingApps (const SignalingAppList &list)=0
 Update signaling apps notification.
 
virtual void OnUpdateAccessedUsers (const SignalingAppAccessedUserList &list)=0
 Update signaling apps accessed users notification.
 
virtual void OnUpdateAppPermissionLink (const SignalingAppPermissionLink &link)=0
 Update signaling apps permission link notification.
 
virtual void OnArchivingStatusNotification (bool isInProgress)=0
 Archiving status notification.
 
virtual void OnShowArchivingStatusFailNotification (bool showArchivingFail)=0
 Show archiving fail notification.
 
virtual void OnZoomPhoneACRStatusNotification (bool isInProgress)=0
 Zoom phone ACR status notification.
 
virtual void OnSmartSummaryOn (bool summaryOn, bool hasSetEmail)=0
 Smart summary status notification.
 
virtual void OnSetMeetingSummaryNotificationEmailNotification (int32_t result)=0
 Set smart summary notification email notification.
 
virtual void OnUpdateMeetingQueryBaseInfo (const MeetingQueryInfo &info)=0
 Update meeting query base info notification.
 
virtual void OnChangeMeetingQueryPrivilegeSettingID (int32_t settingID)=0
 Change meeting query privilege setting notification.
 
virtual void OnReceiveAICompanionRequest (const AICompanionRequestInfo &info)=0
 Participants request to switch AI Companion features notification.
 
virtual void OnAICompanionStatusNeedConfirm (const AICompanionStatusInfo &info)=0
 AI Companion status modified by participant before host join meeting notification.
 

Detailed Description

Meeting Control helper event callback.

Definition at line 153 of file IMeetingControlHelper.h.

Constructor & Destructor Documentation

◆ ~IMeetingControlHelperSink()

virtual IMeetingControlHelperSink::~IMeetingControlHelperSink ( )
inlinevirtual

Definition at line 156 of file IMeetingControlHelper.h.

156{}

Member Function Documentation

◆ OnAICompanionStatusNeedConfirm()

virtual void IMeetingControlHelperSink::OnAICompanionStatusNeedConfirm ( const AICompanionStatusInfo info)
pure virtual

AI Companion status modified by participant before host join meeting notification.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Parameters
infoAIC status.

◆ OnArchivingStatusNotification()

virtual void IMeetingControlHelperSink::OnArchivingStatusNotification ( bool  isInProgress)
pure virtual

Archiving status notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
isInProgressTRUE indicates archiving is in progress. Otherwise not.

◆ OnChangeMeetingQueryPrivilegeSettingID()

virtual void IMeetingControlHelperSink::OnChangeMeetingQueryPrivilegeSettingID ( int32_t  settingID)
pure virtual

Change meeting query privilege setting notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
settingIDPrivilege setting ID.

◆ OnHasAppSignalingChanged()

virtual void IMeetingControlHelperSink::OnHasAppSignalingChanged ( bool  hasNewAppSignaling)
pure virtual

Has new app signaling notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
hasNewAppSignalingTRUE indicates has new app signaling.

◆ OnHiFiMusicModeNotification()

virtual void IMeetingControlHelperSink::OnHiFiMusicModeNotification ( bool  isAllow,
bool  isEnable 
)
pure virtual

HiFi music mode notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
isAllowTRUE indicates HiFi music mode is allowed.
isEnableTRUE indicates HiFi music mode is enabled.

◆ OnReceiveAICompanionRequest()

virtual void IMeetingControlHelperSink::OnReceiveAICompanionRequest ( const AICompanionRequestInfo info)
pure virtual

Participants request to switch AI Companion features notification.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Parameters
inforequest detail info.

◆ OnSetMeetingSummaryNotificationEmailNotification()

virtual void IMeetingControlHelperSink::OnSetMeetingSummaryNotificationEmailNotification ( int32_t  result)
pure virtual

Set smart summary notification email notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
result[0] Success.

◆ OnShowArchivingStatusFailNotification()

virtual void IMeetingControlHelperSink::OnShowArchivingStatusFailNotification ( bool  showArchivingFail)
pure virtual

Show archiving fail notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
showArchivingFailTRUE indicates show archiving failed. Otherwise not.

◆ OnSmartSummaryOn()

virtual void IMeetingControlHelperSink::OnSmartSummaryOn ( bool  summaryOn,
bool  hasSetEmail 
)
pure virtual

Smart summary status notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
summaryOnTRUE indicates smart summary is on. Otherwise not.
hasSetEmailTRUE indicates smart summary notification email has been set. Otherwise not.

◆ OnUpdateAccessedUsers()

virtual void IMeetingControlHelperSink::OnUpdateAccessedUsers ( const SignalingAppAccessedUserList list)
pure virtual

Update signaling apps accessed users notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
listThe signaling apps accessed user list.

◆ OnUpdateAppPermissionLink()

virtual void IMeetingControlHelperSink::OnUpdateAppPermissionLink ( const SignalingAppPermissionLink link)
pure virtual

Update signaling apps permission link notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
linkThe signaling app permission link

◆ OnUpdateFocusModeOptionsNotification()

virtual void IMeetingControlHelperSink::OnUpdateFocusModeOptionsNotification ( bool  enable,
FocusModeStatus  status 
)
pure virtual

Focus mode options update notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
enableTRUE indicates focus mode feature is enabled.
statusFocus mode status, see FocusModeStatus enum.

◆ OnUpdateIsDisplayTopBannerNotification()

virtual void IMeetingControlHelperSink::OnUpdateIsDisplayTopBannerNotification ( bool  isDisplayTopBanner)
pure virtual

Display top banner status notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
isDisplayTopBannerTRUE indicates Zoom Room's top banner is being displayed.

◆ OnUpdateLiveStreamStatus()

virtual void IMeetingControlHelperSink::OnUpdateLiveStreamStatus ( const LiveStreamStatus status)
pure virtual

Live streaming status notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
statusLive streaming status.

◆ OnUpdateMeetingLockStatus()

virtual void IMeetingControlHelperSink::OnUpdateMeetingLockStatus ( bool  meetingLocked)
pure virtual

Meeting lock status notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
meetingLockedTRUE indicates meeting is locked.

◆ OnUpdateMeetingQueryBaseInfo()

virtual void IMeetingControlHelperSink::OnUpdateMeetingQueryBaseInfo ( const MeetingQueryInfo info)
pure virtual

Update meeting query base info notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
infoMeeting query info.

◆ OnUpdateSignalingApps()

virtual void IMeetingControlHelperSink::OnUpdateSignalingApps ( const SignalingAppList list)
pure virtual

Update signaling apps notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
listThe signaling app list.

◆ OnZoomPhoneACRStatusNotification()

virtual void IMeetingControlHelperSink::OnZoomPhoneACRStatusNotification ( bool  isInProgress)
pure virtual

Zoom phone ACR status notification.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
isInProgressTRUE indicates Zoom phone ACR is in progress. Otherwise not.