Meeting SDK for Windows API Reference
Loading...
Searching...
No Matches
meeting_service_interface.h
Go to the documentation of this file.
1
5#ifndef _MEETING_SERVICE_INTERFACE_H_
6#define _MEETING_SERVICE_INTERFACE_H_
7#include "zoom_sdk_def.h"
8#if defined(WIN32)
10#endif
51
57{
137
138};
139
163
179
191
203
215
231
277
320
342
343
363
401
433
434
458
480#if defined(WIN32)
494
507#endif
518
519
533
539{
540public:
545 virtual UINT64 GetMeetingNumber() = 0;
546
551 virtual const zchar_t* GetMeetingID() = 0;
552
557 virtual const zchar_t* GetMeetingTopic() = 0;
558
563 virtual const zchar_t* GetMeetingPassword() = 0;
564
570
575 virtual const zchar_t* GetInviteEmailTemplate() = 0;
576
581 virtual const zchar_t* GetInviteEmailTitle() = 0;
582
587 virtual const zchar_t* GetJoinMeetingUrl() = 0;
588
593 virtual const zchar_t* GetMeetingHostTag() = 0;
594
600
606
607 virtual ~IMeetingInfo(){};
608};
609
615{
631 {
633 is_view_only = true;
636 meeting_number = 0;
637 meeting_topic = nullptr;
638 meeting_host = nullptr;
639 }
640
642 {
643 if (meeting_host)
644 {
645 delete[] meeting_host;
646 meeting_host = nullptr;
647 }
648 if (meeting_topic)
649 {
650 delete[] meeting_topic;
651 meeting_topic = nullptr;
652 }
653 }
655
669
675{
676public:
685 virtual void onMeetingStatusChanged(MeetingStatus status, int iResult = 0) = 0;
686
692
698 virtual void onMeetingParameterNotification(const MeetingParameter* meeting_param) = 0;
699
704
709 virtual void onAICompanionActiveChangeNotice(bool bActive) = 0;
710
715 virtual void onMeetingTopicChanged(const zchar_t* sTopic) = 0;
716
722 virtual void onMeetingFullToWatchLiveStream(const zchar_t* sLiveStreamUrl) = 0;
723};
724
746#if defined(WIN32)
748class IMeetingBreakoutRoomsController;
764#endif
788{
789public:
796
802 virtual SDKError HandleZoomWebUriProtocolAction(const zchar_t* protocol_action) = 0;
803
809 virtual SDKError Join(JoinParam& joinParam) = 0;
810
816 virtual SDKError Start(StartParam& startParam) = 0;
817
823 virtual SDKError Leave(LeaveMeetingCmd leaveCmd) = 0;
824
830
835 virtual SDKError LockMeeting() = 0;
836
841 virtual SDKError UnlockMeeting() = 0;
842
847 virtual bool IsMeetingLocked() = 0;
848
853 virtual bool CanSetMeetingTopic() = 0;
854
860 virtual SDKError SetMeetingTopic(const zchar_t* sTopic) = 0;
861
867
873
879
886 virtual ConnectionQuality GetSharingConnQuality(bool bSending = true) = 0;
887
894 virtual ConnectionQuality GetVideoConnQuality(bool bSending = true) = 0;
895
902 virtual ConnectionQuality GetAudioConnQuality(bool bSending = true) = 0;
903
909
915
921
927
933
939
945
951
957
964
970
976
982
988
989#if defined(WIN32)
995
1001
1007
1013
1019
1025
1031
1037
1043
1049
1055
1061
1067
1073
1079
1085
1091
1097
1103
1109#endif
1114
1120
1126};
1128#endif
Meeting annotation tool interface.
Closed caption controller interface.
Meeting immersive controller interface. For more details on this feature, see https://support....
Emoji Reaction controller interface.
IListFactory interface.
virtual void DestroyAssetsInfoList(IList< GrantCoOwnerAssetsInfo > *list)=0
Destroys a previously created list of GrantCoOwnerAssetsInfo objects.
virtual IList< GrantCoOwnerAssetsInfo > * CreateAssetsInfoList()=0
Creates a new list of GrantCoOwnerAssetsInfo objects.
Meeting AAN controller interface.
Meeting AI Companion controller interface.
Meeting audio controller interface.
Meeting breakout rooms controller interface.
Meeting chat controller interface.
Meeting configuration interface.
Meeting Docs helper interface.
Meeting H323 Helper Interface.
Meeting Indicator controller interface.
Meeting information Interface.
virtual const zchar_t * GetJoinMeetingUrl()=0
Get the URL of invitation to join the meeting.
virtual MeetingConnType GetMeetingConnType()=0
Get the connection type of the current meeting.
virtual MeetingType GetMeetingType()=0
Get the meeting type.
virtual const zchar_t * GetMeetingID()=0
Get the current meeting ID.
virtual const zchar_t * GetMeetingHostTag()=0
Get the host tag of the current meeting.
virtual const zchar_t * GetMeetingTopic()=0
Get the meeting topic.
virtual const zchar_t * GetInviteEmailTitle()=0
Get the meeting title in the email invitation template.
virtual UINT64 GetMeetingNumber()=0
Get the current meeting number.
virtual const zchar_t * GetMeetingPassword()=0
Get the meeting password.
virtual int GetSupportedMeetingAudioType()=0
Get the audio type supported by the current meeting. see InMeetingSupportAudioType enum.
virtual const zchar_t * GetInviteEmailTemplate()=0
Get the email invitation template for the current meeting.
Meeting interpretation controller interface.
Live stream meeting controller interface.
Meeting waiting room controller interface.
Meeting phone helper interface.
Meeting q&a controller interface class.
Meeting raw archiving controller interface.
Meeting recording controller interface.
Meeting reminder dialog interface.
Meeting remote control interface.
Meeting service callback event.
virtual void onMeetingStatisticsWarningNotification(StatisticsWarningType type)=0
Meeting statistics warning notification callback.
virtual void onMeetingStatusChanged(MeetingStatus status, int iResult=0)=0
Meeting status changed callback.
virtual void onSuspendParticipantsActivities()=0
Callback event when a meeting is suspended.
virtual void onMeetingFullToWatchLiveStream(const zchar_t *sLiveStreamUrl)=0
Calback event that the meeting users have reached the meeting capacity. The new join user can not joi...
virtual void onAICompanionActiveChangeNotice(bool bActive)=0
Callback event for the AI Companion active status changed.
virtual void onMeetingParameterNotification(const MeetingParameter *meeting_param)=0
Meeting parameter notification callback.
virtual void onMeetingTopicChanged(const zchar_t *sTopic)=0
Callback event for the meeting topic changed.
Meeting Service Interface.
virtual IMeetingRecordingController * GetMeetingRecordingController()=0
Get the recording controller interface.
virtual IMeetingWebinarController * GetMeetingWebinarController()=0
Get the webinar controller interface.
virtual SDKError UnlockMeeting()=0
Unlock the current meeting.
virtual IMeetingAANController * GetMeetingAANController()=0
Get the AAN controller.
virtual IMeetingIndicatorController * GetMeetingIndicatorController()=0
Get the Indicator controller.
virtual IMeetingPollingController * GetMeetingPollingController()=0
Get the Polling controller.
virtual IMeetingConfiguration * GetMeetingConfiguration()=0
Get the meeting configuration interface.
virtual IMeetingSmartSummaryController * GetMeetingSmartSummaryController()=0
Get the smart summary controller.
virtual const zchar_t * GetInMeetingDataCenterInfo()=0
Get data center information.
virtual IMeetingParticipantsController * GetMeetingParticipantsController()=0
Get the participants controller interface.
virtual IMeetingChatController * GetMeetingChatController()=0
Get the chat controller interface.
virtual SDKError Leave(LeaveMeetingCmd leaveCmd)=0
Leave meeting.
virtual IMeetingWaitingRoomController * GetMeetingWaitingRoomController()=0
Get the waiting room controller interface.
virtual IMeetingQAController * GetMeetingQAController()=0
Get the Q&A controller.
virtual IMeetingBOController * GetMeetingBOController()=0
Get the Breakout Room controller.
virtual IMeetingEncryptionController * GetInMeetingEncryptionController()=0
Get the encryption controller.
virtual SDKError Join(JoinParam &joinParam)=0
Join the meeting.
virtual IListFactory * GetListFactory()=0
Returns the list factory instance.
virtual IMeetingPhoneHelper * GetMeetingPhoneHelper()=0
Get the meeting phone helper interface.
virtual SDKError SetEvent(IMeetingServiceEvent *pEvent)=0
Set meeting service callback event handler.
virtual ConnectionQuality GetAudioConnQuality(bool bSending=true)=0
Get the Internet connection quality of audio.
virtual MeetingStatus GetMeetingStatus()=0
Get meeting status.
virtual SDKError HandleZoomWebUriProtocolAction(const zchar_t *protocol_action)=0
Join meeting with web uri.
virtual IMeetingRemoteSupportController * GetMeetingRemoteSupportController()=0
Get the remote support controller.
virtual IMeetingInfo * GetMeetingInfo()=0
Get meeting information.
virtual IMeetingDocsController * GetMeetingDocsController()=0
Get the Docs controller.
virtual IMeetingInterpretationController * GetMeetingInterpretationController()=0
Get the Interpretation controller.
virtual IMeetingLiveStreamController * GetMeetingLiveStreamController()=0
Get the live stream controller interface.
virtual SDKError SuspendParticipantsActivities()=0
Suspend all participant activities.
virtual IMeetingUIController * GetUIController()=0
Get the meeting UI controller interface.
virtual IZoomRealNameAuthMeetingHelper * GetMeetingRealNameAuthController()=0
Get the real name auth controller interface.
virtual SDKError SetMeetingTopic(const zchar_t *sTopic)=0
Change the meeting topic.
virtual IMeetingRawArchivingController * GetMeetingRawArchivingController()=0
Get the Raw Archiving controller.
virtual IEmojiReactionController * GetMeetingEmojiReactionController()=0
Get the Reaction controller.
virtual IMeetingWhiteboardController * GetMeetingWhiteboardController()=0
Get the Whiteboard controller.
virtual bool CanSetMeetingTopic()=0
Determine if the current user can change the meeting topic.
virtual IMeetingAudioController * GetMeetingAudioController()=0
Get the audio controller interface.
virtual bool IsMeetingLocked()=0
Determine if the meeting is locked.
virtual ICustomImmersiveController * GetMeetingImmersiveController()=0
Get the immersive controller.
virtual IMeetingAICompanionController * GetMeetingAICompanionController()=0
Get the AI companion controller.
virtual bool CanSuspendParticipantsActivities()=0
Determine if host/cohose can suspend participant activities.
virtual IAnnotationController * GetAnnotationController()=0
Get the annotation controller interface.
virtual IClosedCaptionController * GetMeetingClosedCaptionController()=0
Get the Closed Caption controller interface.
virtual IMeetingVideoController * GetMeetingVideoController()=0
Get video controller interface.
virtual IMeetingSignInterpretationController * GetMeetingSignInterpretationController()=0
Get the sign interpretation controller.
virtual SDKError Start(StartParam &startParam)=0
Start meeting.
virtual ConnectionQuality GetVideoConnQuality(bool bSending=true)=0
Get the Internet connection quality of video.
virtual IMeetingShareController * GetMeetingShareController()=0
Get the sharing controller interface.
virtual ConnectionQuality GetSharingConnQuality(bool bSending=true)=0
Get the quality of Internet connection when sharing.
virtual IMeetingProductionStudioController * GetMeetingProductionStudioController()=0
Get the production studio controller.
virtual IMeetingReminderController * GetMeetingReminderController()=0
Get the reminder controller.
virtual IMeetingRemoteController * GetMeetingRemoteController()=0
Get the remote controller interface.
virtual SDKError LockMeeting()=0
Lock the current meeting.
virtual IMeetingH323Helper * GetH323Helper()=0
Get the meeting H.323 helper interface.
Meeting share controller interface.
Meeting interpretation controller interface.
Meeting smart summary controller interface.
Meeting UI Controller Interface.
Meeting video controller interface.
Meeting waiting room controller interface.
Webinar controller interface.
Real name auth meeting helper Interface.
ZoomUserType
SDK user type. Here are more detailed structural descriptions.
@ ZoomUserType_EMAIL_LOGIN
@ ZoomUserType_GoogleOAuth
MeetingEndReason
Meeting end reason. Here are more detailed structural descriptions.
@ EndMeetingReason_HostStartAnotherMeeting
@ EndMeetingReason_JBHTimeOut
@ EndMeetingReason_FreeMeetingTimeOut
@ EndMeetingReason_EndByHost
@ EndMeetingReason_Undefined
@ EndMeetingReason_KickByHost
@ EndMeetingReason_NoAttendee
SDKViewType
SDK View Type, primary displayer and secondary displayer. Here are more detailed structural descripti...
SDKUserType
SDK user type. Here are more detailed structural descriptions.
MeetingConnType
Meeting connection type. Here are more detailed structural descriptions.
struct tagStartParam4WithoutLogin StartParam4WithoutLogin
The parameter used by unlogged-in user when starts the meeting. Here are more detailed structural des...
SDKShareViewZoomRatio
Share view zoom ratio. Here are more detailed structural descriptions.
@ SDK_ShareViewZoomRatio_100
@ SDK_ShareViewZoomRatio_150
@ SDK_ShareViewZoomRatio_300
@ SDK_ShareViewZoomRatio_200
@ SDK_ShareViewZoomRatio_50
ConnectionQuality
Connection quality. Here are more detailed structural descriptions.
struct tagMeetingParameter MeetingParameter
Meeting parameter. Here are more detailed structural descriptions.
VideoRawdataColorspace
The colorspace of video rawdata. Here are more detailed structural descriptions.
@ VideoRawdataColorspace_BT601_L
@ VideoRawdataColorspace_BT709_L
@ VideoRawdataColorspace_BT709_F
@ VideoRawdataColorspace_BT601_F
struct tagJoinParam4WithoutLogin JoinParam4WithoutLogin
The parameters of non-login user when joins the meeting. Here are more detailed structural descriptio...
MeetingStatus
Meeting status. Here are more detailed structural descriptions.
@ MEETING_STATUS_RECONNECTING
@ MEETING_STATUS_JOIN_BREAKOUT_ROOM
@ MEETING_STATUS_IN_WAITING_ROOM
@ MEETING_STATUS_DISCONNECTING
@ MEETING_STATUS_WEBINAR_PROMOTE
@ MEETING_STATUS_WAITINGFORHOST
@ MEETING_STATUS_CONNECTING
@ MEETING_STATUS_LOCKED
@ MEETING_STATUS_UNKNOWN
@ MEETING_STATUS_WEBINAR_DEPROMOTE
@ MEETING_STATUS_LEAVE_BREAKOUT_ROOM
@ MEETING_STATUS_UNLOCKED
@ MEETING_STATUS_INMEETING
@ MEETING_STATUS_FAILED
StatisticsWarningType
Meeting statistics warning type. Here are more detailed structural descriptions.
@ Statistics_Warning_None
@ Statistics_Warning_Busy_System
@ Statistics_Warning_Network_Quality_Bad
MeetingType
Meeting type. Here are more detailed structural descriptions.
@ MEETING_TYPE_BREAKOUTROOM
struct tagStartParam4NormalUser StartParam4NormalUser
The parameter of ordinary user when starts meeting. Here are more detailed structural descriptions.
struct tagJoinParam4NormalUser JoinParam4NormalUser
The parameter of ordinary logged-in user. Here are more detailed structural descriptions.
InMeetingSupportAudioType
meeting supported audio type. Here are more detailed structural descriptions.
LeaveMeetingCmd
Leave meeting command. Here are more detailed structural descriptions.
struct tagStartParam StartParam
The way and the parameter for meeting start. Here are more detailed structural descriptions.
struct tagJoinParam JoinParam
The way and the parameter of the users when join the meeting. Here are more detailed structural descr...
AudioRawdataSamplingRate
The sampling rate of raw audio data. Here are more detailed structural descriptions.
@ AudioRawdataSamplingRate_48K
@ AudioRawdataSamplingRate_32K
MeetingFailCode
Meeting failure code. Here are more detailed structural descriptions.
@ MEETING_FAIL_HOST_DISALLOW_OUTSIDE_USER_JOIN
@ MEETING_FAIL_REGISTERWEBINAR_FULL
@ MEETING_FAIL_CANNOT_START_TOKENEXPIRE
@ MEETING_FAIL_SESSION_ERR
@ MEETING_FAIL_MEETING_OVER
@ MEETING_FAIL_CLIENT_INCOMPATIBLE
@ MEETING_FAIL_MEETING_NOT_EXIST
@ MEETING_FAIL_REGISTERWEBINAR_HOSTREGISTER
@ CONF_FAIL_ZC_CERTIFICATE_CHANGED
@ MEETING_FAIL_NEED_CONFIRM_PLINK
@ MEETING_FAIL_NEED_SIGN_IN_FOR_PRIVATE_MEETING
@ MEETING_FAIL_MEETING_NOT_START
@ MEETING_FAIL_REGISTERWEBINAR_PANELISTREGISTER
@ MEETING_FAIL_MEETING_RESTRICTED_JBH
@ MEETING_FAIL_CONNECTION_ERR
@ MEETING_FAIL_NEED_INPUT_PLINK
@ MEETING_FAIL_MEETING_RESTRICTED
@ MEETING_FAIL_RECONNECT_ERR
@ MEETING_FAIL_MEETING_USER_FULL
@ MEETING_FAIL_REGISTERWEBINAR_DENIED_EMAIL
@ MEETING_FAIL_ENFORCE_LOGIN
@ MEETING_FAIL_APP_PRIVILEGE_TOKEN_ERROR
@ CONF_FAIL_DISALLOW_HOST_MEETING
@ CONF_FAIL_JOIN_WEBINAR_WITHSAMEEMAIL
@ MEETING_FAIL_WRITE_CONFIG_FILE
@ CONF_FAIL_VANITY_NOT_EXIST
@ MEETING_FAIL_JMAK_USER_EMAIL_NOT_MATCH
@ MEETING_FAIL_FORBID_TO_JOIN_INTERNAL_MEETING
@ MEETING_FAIL_PASSWORD_ERR
@ MEETING_FAIL_BLOCKED_BY_ACCOUNT_ADMIN
@ MEETING_FAIL_UNABLE_TO_JOIN_EXTERNAL_MEETING
@ MEETING_FAIL_CONFLOCKED
@ SESSION_AUDIO_AUTOSTARTERR
@ CONF_FAIL_REMOVED_BY_HOST
@ MEETING_FAIL_CANNOT_EMIT_WEBREQUEST
The parameter of ordinary logged-in user. Here are more detailed structural descriptions.
AudioRawdataSamplingRate eAudioRawdataSamplingRate
VideoRawdataColorspace eVideoRawdataColorspace
The parameters of non-login user when joins the meeting. Here are more detailed structural descriptio...
AudioRawdataSamplingRate eAudioRawdataSamplingRate
VideoRawdataColorspace eVideoRawdataColorspace
The way and the parameter of the users when join the meeting. Here are more detailed structural descr...
JoinParam4NormalUser normaluserJoin
JoinParam4WithoutLogin withoutloginuserJoin
union tagJoinParam::@1 param
Meeting parameter. Here are more detailed structural descriptions.
The parameter of ordinary user when starts meeting. Here are more detailed structural descriptions.
VideoRawdataColorspace eVideoRawdataColorspace
AudioRawdataSamplingRate eAudioRawdataSamplingRate
The parameter used by unlogged-in user when starts the meeting. Here are more detailed structural des...
VideoRawdataColorspace eVideoRawdataColorspace
AudioRawdataSamplingRate eAudioRawdataSamplingRate
The way and the parameter for meeting start. Here are more detailed structural descriptions.
union tagStartParam::@2 param
StartParam4NormalUser normaluserStart
const zchar_t * inviteContactId
StartParam4WithoutLogin withoutloginStart
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
wchar_t zchar_t
Definition zoom_sdk_def.h:9
#define BEGIN_ZOOM_SDK_NAMESPACE
SDKError
Enumeration of common errors of SDK.