ZOOM Windows SDK  5.2.41727.0928
premeeting_service_interface.h
Go to the documentation of this file.
1 
6 #ifndef _PREMEETING_SERVICE_INTERFACE_H_
7 #define _PREMEETING_SERVICE_INTERFACE_H_
8 #include "zoom_sdk_def.h"
9 
10 BEGIN_ZOOM_SDK_NAMESPACE
11 
17 {
20 };
21 
22 enum InterpreteLanguageInfo{
23  LANGUAGEINFO_NONE = -1,
24  LANGUAGEINFO_US, //English
25  LANGUAGEINFO_CN, //Chinese
26  LANGUAGEINFO_JP, //Japanese
27  LANGUAGEINFO_DE, //German
28  LANGUAGEINFO_FR, //French
29  LANGUAGEINFO_RU, //Russian
30  LANGUAGEINFO_PT, //Portuguese
31  LANGUAGEINFO_ES, //Spanish
32  LANGUAGEINFO_KR, //Korean
33  LANGUAGEINFO_NUM
34 };
36 {
37 public:
38  virtual const wchar_t* GetEmail() = 0;
39 
40  virtual InterpreteLanguageInfo GetFirstLanguageInfo() = 0;
41 
42  virtual InterpreteLanguageInfo GetSecendLanguageInfo() = 0;
43 
44  virtual ~IInterpreterInfo() {};
45 };
47 {
48 public:
49  virtual const wchar_t* GetEmail() = 0;
50 
51  virtual ~IAlternativeHostInfo() {};
52 };
53 
56 {
57 public:
60  virtual time_t GetCurrentStartTime() = 0;
61 
64  virtual int GetDurationInMinutes() = 0;
65 
68  virtual bool IsRecurringMeetingSelected() = 0;
70 };
73 {
74 public:
78  virtual SDKError SelectStartTime(time_t time) = 0;
79 
84  virtual SDKError SetDurationInMinutes(int duration) = 0;
85 
90  virtual SDKError SelectRecurringMeeting(bool select_) = 0;
91  virtual ~ISelectMeetingItemDateHelper(){}
92 };
93 
96 {
97 public:
101  virtual void onSupportSelectDateStatusNotification(bool can_use, ISelectMeetingItemDateHelper* date_select_helper) = 0;
102 };
103 
109 {
115 };
118 {
119 public:
124 
128 
131  virtual bool IsIncludeTollFree() = 0;
132 };
133 
136 {
137 public:
143  virtual SDKError SelectDefaultDialInCountry(const wchar_t* countryId) =0;
144 
149  virtual SDKError RemoveDefaultDialInCountry(const wchar_t* countryId) =0;
150 
155  virtual SDKError EnableIncludeTollFree(bool bEnable) = 0;
156 };
159 {
160 public:
163  virtual void onSupportTelAudioNotification(bool can_use) = 0;
164 };
165 
168 {
169 public:
175  virtual SDKError GetSelectedAudioType(SCHEDULEAUDIOTYPE& type_) = 0;
176 
182 };
183 
186 {
187 public:
193  virtual SDKError IsSupportAudioType(SCHEDULEAUDIOTYPE audio_type) = 0;
194 
199  virtual SDKError SelectAudioType(SCHEDULEAUDIOTYPE audio_type) = 0;
200 
206 };
207 
210 {
211 public:
215  virtual bool IsHostVideoOnOrOff() = 0;
216 
219  virtual bool IsAttendeeVideoOnOrOff() = 0;
220 };
221 
224 {
225 public:
231  virtual SDKError SelectHostVideoOnOrOff(bool bOn) = 0;
232 
237  virtual SDKError SelectAttendeeVideoOnOrOff(bool bOn) = 0;
238 };
244 {
248 };
249 
252 {
253 public:
258  virtual void onMeetingPasswordEnabledStatusNotification(bool enable, const wchar_t* default_psw) = 0;
259 
262  virtual void onJoinBeforeHostEnabledStatusNotification(bool enable) = 0;
265  virtual void onMuteUponEntryEnabledStatusNotification(bool enable) = 0;
266 
269  virtual void onScheduleWithPmiEnabledStatusNotification(bool enable) = 0;
270 
274  virtual void onOnlySignedInUserCanJoinEnabledStatusNotification(bool enable, const wchar_t* default_specified_domain_can_join) = 0;
275 
278  virtual void onHostInChinaEnabledStatusNotification(bool enable) = 0;
279 
283  virtual void onAutoRecordEnabledStatusNotification(bool enable, SCHEDULERECTYPE& default_type) = 0;
284 
287  virtual void onSupportScheduleForNotification(bool can_use) = 0;
288 
289  virtual void onWaitingRoomEnabledStatusNotification(bool enable) = 0;
290 
291  virtual void onMeetingToPublicEnabledStatusNotification(bool enable) = 0;
292 
293  virtual void onLanguageInterpretationEnabledStatusNotification(bool enable) = 0;
294 };
295 
298 {
299 public:
300  virtual ~IScheduleForUser() {};
304  virtual const wchar_t* GetEmail() = 0;
305 
308  virtual const wchar_t* GetDisplayName() = 0;
309 
312  virtual UINT64 GetPMINumber() = 0;
313 };
314 
317 {
318 public:
323 };
324 
327 {
328 public:
333  virtual IList<IScheduleForUser* >* GetAvailableScheduleForList(bool& can_select_schedule_for) = 0;
334 
339  virtual SDKError SelectScheduleForUser(IScheduleForUser* alternateHost) =0;
340 };
341 
344 {
345 public:
349  virtual const wchar_t* GetMeetingTopic() = 0;
350 
354  virtual bool IsMeetingPasswordEnabled(bool& can_change) = 0;
355 
358  virtual const wchar_t* GetMeetingPassword() = 0;
359 
363  virtual bool IsJoinBeforeHostEnabled(bool& can_change) = 0;
364 
368  virtual bool IsMuteUponEntryEnabled(bool& can_change) = 0;
369 
373  virtual bool IsScheduleWithPmiEnabled(bool& can_change) = 0;
374 
378  virtual bool IsOnlySignedInUserCanJoinEnabled(bool& can_change) = 0;
379 
383  virtual const wchar_t* GetSpecifiedDomainCanJoin(bool& can_change) = 0;
384 
388  virtual bool IsHostInChinaEnabled(bool& can_change) = 0;
389 
394  virtual bool IsAutoRecordEnabled(bool& can_change, int& support_rec_type) = 0;
395 
399 
400  virtual bool IsWaitingRoomEnabled(bool& can_change) = 0;
401 
402  virtual bool IsMeetingToPublicEnabled(bool& can_change) = 0;
403 
404  virtual const wchar_t* GetPublicEventListUrl() = 0;
405 
406  virtual bool IsLanguageInterpretationEnabled(bool& can_change) = 0;
407 
408  virtual IList<IInterpreterInfo* >* GetInterpreterInfoList() = 0;
409 
410  virtual IList<IAlternativeHostInfo* >* GetAlternativeHostInfoList() = 0;
411 
412  virtual bool isDisabledPMI() = 0;
413 
417 };
418 
421 {
422 public:
424  virtual SDKError SetMeetingTopic(const wchar_t* topic) = 0;
430  virtual SDKError EnableMeetingPassword(bool bEnable) = 0;
431 
434  virtual SDKError SetMeetingPassword(const wchar_t* meetingPsw) = 0;
435 
441  virtual SDKError EnableJoinBeforeHost(bool bEnable) = 0;
442 
448  virtual SDKError EnableMuteUponEntry(bool bEnable) = 0;
449 
454  virtual SDKError EnableScheduleWithPmi(bool bEnable) = 0;
455 
461  virtual SDKError EnableOnlySignedInUserCanJoin(bool bEnable) = 0;
462 
468  virtual SDKError SetSpecifiedDomainCanJoin(const wchar_t* specified_domain_can_join) = 0;
469 
474  virtual SDKError EnableHostInChina(bool bEnable) = 0;
475 
481  virtual SDKError EnableAutoRecord(bool bEnable) = 0;
482 
487  virtual SDKError SelectAutoRecordType(SCHEDULERECTYPE type_) = 0;
488 
489  virtual SDKError EnableWaitingRoom(bool bEnable) = 0;
490 
491  virtual SDKError EnableMeetingToPublic(bool bEnable) = 0;
492 
493  virtual SDKError EnableLanguageInterpretation(bool bEnable) = 0;
494 
495  virtual SDKError SetInterpreterInfoList(IList<IInterpreterInfo* >* lst_interpreters) = 0;
496 
497  virtual SDKError SetAlternativeHostList(IList<IAlternativeHostInfo* >* lst_althosts) = 0;
498 
502 };
503 
510 {
511 public:
514  virtual UINT64 GetUniqueMeetingID() = 0;
515 
518  virtual UINT64 GetMeetingID() = 0;
519 
522  virtual bool IsPMI() = 0;
523 
526  virtual bool IsWebinar() = 0;
527 
530  virtual const wchar_t* GetInviteEmailContent() = 0;
531 
534  virtual const wchar_t* GetInviteEmailSubject() = 0;
535 
538  virtual const wchar_t* GetJoinMeetingUrl() = 0;
539 };
540 
543 {
544 public:
545 };
546 
552 {
553 public:
554 };
555 
561 {
562 public:
564  virtual void onScheduleMeetingItemDestroyed() = 0;
565 };
566 
573 {
574 public:
578 };
579 
582 {
583 public:
587  virtual void onListMeeting(PremeetingAPIResult result, IList<UINT64 >* lstMeetingList) = 0;
588 
592  virtual void onScheduleOrEditMeeting(PremeetingAPIResult result, UINT64 meetingUniqueID) = 0;
593 
596  virtual void onDeleteMeeting(PremeetingAPIResult result) = 0;
597 };
598 
601 {
602 public:
606 
609  virtual void DestoryScheduleMeetingItem(IScheduleMeetingItem* pMeeting) = 0;
610 
614  virtual IScheduleMeetingItem* CreateEditMeetingItem(UINT64 meetingUniqueID) = 0;
615 
618  virtual void DestoryEditMeetingItem(IScheduleMeetingItem* pMeeting) = 0;
619 
625  virtual SDKError SetEvent(IPreMeetingServiceEvent* pEvent) = 0;
626 
632  virtual SDKError ScheduleMeeting(IScheduleMeetingItem* pItem) = 0;
633 
639  virtual SDKError ScheduleMeeting(WndPosition& wndParam) = 0;
640 
647  virtual SDKError EditMeeting(IScheduleMeetingItem* pItem) = 0;
648 
656  virtual SDKError EditMeeting(WndPosition& wndParam, UINT64 meetingUniqueID) = 0;
657 
664  virtual SDKError DeleteMeeting(UINT64 meetingUniqueID) = 0;
665 
670  virtual SDKError ListMeeting() = 0;
671 
675  virtual IMeetingItemInfo* GetMeeingItem(UINT64 meetingUniqueID) = 0;
676 };
677 END_ZOOM_SDK_NAMESPACE
678 #endif
The interface to set the meeting video information.
Definition: premeeting_service_interface.h:223
Schedule meeting item interface. The APIs are used to schedule meeting and edit scheduled meeting...
Definition: premeeting_service_interface.h:570
The interface to set the meeting audio information.
Definition: premeeting_service_interface.h:185
Support VoiP.
Definition: premeeting_service_interface.h:112
virtual SDKError SelectAudioType(SCHEDULEAUDIOTYPE audio_type)=0
Set the audio type of the specified meeting.
The interface to configure the meeting basic information.
Definition: premeeting_service_interface.h:420
virtual void onListMeeting(PremeetingAPIResult result, IList< UINT64 > *lstMeetingList)=0
List meeting callback event.
virtual bool IsRecurringMeetingSelected()=0
Determine if the recurring meeting mode is selected.
virtual IScheduleMeetingItem * CreateEditMeetingItem(UINT64 meetingUniqueID)=0
virtual void onDeleteMeeting(PremeetingAPIResult result)=0
Delete meeting callback.
Meeting item information interface.
Definition: premeeting_service_interface.h:505
virtual SDKError SetDurationInMinutes(int duration)=0
Set the duration of the specified meeting in minutes.
virtual time_t GetCurrentStartTime()=0
Get the start time of the specified meeting.
ZOOM windows SDK Common Definition File.
virtual bool IsAutoRecordEnabled(bool &can_change, int &support_rec_type)=0
Determine that if auto video recording is enabled in the meeting.
virtual const wchar_t * GetMeetingPassword()=0
Get the password of the specified meeting.
For initialization.
Definition: premeeting_service_interface.h:110
virtual const wchar_t * GetEmail()=0
Get the user email.
virtual SDKError EnableScheduleWithPmi(bool bEnable)=0
Set if it is able to schedule meeting by PMI(Personal meeting ID).
virtual void onJoinBeforeHostEnabledStatusNotification(bool enable)=0
The callback event that the status JBH(Join meeting Before Host) changes.
virtual void onAutoRecordEnabledStatusNotification(bool enable, SCHEDULERECTYPE &default_type)=0
The callback event that the status AUTO RECORDING IN THE MEETING changes.
The callback interface to configure the meeting basic information.
Definition: premeeting_service_interface.h:251
virtual UINT64 GetPMINumber()=0
Get the user personal meeting ID.
Definition: zoom_sdk_def.h:259
virtual SDKError SelectAttendeeVideoOnOrOff(bool bOn)=0
Set to enable or disable the video of the participants.
virtual bool IsAttendeeVideoOnOrOff()=0
Determine if the video of the participant is enabled when joining meeting.
virtual IQueryMeetingItemScheduleForHelper * GetQueryScheduleForHelper()=0
Get the meeting information interface for the specified meeting.
virtual SDKError SetSpecifiedDomainCanJoin(const wchar_t *specified_domain_can_join)=0
Set a specified domain.
virtual void onScheduleOrEditMeeting(PremeetingAPIResult result, UINT64 meetingUniqueID)=0
Schedule or edit meeting callback event.
virtual bool IsMuteUponEntryEnabled(bool &can_change)=0
Determine if the meeting mutes all the participants.
virtual IMeetingItemInfo * GetMeeingItem(UINT64 meetingUniqueID)=0
Get a pointer to IMyMeeingItem.
virtual UINT64 GetMeetingID()=0
Get the exclusive meeting number.
virtual const wchar_t * GetJoinMeetingUrl()=0
Get the URL to invite the users to join the meeting.
The interface of the user who can be specified as the host.
Definition: premeeting_service_interface.h:297
Local recording.
Definition: premeeting_service_interface.h:247
The interface to query the meeting information.
Definition: premeeting_service_interface.h:542
virtual IScheduleForUser * GetCurrentSelectedScheduleForUser()=0
Get the information of the user who is specified as the meeting host.
Support telephony.
Definition: premeeting_service_interface.h:111
virtual SDKError EnableHostInChina(bool bEnable)=0
Set if it is able to host a meeting in China.
virtual int GetDurationInMinutes()=0
Get the duration of the specified meeting.
Calls API successfully.
Definition: premeeting_service_interface.h:19
The interface to set the meeting telephony numbers information.
Definition: premeeting_service_interface.h:135
The interface to query the meeting telephony number information.
Definition: premeeting_service_interface.h:117
virtual SDKError EditMeeting(IScheduleMeetingItem *pItem)=0
Edit Meeting.
SDKError
SDK error types. Here are more detailed structural descriptions.
Definition: zoom_sdk_def.h:29
virtual IScheduleMeetingItem * CreateScheduleMeetingItem()=0
Create an item to schedule meeting.
virtual const wchar_t * GetMeetingTopic()=0
Get the topic of the specified meeting.
virtual bool IsOnlySignedInUserCanJoinEnabled(bool &can_change)=0
Determine if only the specified user is allowed to join the meeting.
Cloud recording.
Definition: premeeting_service_interface.h:246
Definition: premeeting_service_interface.h:46
The meeting information interface to specify others as the host.
Definition: premeeting_service_interface.h:326
virtual bool IsPMI()=0
Determine if the specified meeting is personal.
SCHEDULEAUDIOTYPE
Specify the meeting audio type. Here are more detailed structural descriptions.
Definition: premeeting_service_interface.h:108
virtual bool IsHostVideoOnOrOff()=0
Determine if the host enables the video when joins the meeting.
virtual void DestoryScheduleMeetingItem(IScheduleMeetingItem *pMeeting)=0
Destroy the item of scheduling meeting created via CreateScheduleMeetingItem().
virtual SDKError EnableOnlySignedInUserCanJoin(bool bEnable)=0
Set if only the specified user can join the meeting.
Support both telephony and VoiP.
Definition: premeeting_service_interface.h:113
virtual SDKError SelectStartTime(time_t time)=0
Set the start time of the specified meeting. It is recommended to use the time zone of the operating ...
virtual SDKError EnableJoinBeforeHost(bool bEnable)=0
Set if it is able to join the meeting before the host.
Definition: premeeting_service_interface.h:547
virtual void onSupportScheduleForNotification(bool can_use)=0
The callback event that the status SPECIFY OTHERS AS THE HOST changes.
virtual SDKError DeleteMeeting(UINT64 meetingUniqueID)=0
Delete the specified scheduled meeting.
virtual SDKError IsSupportAudioType(SCHEDULEAUDIOTYPE audio_type)=0
Determine if the specified audio type is supported by the meeting.
virtual ISelectMeetingItemTelAudioHelper * GetScheduleTelAudioHelper()=0
Get the meeting telephone number information.
Definition: premeeting_service_interface.h:35
For initialization.
Definition: premeeting_service_interface.h:245
SCHEDULERECTYPE
Specify the meeting recording type. Here are more detailed structural descriptions.
Definition: premeeting_service_interface.h:243
virtual bool IsIncludeTollFree()=0
Determine if the numbers of visible dialable country contains toll-free numbers.
virtual void onHostInChinaEnabledStatusNotification(bool enable)=0
The callback event that the status HOSTING A MEETING IN CHINA changes.
virtual SDKError EnableMuteUponEntry(bool bEnable)=0
Set if it is able to mute attendees automatically when join the meeting.
virtual SDKError SelectHostVideoOnOrOff(bool bOn)=0
Enable or disable the host video function.
virtual void onSupportTelAudioNotification(bool can_use)=0
The callback event that the selected meeting audio function changes.
virtual void onOnlySignedInUserCanJoinEnabledStatusNotification(bool enable, const wchar_t *default_specified_domain_can_join)=0
The callback event that the status ONLY THE SPECIFIED USERS ARE ALLOWED TO JOIN THE MEETING changes...
virtual SDKError SelectScheduleForUser(IScheduleForUser *alternateHost)=0
Specify a new host for the meeting.
virtual SDKError SelectAutoRecordType(SCHEDULERECTYPE type_)=0
Set the meeting recording type.
Pre-meeting service interface.
Definition: premeeting_service_interface.h:600
virtual void onMuteUponEntryEnabledStatusNotification(bool enable)=0
The callback event that the status MUTE ALL THE PARTICIPANTS changes.
virtual const wchar_t * GetInviteEmailContent()=0
Get the content of the email to invite the users to join the meeting.
virtual bool IsMeetingPasswordEnabled(bool &can_change)=0
Determine if the password is required when join the meeting.
virtual SDKError ScheduleMeeting(IScheduleMeetingItem *pItem)=0
Schedule Meeting.
PremeetingAPIResult
The result of premeeting API request. Here are more detailed structural descriptions.
Definition: premeeting_service_interface.h:16
The interface to set the meeting basic information.
Definition: premeeting_service_interface.h:72
virtual void onScheduleMeetingItemDestroyed()=0
Callback event of destroying schedule meeting item.
Support the third audio device.
Definition: premeeting_service_interface.h:114
virtual const wchar_t * GetDisplayName()=0
Get the screen name of the user.
The callback interface that the selected meeting status changes.
Definition: premeeting_service_interface.h:95
virtual bool IsScheduleWithPmiEnabled(bool &can_change)=0
Determine if the personal meeting ID is used in the meeting.
virtual IList< const wchar_t *> * GetAvailableDialinCountryCode()=0
Get the available telephony number list for countries that can be called in.
virtual SDKError SetEvent(IPreMeetingServiceEvent *pEvent)=0
Set pre-meeting service event.
virtual ISelectMeetingItemScheduleForHelper * GetScheduleForHelper()=0
Get the specified meeting information interface.
virtual SCHEDULERECTYPE GetSelectedAutoRecordType()=0
Get the recording type supported by the meeting.
The callback interface that the selected meeting audio function changes.
Definition: premeeting_service_interface.h:158
The interface to query the meeting audio information.
Definition: premeeting_service_interface.h:167
virtual const wchar_t * GetSpecifiedDomainCanJoin(bool &can_change)=0
Get the domain to join the meeting.
virtual IList< const wchar_t *> * GetSelectedDialinCountryCode()=0
Get the telephony number list of the selected country that can be called in.
virtual bool IsJoinBeforeHostEnabled(bool &can_change)=0
Determine if it is enabled to join the meeting before the host.
virtual SDKError SelectDefaultDialInCountry(const wchar_t *countryId)=0
Select the telephone number via specified country ID as the default call-in number.
virtual void onSupportSelectDateStatusNotification(bool can_use, ISelectMeetingItemDateHelper *date_select_helper)=0
The callback event that the selected meeting status changes.
virtual SDKError SelectRecurringMeeting(bool select_)=0
Set the meeting type to recurring or scheduled.
The interface to query meeting video information.
Definition: premeeting_service_interface.h:209
virtual IQueryMeetingItemTelAudioInfoHelper * GetQueryTelAudioInfoHelper()=0
Get the meeting telephone number information.
The position of the window. The coordinate of position is that of monitor when the parent window is n...
Definition: zoom_sdk_def.h:85
The interface to query the basic information of meeting.
Definition: premeeting_service_interface.h:55
virtual UINT64 GetUniqueMeetingID()=0
Get the exclusive meeting number.
virtual SDKError SetEvent(IScheduleMeetingItemStatusCallback *callback)=0
Set the scheduled meeting service callback handler.
virtual SDKError EnableMeetingPassword(bool bEnable)=0
Set whether the password is required when joining the meeting.
Pre-meeting service event interface.
Definition: premeeting_service_interface.h:581
virtual bool IsWebinar()=0
Determine if the specified meeting is a webinar.
The interface to query the meeting basic configuration information.
Definition: premeeting_service_interface.h:343
virtual void onMeetingPasswordEnabledStatusNotification(bool enable, const wchar_t *default_psw)=0
The callback event to request to fill in the password when the participants join the meeting...
virtual SDKError GetSelectedAudioType(SCHEDULEAUDIOTYPE &type_)=0
Get the meeting audio type.
virtual SDKError SetMeetingPassword(const wchar_t *meetingPsw)=0
Set the meeting password.
virtual void DestoryEditMeetingItem(IScheduleMeetingItem *pMeeting)=0
Destroy the item of editing meeting created via CreateEditMeetingItem().
virtual SDKError EnableIncludeTollFree(bool bEnable)=0
Set if the toll-free numbers are enabled in the call-in number list.
virtual const wchar_t * GetInviteEmailSubject()=0
Get the subject of the email to invite the users to join the meeting.
virtual void onScheduleWithPmiEnabledStatusNotification(bool enable)=0
The callback event that the status USE THE PERSONAL MEETING ID changes.
virtual bool IsHostInChinaEnabled(bool &can_change)=0
Determine if hosting the meeting in China is enabled.
virtual SDKError RemoveDefaultDialInCountry(const wchar_t *countryId)=0
Remove the telephone number in the default call-in number via specified country ID.
virtual SDKError EnableAutoRecord(bool bEnable)=0
Set if it is able to record the meeting automatically.
virtual SDKError ListMeeting()=0
Get the list of current meetings.
The interface to query the information of the user who is specified as the meeting host...
Definition: premeeting_service_interface.h:316
The interface to configure the meeting information.
Definition: premeeting_service_interface.h:557
API returns unknown error.
Definition: premeeting_service_interface.h:18
virtual IList< IScheduleForUser *> * GetAvailableScheduleForList(bool &can_select_schedule_for)=0
Get the user list who can be specified as the host.