Zoom Rooms Controller SDK Reference 6.5.0
Loading...
Searching...
No Matches
IMeetingReminderHelper.h File Reference

Meeting Reminder interfaces. More...

#include "ZRCSDKTypes.h"

Go to the source code of this file.

Data Structures

struct  PrivacyMessage
 Privacy message Privacy message contains hyperlink to privacy policy. More...
 
struct  DisclaimerPrivacy
 Disclaimer privacy. Disclaimer privacy information, UI structure follows title -> privacyMessage(or privacySection from ZR) -> message -> link -> action. More...
 
struct  MeetingReminderContent
 Meeting reminder content. More...
 
struct  CustomizedMeetingReminderContent
 Customized meeting reminder content. More...
 
struct  CombinedConsent
 Combined consent. More...
 
struct  ConsentInfo
 Consent notification info. More...
 
class  IMeetingReminderHelperSink
 Meeting Reminder helper event callback. More...
 
class  IMeetingReminderHelper
 Meeting Reminder helper interface. More...
 

Enumerations

enum  MeetingReminderType {
  REMINDER_TYPE_NONE = -1 , REMINDER_TYPE_START_OR_JOIN_MEETING , REMINDER_TYPE_JOIN_EXTERNAL_MEETING , REMINDER_TYPE_RECORDING_REMINDER ,
  REMINDER_TYPE_RECORDING_DISCLAIMER , REMINDER_TYPE_ARCHIVING_FAIL , REMINDER_TYPE_JOIN_WEBINAR_AS_PANELIST
}
 Meeting reminder type. Here are more detailed structural descriptions. More...
 
enum  CustomizedMeetingReminderType { CUSTOMIZED_REMINDER_TYPE_NONE = 0 , CUSTOMIZED_REMINDER_TYPE_ONZOOM_JOIN_AS_PANELIST = 1 }
 Customized meeting reminder type, reminder content is set by ZR. Here are more detailed structural descriptions. More...
 
enum  ConsentType {
  CONSENT_TYPE_NONE = -1 , CONSENT_TYPE_LIVE_STREAMING = 0 , CONSENT_TYPE_PROMOTED_TO_PANELIST , CONSENT_TYPE_ARCHIVING ,
  CONSENT_TYPE_NDI , CONSENT_TYPE_FOCUS_MODE_START , CONSENT_TYPE_FOCUS_MODE_ENDING , CONSENT_TYPE_ADMIN_PAY_REMIND ,
  CONSENT_TYPE_PAC , CONSENT_TYPE_ZOOM_PHONE_ACR , CONSENT_TYPE_HDMI_CONNECTED , CONSENT_TYPE_MEETING_SUMMARY ,
  CONSENT_TYPE_MEETING_QUERY , CONSENT_TYPE_CUSTOM_AI_COMPANION
}
 Privacy consent type. Here are more detailed structural descriptions. More...
 
enum  PrivacyAlertType { PRIVACY_ALERT_TYPE_LIVE_TRANSCRIPTION = 0 , PRIVACY_ALERT_TYPE_NEW_LTT_CAPTION = 1 }
 Privacy alert type. Here are more detailed structural descriptions. More...
 
enum  PrivacyAlertAction {
  PRIVACY_ALERT_ACTION_NONE = 0 , PRIVACY_ALERT_ACTION_SHOW = 1 , PRIVACY_ALERT_ACTION_CLOSE = 2 , PRIVACY_ALERT_ACTION_SHOW_DISCLAIMER = 3 ,
  PRIVACY_ALERT_ACTION_CLOSE_DISCLAIMER = 4
}
 Privacy alert action. Here are more detailed structural descriptions. More...
 
enum  MessageEvent {
  MESSAGE_EVENT_UNKNOWN = 0 , MESSAGE_EVENT_OpenVideoFailForHostStop = 1 , MESSAGE_EVENT_OpenVideoFailForForceVBEnabledButUserOptionDisabled = 2 , MESSAGE_EVENT_OpenVideoFailForForceVBEnabledButUserNoGreenScreen = 3 ,
  MESSAGE_EVENT_OpenVideoFailForForceVBEnabledButDeviceNotSupport = 4
}
 Meeting message event Here are more detailed structural descriptions. More...
 

