Meeting SDK for Linux 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)
9class IZoomRealNameAuthMeetingHelper;
10#endif
51
57{
137
138};
139
163
179
191
203
215
259
300
322
323
343
379
385{
398#if defined(WIN32)
400 HWND hDirectShareAppWnd;
402 bool isDirectShareDesktop;
403#endif
409
410
434
456#if defined(WIN32)
461enum SDKViewType
462{
464 SDK_FIRST_VIEW,
466 SDK_SECOND_VIEW,
467
468 SDK_SEND_SHARE_VIEW,
469};
470
475enum SDKShareViewZoomRatio
476{
477 SDK_ShareViewZoomRatio_50,
478 SDK_ShareViewZoomRatio_100,
479 SDK_ShareViewZoomRatio_150,
480 SDK_ShareViewZoomRatio_200,
481 SDK_ShareViewZoomRatio_300
482};
483#endif
494
495
509
515{
516public:
522
527 virtual const zchar_t* GetMeetingID() = 0;
528
533 virtual const zchar_t* GetMeetingTopic() = 0;
534
539 virtual const zchar_t* GetMeetingPassword() = 0;
540
546
551 virtual const zchar_t* GetInviteEmailTemplate() = 0;
552
557 virtual const zchar_t* GetInviteEmailTitle() = 0;
558
563 virtual const zchar_t* GetJoinMeetingUrl() = 0;
564
569 virtual const zchar_t* GetMeetingHostTag() = 0;
570
576
582
583 virtual ~IMeetingInfo(){};
584};
585
631
645
651{
652public:
661 virtual void onMeetingStatusChanged(MeetingStatus status, int iResult = 0) = 0;
662
668
674 virtual void onMeetingParameterNotification(const MeetingParameter* meeting_param) = 0;
675
680
685 virtual void onAICompanionActiveChangeNotice(bool bActive) = 0;
686
691 virtual void onMeetingTopicChanged(const zchar_t* sTopic) = 0;
692
698 virtual void onMeetingFullToWatchLiveStream(const zchar_t* sLiveStreamUrl) = 0;
699};
700
722#if defined(WIN32)
723class IAnnotationController;
724class IMeetingBreakoutRoomsController;
725class IMeetingH323Helper;
726class IMeetingPhoneHelper;
727class IMeetingRemoteController;
728class IMeetingUIController;
729class IMeetingLiveStreamController;
730class IClosedCaptionController;
731class IMeetingQAController;
732class IMeetingInterpretationController;
733class IMeetingSignInterpretationController;
734class IEmojiReactionController;
735class IMeetingAANController;
736class ICustomImmersiveController;
737class IMeetingPollingController;
738class IMeetingIndicatorController;
739class IMeetingProductionStudioController;
740#endif
753class IMeetingWhiteboardController;
756class IMeetingRemoteSupportController;
758class IMeetingDocsController;
764{
765public:
772
778 virtual SDKError HandleZoomWebUriProtocolAction(const zchar_t* protocol_action) = 0;
779
785 virtual SDKError Join(JoinParam& joinParam) = 0;
786
792 virtual SDKError Start(StartParam& startParam) = 0;
793
799 virtual SDKError Leave(LeaveMeetingCmd leaveCmd) = 0;
800
806
811 virtual SDKError LockMeeting() = 0;
812
817 virtual SDKError UnlockMeeting() = 0;
818
823 virtual bool IsMeetingLocked() = 0;
824
829 virtual bool CanSetMeetingTopic() = 0;
830
836 virtual SDKError SetMeetingTopic(const zchar_t* sTopic) = 0;
837
843
849
855
862 virtual ConnectionQuality GetSharingConnQuality(bool bSending = true) = 0;
863
870 virtual ConnectionQuality GetVideoConnQuality(bool bSending = true) = 0;
871
878 virtual ConnectionQuality GetAudioConnQuality(bool bSending = true) = 0;
879
885
891
897
903
909
915
921
927
933
940
946
952
958
964
965#if defined(WIN32)
970 virtual IMeetingUIController* GetUIController() = 0;
971
976 virtual IAnnotationController* GetAnnotationController() = 0;
977
982 virtual IMeetingRemoteController* GetMeetingRemoteController() = 0;
983
988 virtual IMeetingH323Helper* GetH323Helper() = 0;
989
994 virtual IMeetingPhoneHelper* GetMeetingPhoneHelper() = 0;
995
1000 virtual IMeetingLiveStreamController* GetMeetingLiveStreamController() = 0;
1001
1006 virtual IClosedCaptionController* GetMeetingClosedCaptionController() = 0;
1007
1012 virtual IZoomRealNameAuthMeetingHelper* GetMeetingRealNameAuthController() = 0;
1013
1018 virtual IMeetingQAController* GetMeetingQAController() = 0;
1019
1024 virtual IMeetingInterpretationController* GetMeetingInterpretationController() = 0;
1025
1030 virtual IMeetingSignInterpretationController* GetMeetingSignInterpretationController() = 0;
1031
1036 virtual IEmojiReactionController* GetMeetingEmojiReactionController() = 0;
1037
1042 virtual IMeetingAANController* GetMeetingAANController() = 0;
1043
1048 virtual ICustomImmersiveController* GetMeetingImmersiveController() = 0;
1049
1054 virtual IMeetingWhiteboardController* GetMeetingWhiteboardController() = 0;
1055
1060 virtual IMeetingDocsController* GetMeetingDocsController() = 0;
1061
1066 virtual IMeetingPollingController* GetMeetingPollingController() = 0;
1067
1072 virtual IMeetingRemoteSupportController* GetMeetingRemoteSupportController() = 0;
1073
1078 virtual IMeetingIndicatorController* GetMeetingIndicatorController() = 0;
1079
1084 virtual IMeetingProductionStudioController* GetMeetingProductionStudioController() = 0;
1085#endif
1090
1096
1102};
1104#endif
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 AI Companion controller interface.
Meeting audio controller interface.
Meeting breakout rooms controller interface.
Meeting chat controller interface.
Meeting configuration 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 waiting room controller interface.
Meeting raw archiving controller interface.
Meeting recording controller interface.
Meeting reminder dialog 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 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 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 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 IMeetingInfo * GetMeetingInfo()=0
Get meeting information.
virtual SDKError SuspendParticipantsActivities()=0
Suspend all participant activities.
virtual SDKError SetMeetingTopic(const zchar_t *sTopic)=0
Change the meeting topic.
virtual IMeetingRawArchivingController * GetMeetingRawArchivingController()=0
Get the Raw Archiving 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 IMeetingAICompanionController * GetMeetingAICompanionController()=0
Get the AI companion controller.
virtual bool CanSuspendParticipantsActivities()=0
Determine if host/cohose can suspend participant activities.
virtual IMeetingVideoController * GetMeetingVideoController()=0
Get video controller interface.
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 IMeetingReminderController * GetMeetingReminderController()=0
Get the reminder controller.
virtual SDKError LockMeeting()=0
Lock the current meeting.
Meeting share controller interface.
Meeting smart summary controller interface.
Meeting video controller interface.
Meeting waiting room controller interface.
Webinar controller 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
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...
ConnectionQuality
Connection quality. Here are more detailed structural descriptions.
struct tagMeetingParameter MeetingParameter
Meeting parameter. Here are more detailed structural descriptions.
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
The parameters of non-login user when joins the meeting. Here are more detailed structural descriptio...
AudioRawdataSamplingRate eAudioRawdataSamplingRate
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.
AudioRawdataSamplingRate eAudioRawdataSamplingRate
The parameter used by unlogged-in user when starts the meeting. Here are more detailed structural des...
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.
void * HWND
#define END_ZOOM_SDK_NAMESPACE
uint64_t UINT64
#define BEGIN_ZOOM_SDK_NAMESPACE
char zchar_t
SDKError
Enumeration of common errors of SDK.