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{
133
134};
135
159
175
187
199
211
255
296
318
319
339
375
381{
394#if defined(WIN32)
396 HWND hDirectShareAppWnd;
398 bool isDirectShareDesktop;
399#endif
405
406
430
452#if defined(WIN32)
457enum SDKViewType
458{
460 SDK_FIRST_VIEW,
462 SDK_SECOND_VIEW,
463
464 SDK_SEND_SHARE_VIEW,
465};
466
471enum SDKShareViewZoomRatio
472{
473 SDK_ShareViewZoomRatio_50,
474 SDK_ShareViewZoomRatio_100,
475 SDK_ShareViewZoomRatio_150,
476 SDK_ShareViewZoomRatio_200,
477 SDK_ShareViewZoomRatio_300
478};
479#endif
490
491
505
511{
512public:
518
523 virtual const zchar_t* GetMeetingID() = 0;
524
529 virtual const zchar_t* GetMeetingTopic() = 0;
530
535 virtual const zchar_t* GetMeetingPassword() = 0;
536
542
547 virtual const zchar_t* GetInviteEmailTemplate() = 0;
548
553 virtual const zchar_t* GetInviteEmailTitle() = 0;
554
559 virtual const zchar_t* GetJoinMeetingUrl() = 0;
560
565 virtual const zchar_t* GetMeetingHostTag() = 0;
566
572
578
579 virtual ~IMeetingInfo(){};
580};
581
627
641
647{
648public:
657 virtual void onMeetingStatusChanged(MeetingStatus status, int iResult = 0) = 0;
658
664
670 virtual void onMeetingParameterNotification(const MeetingParameter* meeting_param) = 0;
671
676
681 virtual void onAICompanionActiveChangeNotice(bool bActive) = 0;
682
687 virtual void onMeetingTopicChanged(const zchar_t* sTopic) = 0;
688
694 virtual void onMeetingFullToWatchLiveStream(const zchar_t* sLiveStreamUrl) = 0;
695};
696
718#if defined(WIN32)
719class IAnnotationController;
720class IMeetingBreakoutRoomsController;
721class IMeetingH323Helper;
722class IMeetingPhoneHelper;
723class IMeetingRemoteController;
724class IMeetingUIController;
725class IMeetingLiveStreamController;
726class IClosedCaptionController;
727class IMeetingQAController;
728class IMeetingInterpretationController;
729class IMeetingSignInterpretationController;
730class IEmojiReactionController;
731class IMeetingAANController;
732class ICustomImmersiveController;
733class IMeetingPollingController;
734class IMeetingIndicatorController;
735class IMeetingProductionStudioController;
736#endif
749class IMeetingWhiteboardController;
752class IMeetingRemoteSupportController;
754class IMeetingDocsController;
760{
761public:
768
774 virtual SDKError HandleZoomWebUriProtocolAction(const zchar_t* protocol_action) = 0;
775
781 virtual SDKError Join(JoinParam& joinParam) = 0;
782
788 virtual SDKError Start(StartParam& startParam) = 0;
789
795 virtual SDKError Leave(LeaveMeetingCmd leaveCmd) = 0;
796
802
807 virtual SDKError LockMeeting() = 0;
808
813 virtual SDKError UnlockMeeting() = 0;
814
819 virtual bool IsMeetingLocked() = 0;
820
825 virtual bool CanSetMeetingTopic() = 0;
826
832 virtual SDKError SetMeetingTopic(const zchar_t* sTopic) = 0;
833
839
845
851
858 virtual ConnectionQuality GetSharingConnQuality(bool bSending = true) = 0;
859
866 virtual ConnectionQuality GetVideoConnQuality(bool bSending = true) = 0;
867
874 virtual ConnectionQuality GetAudioConnQuality(bool bSending = true) = 0;
875
881
887
893
899
905
911
917
923
929
936
942
948
954
960
961#if defined(WIN32)
966 virtual IMeetingUIController* GetUIController() = 0;
967
972 virtual IAnnotationController* GetAnnotationController() = 0;
973
978 virtual IMeetingRemoteController* GetMeetingRemoteController() = 0;
979
984 virtual IMeetingH323Helper* GetH323Helper() = 0;
985
990 virtual IMeetingPhoneHelper* GetMeetingPhoneHelper() = 0;
991
996 virtual IMeetingLiveStreamController* GetMeetingLiveStreamController() = 0;
997
1002 virtual IClosedCaptionController* GetMeetingClosedCaptionController() = 0;
1003
1008 virtual IZoomRealNameAuthMeetingHelper* GetMeetingRealNameAuthController() = 0;
1009
1014 virtual IMeetingQAController* GetMeetingQAController() = 0;
1015
1020 virtual IMeetingInterpretationController* GetMeetingInterpretationController() = 0;
1021
1026 virtual IMeetingSignInterpretationController* GetMeetingSignInterpretationController() = 0;
1027
1032 virtual IEmojiReactionController* GetMeetingEmojiReactionController() = 0;
1033
1038 virtual IMeetingAANController* GetMeetingAANController() = 0;
1039
1044 virtual ICustomImmersiveController* GetMeetingImmersiveController() = 0;
1045
1050 virtual IMeetingWhiteboardController* GetMeetingWhiteboardController() = 0;
1051
1056 virtual IMeetingDocsController* GetMeetingDocsController() = 0;
1057
1062 virtual IMeetingPollingController* GetMeetingPollingController() = 0;
1063
1068 virtual IMeetingRemoteSupportController* GetMeetingRemoteSupportController() = 0;
1069
1074 virtual IMeetingIndicatorController* GetMeetingIndicatorController() = 0;
1075
1080 virtual IMeetingProductionStudioController* GetMeetingProductionStudioController() = 0;
1081#endif
1086
1092
1098};
1100#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_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_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.