Detailed Description

Meeting Reminder interfaces.

Since
Added in ZRC SDK 6.0.0

Definition in file IMeetingReminderHelper.h.

Enumeration Type Documentation

◆ ConsentType

Privacy consent type. Here are more detailed structural descriptions.

Enumerator
CONSENT_TYPE_NONE 

Consent type none.

CONSENT_TYPE_LIVE_STREAMING 

Consent type of live streaming.

CONSENT_TYPE_PROMOTED_TO_PANELIST 

Consent type of being promoted to panelist.

CONSENT_TYPE_ARCHIVING 

Consent type of archiving.

CONSENT_TYPE_NDI 

Consent type of ndi.

CONSENT_TYPE_FOCUS_MODE_START 

Consent type of focus mode start.

CONSENT_TYPE_FOCUS_MODE_ENDING 

Consent type of focus mode ending.

CONSENT_TYPE_ADMIN_PAY_REMIND 

Consent type of admin pay remind.

CONSENT_TYPE_PAC 

Consent type of personal audio conference.

CONSENT_TYPE_ZOOM_PHONE_ACR 

Consent type of Zoom phone ACR.

CONSENT_TYPE_HDMI_CONNECTED 

Consent type of hdmi connected.

CONSENT_TYPE_MEETING_SUMMARY 

Consent type of meeting summary.

CONSENT_TYPE_MEETING_QUERY 

Consent type of meeting query.

CONSENT_TYPE_CUSTOM_AI_COMPANION 

Consent type of AICompanion.

Definition at line 42 of file IMeetingReminderHelper.h.

43{
58};
@ CONSENT_TYPE_ARCHIVING
Consent type of archiving.
@ CONSENT_TYPE_PROMOTED_TO_PANELIST
Consent type of being promoted to panelist.
@ CONSENT_TYPE_NONE
Consent type none.
@ CONSENT_TYPE_LIVE_STREAMING
Consent type of live streaming.
@ CONSENT_TYPE_MEETING_SUMMARY
Consent type of meeting summary.
@ CONSENT_TYPE_FOCUS_MODE_ENDING
Consent type of focus mode ending.
@ CONSENT_TYPE_MEETING_QUERY
Consent type of meeting query.
@ CONSENT_TYPE_NDI
Consent type of ndi.
@ CONSENT_TYPE_FOCUS_MODE_START
Consent type of focus mode start.
@ CONSENT_TYPE_PAC
Consent type of personal audio conference.
@ CONSENT_TYPE_ZOOM_PHONE_ACR
Consent type of Zoom phone ACR.
@ CONSENT_TYPE_ADMIN_PAY_REMIND
Consent type of admin pay remind.
@ CONSENT_TYPE_HDMI_CONNECTED
Consent type of hdmi connected.
@ CONSENT_TYPE_CUSTOM_AI_COMPANION
Consent type of AICompanion.

◆ CustomizedMeetingReminderType

Customized meeting reminder type, reminder content is set by ZR. Here are more detailed structural descriptions.

Enumerator
CUSTOMIZED_REMINDER_TYPE_NONE 

Invalid.

CUSTOMIZED_REMINDER_TYPE_ONZOOM_JOIN_AS_PANELIST 

Customized reminder type of join ONZOOM as panelist.

Definition at line 32 of file IMeetingReminderHelper.h.

33{
36};
@ CUSTOMIZED_REMINDER_TYPE_NONE
Invalid.
@ CUSTOMIZED_REMINDER_TYPE_ONZOOM_JOIN_AS_PANELIST
Customized reminder type of join ONZOOM as panelist.

◆ MeetingReminderType

Meeting reminder type. Here are more detailed structural descriptions.

Enumerator
REMINDER_TYPE_NONE 

Invalid.

REMINDER_TYPE_START_OR_JOIN_MEETING 

Reminder of start of join meeting.

REMINDER_TYPE_JOIN_EXTERNAL_MEETING 

Reminder of join external meeting.

REMINDER_TYPE_RECORDING_REMINDER 

Reminder of recording reminder.

REMINDER_TYPE_RECORDING_DISCLAIMER 

Reminder of recording disclaimer.

REMINDER_TYPE_ARCHIVING_FAIL 

