Zoom Rooms Controller SDK Reference 7.2.0
Loading...
Searching...
No Matches
IMeetingControlHelper.h
Go to the documentation of this file.
1
6#ifndef IMeetingControlHelper_h
7#define IMeetingControlHelper_h
8
9#include "ZRCSDKTypes.h"
10
12
18{
22};
23
27{
31};
32
36{
39};
40
42{
44 AICompanionRequestSwitch, //request to switch AIC
45 AICompanionRequestEnable, //request to enable AIC
46};
47
49{
52};
53
55{
61};
62
68{
73};
74
78{
80 std::vector<std::string> selectedLiveStreams;
81 std::vector<std::string> supportedLiveStreams;
82};
83
87{
88 bool isInProgress = false;
89 std::string liveChannelName;
90};
91
95{
98 std::optional<CustomLiveStreamInfo> customLiveStreamInfo;
99};
100
104{
105 std::string userName;
106 std::string userGuid;
107 std::string avatarUrl;
108};
109
113{
114 std::string appID;
115 std::vector<SignalingAppAccessedUser> users;
116};
117
121{
122 std::string errorMessage;
123 std::string permissionLink;
124 std::string appID;
125};
126
130{
131 std::string appID;
132 std::string appName;
133 std::string appIconUrl;
134 std::string appPermissionLink;
135 std::vector<SignalingAppAccessedUser> accessedUsers;
136 int32_t accessedUserCount = 0;
137 std::vector<std::string> accessedScopes;
138};
139
143{
144 std::string errorMessage;
145 std::string title;
146 std::string summary;
147 std::vector<SignalingAppInfo> signalingApps;
148};
149
153{
154 int32_t settingID = 0;
155 std::string description;
156};
157
161{
163 bool isMeetingQueryOn = false;
167 std::vector<PrivilegeSettingItem> privilegeSettingItems;
168};
169
173{
175 std::vector<std::string> senderNames;
176 int64_t AICFeatures = 0;
177 int32_t switchAction = 0;
178};
179
183{
184 int64_t AICFeatures = 0;
185 int64_t assetsOption = 0;
186};
187
191{
192 bool isAllowRequest = true;
193 bool isRestricted = false;
194 std::string restrictedReason;
195};
196
200{
201public:
203
212 virtual void OnUpdateIsDisplayTopBannerNotification(bool isDisplayTopBanner) = 0;
213
222 virtual void OnUpdateMeetingLockStatus(bool meetingLocked) = 0;
223
233 virtual void OnUpdateFocusModeOptionsNotification(bool enable, FocusModeStatus status) = 0;
234
243 virtual void OnUpdateLiveStreamStatus(const LiveStreamStatus& status) = 0;
244
254 virtual void OnHiFiMusicModeNotification(bool isAllow, bool isEnable) = 0;
255
264 virtual void OnHasAppSignalingChanged(bool hasNewAppSignaling) = 0;
265
274 virtual void OnUpdateSignalingApps(const SignalingAppList& list) = 0;
275
285
295
304 virtual void OnArchivingStatusNotification(bool isInProgress) = 0;
305
314 virtual void OnShowArchivingStatusFailNotification(bool showArchivingFail) = 0;
315
324 virtual void OnZoomPhoneACRStatusNotification(bool isInProgress) = 0;
325
335 virtual void OnSmartSummaryOn(bool summaryOn, bool hasSetEmail) = 0;
336
345 virtual void OnSetMeetingSummaryNotificationEmailNotification(int32_t result) = 0;
346
355 virtual void OnUpdateMeetingQueryBaseInfo(const MeetingQueryInfo& info) = 0;
356
365 virtual void OnChangeMeetingQueryPrivilegeSettingID(int32_t settingID) = 0;
366
376
386
395 virtual void OnUpdateAICompanionInfo(const AICompanionInfo& info) = 0;
396
406 virtual void OnShowSidePanel(bool isShow, PanelType currentPanel) = 0;
407
416 virtual void OnUpdateMeetingMynotesSetting(const MeetingMynotesSetting& setting) = 0;
417};
418
422{
423public:
425
437
449
460 virtual ZRCSDKError ShowTopBanner(bool show) = 0;
461
472 virtual ZRCSDKError LockMeeting(bool lock) = 0;
473
484 virtual ZRCSDKError StartFocusMode(bool start) = 0;
485
499 virtual ZRCSDKError EnableHiFiMusicMode(bool enable) = 0;
500
513 virtual ZRCSDKError StartCustomLiveStream(bool start, const std::string& channelKey) = 0;
514
525 virtual ZRCSDKError HasNewAppSignaling(bool& has) = 0;
526
537
548 virtual ZRCSDKError ListSignalingAppAccessedUsers(const std::string& appID) = 0;
549
560 virtual ZRCSDKError GetSignalingAppPermissionLink(const std::string& appID) = 0;
561
572 virtual ZRCSDKError StartMeetingSummary(bool start) = 0;
573
584 virtual ZRCSDKError StartMeetingQuery(bool start) = 0;
585
596 virtual ZRCSDKError ChangeMeetingQueryPrivilegeSetting(int32_t privilegeSettingID) = 0;
597
608 virtual ZRCSDKError SetMeetingSummaryNotificationEmail(const std::string& email) = 0;
609
620 virtual ZRCSDKError TurnOnAICompanion(int64_t AICFeatures) = 0;
621
633 virtual ZRCSDKError TurnOffAICompanion(int64_t AICFeatures, bool deleteAssets) = 0;
634
646
658 virtual ZRCSDKError RespondToTurnOffAICompanion(bool agree, bool deleteAssets) = 0;
659
670 virtual ZRCSDKError AskHostToTurnOnAICompanion(int64_t AICFeatures) = 0;
671
682
694
705 virtual ZRCSDKError AllowUserRequestAI(bool allow) = 0;
706
718
731
743 virtual ZRCSDKError AllowMeetingMynotes(bool isAllow, int32_t userID = 0) = 0;
744
756
768};
769
771
772#endif /* IMeetingControlHelper_h */
LiveStreamState
Live stream state. Here are more detailed structural descriptions.
@ LiveStreamStateConnectFailed
Live stream failed to connect.
@ LiveStreamStateNone
Live stream has not started.
@ LiveStreamStateWaitingConnect
Live stream is waiting to connect.
@ LiveStreamStateInProgress
Live stream is in progress.
AICompanionSwitchAction
AI Companion switch action.
@ AICompanionSwitchActionTurnOn
Turn on.
@ AICompanionSwitchActionTurnOff
Turn off.
@ PanelTypeNone
@ PanelTypePList
Participant list side panel.
FocusModeStatus
Focus mode status. Here are more detailed structural descriptions.
@ FocusModeStatusEnding
Focus mode is ending.
@ FocusModeStatusOff
Focus mode is off.
@ FocusModeStatusOn
Focus mode is on.
AICompanionOption
AI Companion option.
@ AICompanionOptionSmartSummary
Meeting Summary.
@ AICompanionOptionSmartQuestion
Meeting Question.
@ AICompanionOptionSmartRecording
Meeting Recording.
@ PanelActionScrollDown
Scroll down current panel tab.
@ PanelActionShow
Show panel.
@ PanelActionHide
Hide panel.
@ PanelActionScrollUp
Scroll up current panel tab.
@ PanelActionSwitchTab
Switch panel tab if existed.
AICompanionRequestType
@ AICompanionRequestNone
@ AICompanionRequestEnable
@ AICompanionRequestSwitch
#define NS_ZRCSDK_END
#define NS_ZRCSDK_BEG
ZRC SDK Types.
ZRCSDKError
SDK error types. Here are more detailed structural descriptions.
Definition ZRCSDKTypes.h:23
Meeting Control helper interface.
virtual ZRCSDKError TurnOffAICompanion(int64_t AICFeatures, bool deleteAssets)=0
Turn off any AI Companion features.
virtual ZRCSDKError ListSignalingAppAccessedUsers(const std::string &appID)=0
List signaling app accessed users.
virtual ZRCSDKError StartFocusMode(bool start)=0
Start focus mode.
virtual ZRCSDKError ShowTopBanner(bool show)=0
Show the top banner.
virtual ZRCSDKError AskToEnableAICompanion(AICompanionOption feature)=0
Ask the account admins to enable AI Companion features (Excluding AICompanionOptionSmartRecording).
virtual ZRCSDKError StartMeetingQuery(bool start)=0
Start meeting query.
virtual ZRCSDKError StartMeetingSummary(bool start)=0
Start meeting summary.
virtual ZRCSDKError RegisterSink(IMeetingControlHelperSink *pSink)=0
Register meeting control helper callback sink.
virtual ZRCSDKError ControlSidePanel(PanelType type, PanelAction action)=0
Control the side panel on ZR.
virtual ZRCSDKError GetAICompanionInfo(AICompanionInfo &info)=0
Get the current AI Companion info.
virtual ZRCSDKError StartCustomLiveStream(bool start, const std::string &channelKey)=0
Start or stop custom live stream. Only available when IMeetingControlHelperSink::OnUpdateLiveStreamSt...
virtual ZRCSDKError TurnOnAICompanion(int64_t AICFeatures)=0
Turn on some AI Companion features (Excluding AICompanionOptionSmartRecording).
virtual ZRCSDKError ConfirmAICompanionStatusWhenJoin(bool agree)=0
Confirm AI Companion status modified by participant while host join meeting.
virtual ZRCSDKError RespondToTurnOffAICompanion(bool agree, bool deleteAssets)=0
Respond to participant's request of turn off AI Companion.
virtual ZRCSDKError EnableHiFiMusicMode(bool enable)=0
Enable High-fidelity music mode.
virtual ZRCSDKError AllowUserRequestAI(bool allow)=0
Allow or disallow attendees to request starting AI Companion.
virtual ZRCSDKError AllowMeetingMynotes(bool isAllow, int32_t userID=0)=0
Allow or disallow Mynotes for the meeting or a specific user.
virtual ZRCSDKError AskHostToTurnOffAllAICompanion()=0
Request host to turn off all AI Companion features.
virtual ZRCSDKError ListSignalingApps()=0
List signaling apps.
virtual ZRCSDKError GetSignalingAppPermissionLink(const std::string &appID)=0
Get signaling app permission link.
virtual ZRCSDKError ChangeMeetingQueryPrivilegeSetting(int32_t privilegeSettingID)=0
Change meeting query privilege setting.
virtual ZRCSDKError HasNewAppSignaling(bool &has)=0
Query if has new app signaling.
virtual ZRCSDKError AskHostToTurnOnAICompanion(int64_t AICFeatures)=0
Request host to turn on some AI Companion features (Excluding AICompanionOptionSmartRecording).
virtual ZRCSDKError GetMeetingMynotesSetting(MeetingMynotesSetting &setting)=0
Get the current meeting Mynotes transcription setting.
virtual ZRCSDKError RespondToTurnOnAICompanion(bool agree)=0
Respond to participant's request of turn on AI Companion.
virtual ZRCSDKError SetMeetingSummaryNotificationEmail(const std::string &email)=0
Set meeting summary notification email.
virtual ZRCSDKError LockMeeting(bool lock)=0
Lock meeting.
virtual ZRCSDKError DeregisterSink(IMeetingControlHelperSink *pSink)=0
Deregister meeting control helper callback sink.
Meeting Control helper event callback.
virtual void OnShowSidePanel(bool isShow, PanelType currentPanel)=0
Control the participant list side panel on ZR.
virtual void OnUpdateMeetingQueryBaseInfo(const MeetingQueryInfo &info)=0
Update meeting query base info notification.
virtual void OnArchivingStatusNotification(bool isInProgress)=0
Archiving status notification.
virtual void OnChangeMeetingQueryPrivilegeSettingID(int32_t settingID)=0
Change meeting query privilege setting notification.
virtual void OnUpdateAICompanionInfo(const AICompanionInfo &info)=0
AI Companion info 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.
virtual void OnShowArchivingStatusFailNotification(bool showArchivingFail)=0
Show archiving fail notification.
virtual void OnUpdateIsDisplayTopBannerNotification(bool isDisplayTopBanner)=0
Display top banner status notification.
virtual void OnHiFiMusicModeNotification(bool isAllow, bool isEnable)=0
HiFi music mode 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 OnUpdateAccessedUsers(const SignalingAppAccessedUserList &list)=0
Update signaling apps accessed users 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 OnZoomPhoneACRStatusNotification(bool isInProgress)=0
Zoom phone ACR status notification.
virtual void OnUpdateMeetingLockStatus(bool meetingLocked)=0
Meeting lock status notification.
virtual void OnUpdateAppPermissionLink(const SignalingAppPermissionLink &link)=0
Update signaling apps permission link notification.
virtual void OnUpdateMeetingMynotesSetting(const MeetingMynotesSetting &setting)=0
Meeting Mynotes transcription setting changed notification.
virtual void OnSetMeetingSummaryNotificationEmailNotification(int32_t result)=0
Set smart summary notification email notification.
virtual void OnSmartSummaryOn(bool summaryOn, bool hasSetEmail)=0
Smart summary status notification.
AI Companion info.
bool isRestricted
TRUE indicates AI Companion is currently restricted.
bool isAllowRequest
TRUE indicates attendees are allowed to request starting AI Companion.
std::string restrictedReason
The reason why AI Companion is restricted, valid when isRestricted is TRUE.
AI Companion request info.
int64_t AICFeatures
AI Companion features, reference to AICompanionOption.
AICompanionRequestType type
std::vector< std::string > senderNames
Participants who send request.
int32_t switchAction
AI Companion action, reference to AICompanionSwitchAction.
int64_t assetsOption
Assets generated by AI Companion, reference to AICompanionOption.
int64_t AICFeatures
AI Companion features, reference to AICompanionOption.
Custom live stream info. Only present in LiveStreamStatus::customLiveStreamInfo when custom live stre...
std::vector< std::string > supportedLiveStreams
Keys of the available live stream channels. Pass one of these values as channelKey when calling IMeet...
std::vector< std::string > selectedLiveStreams
Keys of the currently selected live stream channels.
LiveStreamState state
Live stream state, see LiveStreamState enum.
Live stream status.
bool isLiveStreamUnencrypted
TRUE indicates live streaming is unencrypted.
LiveStreamStatusInfo liveStreamStatusInfo
Live stream status info.
std::optional< CustomLiveStreamInfo > customLiveStreamInfo
Custom live stream status info. Has a value only when custom live stream is supported.
Live stream status info.
bool isInProgress
TRUE indicates live streaming is in progress.
std::string liveChannelName
Live streaming channel name.
Meeting Mynotes transcription setting info.
Meeting query info.
std::vector< PrivilegeSettingItem > privilegeSettingItems
Privilege setting items.
bool canDisplayPrivilegeSetting
TRUE indicates can display privilege settings.
bool canChangePrivilegeSetting
TRUE indicates can change privilege settings.
bool isMeetingQueryOn
TRUE indicates meeting query is on.
bool isMeetingQueryFeatureOn
TRUE indicates meeting query feature is available.
int32_t currentPrivilegeSettingID
Current privilege setting ID.
Privilege setting item.
std::string description
Setting description.
int32_t settingID
Setting ID.
Signaling app accessed user.
std::string avatarUrl
User Avatar url.
std::string userName
User Name.
std::string userGuid
User GUID.
Signaling app accessed user list.
std::vector< SignalingAppAccessedUser > users
Users.
Signaling app info.
std::string appPermissionLink
App permission link.
std::string appID
App ID.
std::vector< SignalingAppAccessedUser > accessedUsers
App accessed users.
std::string appIconUrl
App icon url.
std::string appName
App name.
int32_t accessedUserCount
App accessed users count.
std::vector< std::string > accessedScopes
App accessed scopes.
Signaling app list.
std::string title
Title.
std::string errorMessage
Error message.
std::vector< SignalingAppInfo > signalingApps
Signaling app list.
std::string summary
Summary.