Reminder of archiving fail.

REMINDER_TYPE_JOIN_WEBINAR_AS_PANELIST 

Reminder of join webinar as panelist.

Definition at line 17 of file IMeetingReminderHelper.h.

18{
26};
@ REMINDER_TYPE_ARCHIVING_FAIL
Reminder of archiving fail.
@ REMINDER_TYPE_START_OR_JOIN_MEETING
Reminder of start of join meeting.
@ REMINDER_TYPE_RECORDING_REMINDER
Reminder of recording reminder.
@ REMINDER_TYPE_JOIN_WEBINAR_AS_PANELIST
Reminder of join webinar as panelist.
@ REMINDER_TYPE_NONE
Invalid.
@ REMINDER_TYPE_JOIN_EXTERNAL_MEETING
Reminder of join external meeting.
@ REMINDER_TYPE_RECORDING_DISCLAIMER
Reminder of recording disclaimer.

◆ MessageEvent

Meeting message event Here are more detailed structural descriptions.

Enumerator
MESSAGE_EVENT_UNKNOWN 

Unknown.

MESSAGE_EVENT_OpenVideoFailForHostStop 

Open video failed because host stopped your video.

MESSAGE_EVENT_OpenVideoFailForForceVBEnabledButUserOptionDisabled 

Open video failed because virtual background is force enabled but user option is disabled.

MESSAGE_EVENT_OpenVideoFailForForceVBEnabledButUserNoGreenScreen 

Open video failed because virtual background is force enabled but user has no green screen.

MESSAGE_EVENT_OpenVideoFailForForceVBEnabledButDeviceNotSupport 

Open video failed because virtual background is force enabled but device not support.

Definition at line 87 of file IMeetingReminderHelper.h.

88{
94};
@ MESSAGE_EVENT_OpenVideoFailForForceVBEnabledButUserNoGreenScreen
Open video failed because virtual background is force enabled but user has no green screen.
@ MESSAGE_EVENT_UNKNOWN
Unknown.
@ MESSAGE_EVENT_OpenVideoFailForForceVBEnabledButDeviceNotSupport
Open video failed because virtual background is force enabled but device not support.
@ MESSAGE_EVENT_OpenVideoFailForForceVBEnabledButUserOptionDisabled
Open video failed because virtual background is force enabled but user option is disabled.
@ MESSAGE_EVENT_OpenVideoFailForHostStop
Open video failed because host stopped your video.

◆ PrivacyAlertAction

Privacy alert action. Here are more detailed structural descriptions.

Enumerator
PRIVACY_ALERT_ACTION_NONE 

None.

PRIVACY_ALERT_ACTION_SHOW 

Show privacy alert.

PRIVACY_ALERT_ACTION_CLOSE 

Close privacy alert.

PRIVACY_ALERT_ACTION_SHOW_DISCLAIMER 

Show privacy alert disclaimer.

PRIVACY_ALERT_ACTION_CLOSE_DISCLAIMER 

Close privacy alert disclaimer.

Definition at line 74 of file IMeetingReminderHelper.h.

75{
81};
@ PRIVACY_ALERT_ACTION_SHOW
Show privacy alert.
@ PRIVACY_ALERT_ACTION_NONE
None.
@ PRIVACY_ALERT_ACTION_CLOSE
Close privacy alert.
@ PRIVACY_ALERT_ACTION_CLOSE_DISCLAIMER
Close privacy alert disclaimer.
@ PRIVACY_ALERT_ACTION_SHOW_DISCLAIMER
Show privacy alert disclaimer.

◆ PrivacyAlertType

Privacy alert type. Here are more detailed structural descriptions.

Enumerator
PRIVACY_ALERT_TYPE_LIVE_TRANSCRIPTION 

Privacy alert type live transcription.

PRIVACY_ALERT_TYPE_NEW_LTT_CAPTION 

Privacy alert type new LTT caption.

Definition at line 64 of file IMeetingReminderHelper.h.

65{
68};
@ PRIVACY_ALERT_TYPE_NEW_LTT_CAPTION
Privacy alert type new LTT caption.
@ PRIVACY_ALERT_TYPE_LIVE_TRANSCRIPTION
Privacy alert type live transcription.