|
Meeting SDK for Linux API Reference
|
Meeting Service Interface. The AI Companion brand has been retired. AI-powered features are now more deeply integrated throughout Zoom Workplace. Existing APIs and SDKs that reference AI Companion will continue to function as before to ensure backward compatibility. More...
#include "zoom_sdk_def.h"Go to the source code of this file.
Data Structures | |
| struct | tagJoinParam4WithoutLogin |
| The parameters of non-login user when joins the meeting. Here are more detailed structural descriptions. More... | |
| struct | tagJoinParam4NormalUser |
| The parameter of ordinary logged-in user. Here are more detailed structural descriptions. More... | |
| struct | tagJoinParam |
| The way and the parameter of the users when join the meeting. Here are more detailed structural descriptions. More... | |
| struct | tagStartParam4WithoutLogin |
| The parameter used by unlogged-in user when starts the meeting. Here are more detailed structural descriptions. More... | |
| struct | tagStartParam4NormalUser |
| The parameter of ordinary user when starts meeting. Here are more detailed structural descriptions. More... | |
| struct | tagStartParam |
| The way and the parameter for meeting start. Here are more detailed structural descriptions. More... | |
| struct | tagMeetingAudioStatisticInfo |
| The meeting audio statistic information. More... | |
| struct | tagMeetingASVStatisticInfo |
| The meeting video or share statistic information. More... | |
| class | IMeetingInfo |
| Meeting information Interface. More... | |
| struct | tagMeetingParameter |
| Meeting parameter. Here are more detailed structural descriptions. More... | |
| class | IMeetingServiceEvent |
| Meeting service callback event. More... | |
| class | IListFactory |
| IListFactory interface. More... | |
| class | IMeetingService |
| Meeting Service Interface. More... | |
Typedefs | |
| typedef struct tagJoinParam4WithoutLogin | JoinParam4WithoutLogin |
| The parameters of non-login user when joins the meeting. Here are more detailed structural descriptions. | |
| typedef struct tagJoinParam4NormalUser | JoinParam4NormalUser |
| The parameter of ordinary logged-in user. Here are more detailed structural descriptions. | |
| typedef struct tagJoinParam | JoinParam |
| The way and the parameter of the users when join the meeting. Here are more detailed structural descriptions. | |
| typedef struct tagStartParam4WithoutLogin | StartParam4WithoutLogin |
| The parameter used by unlogged-in user when starts the meeting. Here are more detailed structural descriptions. | |
| typedef struct tagStartParam4NormalUser | StartParam4NormalUser |
| The parameter of ordinary user when starts meeting. Here are more detailed structural descriptions. | |
| typedef struct tagStartParam | StartParam |
| The way and the parameter for meeting start. Here are more detailed structural descriptions. | |
| typedef struct tagMeetingAudioStatisticInfo | MeetingAudioStatisticInfo |
| The meeting audio statistic information. | |
| typedef struct tagMeetingASVStatisticInfo | MeetingASVStatisticInfo |
| The meeting video or share statistic information. | |
| typedef struct tagMeetingParameter | MeetingParameter |
| Meeting parameter. Here are more detailed structural descriptions. | |
Meeting Service Interface. The AI Companion brand has been retired. AI-powered features are now more deeply integrated throughout Zoom Workplace. Existing APIs and SDKs that reference AI Companion will continue to function as before to ensure backward compatibility.
Definition in file meeting_service_interface.h.
| typedef struct tagJoinParam JoinParam |
The way and the parameter of the users when join the meeting. Here are more detailed structural descriptions.
| typedef struct tagJoinParam4NormalUser JoinParam4NormalUser |
The parameter of ordinary logged-in user. Here are more detailed structural descriptions.
| typedef struct tagJoinParam4WithoutLogin JoinParam4WithoutLogin |
The parameters of non-login user when joins the meeting. Here are more detailed structural descriptions.
| typedef struct tagMeetingASVStatisticInfo MeetingASVStatisticInfo |
The meeting video or share statistic information.
| typedef struct tagMeetingAudioStatisticInfo MeetingAudioStatisticInfo |
The meeting audio statistic information.
| typedef struct tagMeetingParameter MeetingParameter |
Meeting parameter. Here are more detailed structural descriptions.
| typedef struct tagStartParam StartParam |
The way and the parameter for meeting start. Here are more detailed structural descriptions.
| typedef struct tagStartParam4NormalUser StartParam4NormalUser |
The parameter of ordinary user when starts meeting. Here are more detailed structural descriptions.
| typedef struct tagStartParam4WithoutLogin StartParam4WithoutLogin |
The parameter used by unlogged-in user when starts the meeting. Here are more detailed structural descriptions.
Enumeration of raw audio data sampling rate. Here are more detailed structural descriptions.
| Enumerator | |
|---|---|
| AudioRawdataSamplingRate_32K | The sampling rate of the acquired raw audio data is 32K. |
| AudioRawdataSamplingRate_48K | The sampling rate of the acquired raw audio data is 48K. |
Definition at line 223 of file meeting_service_interface.h.
| enum ConnectionQuality |
Enumeration of connection quality. Here are more detailed structural descriptions.
Definition at line 478 of file meeting_service_interface.h.
Enumeration of meeting supported audio type. Here are more detailed structural descriptions.
| Enumerator | |
|---|---|
| AUDIO_TYPE_NONE | |
| AUDIO_TYPE_VOIP | |
| AUDIO_TYPE_TELEPHONY | |
Definition at line 647 of file meeting_service_interface.h.
| enum LeaveMeetingCmd |
Enumeration of leave meeting command. Here are more detailed structural descriptions.
| Enumerator | |
|---|---|
| LEAVE_MEETING | Leave meeting |
| END_MEETING | End meeting |
Definition at line 199 of file meeting_service_interface.h.
| enum MeetingComponentType |
Enumeration of meeting component. Here are more detailed structural descriptions.
| Enumerator | |
|---|---|
| MeetingComponentType_Def | Default component type. |
| MeetingComponentType_AUDIO | Audio. |
| MeetingComponentType_VIDEO | Video. |
| MeetingComponentType_SHARE | Share application. |
Definition at line 500 of file meeting_service_interface.h.
| enum MeetingConnType |
Enumeration of meeting connection type. Here are more detailed structural descriptions.
| Enumerator | |
|---|---|
| Meeting_Conn_None | Disconnection. |
| Meeting_Conn_Normal | Normal connection. |
| Meeting_Conn_FailOver | Failure and reconnection. |
Definition at line 659 of file meeting_service_interface.h.
| enum MeetingEndReason |
Enumeration of meeting end reason. Here are more detailed structural descriptions.
Definition at line 157 of file meeting_service_interface.h.
| enum MeetingFailCode |
Enumeration of meeting failure code. Here are more detailed structural descriptions.
| Enumerator | |
|---|---|
| MEETING_SUCCESS | Start meeting successfully. |
| MEETING_FAIL_CONNECTION_ERR | The connection with the backend service has errors. |
| MEETING_FAIL_RECONNECT_ERR | Reconnect error. |
| MEETING_FAIL_MMR_ERR | Multi-media Router error. |
| MEETING_FAIL_PASSWORD_ERR | Password is wrong. |
| MEETING_FAIL_SESSION_ERR | Session error. |
| MEETING_FAIL_MEETING_OVER | Meeting is over. |
| MEETING_FAIL_MEETING_NOT_START | Meeting has not begun. |
| MEETING_FAIL_MEETING_NOT_EXIST | Meeting does not exist. |
| MEETING_FAIL_MEETING_USER_FULL | The capacity of meeting is full. For users that can't join meeting, they can go to watch live stream with the callback IMeetingServiceEvent::onMeetingFullToWatchLiveStream if the host has started. |
| MEETING_FAIL_CLIENT_INCOMPATIBLE | The client is incompatible. |
| MEETING_FAIL_NO_MMR | The Multi-media router is not founded. |
| MEETING_FAIL_CONFLOCKED | The meeting is locked. |
| MEETING_FAIL_MEETING_RESTRICTED | The meeting is failed because of the restriction by the same account. |
| MEETING_FAIL_MEETING_RESTRICTED_JBH | The meeting is restricted by the same account while the attendee is allowed to join before the host. |
| MEETING_FAIL_CANNOT_EMIT_WEBREQUEST | Unable to send web request. |
| MEETING_FAIL_CANNOT_START_TOKENEXPIRE | The token is expired. |
| SESSION_VIDEO_ERR | Video hardware or software error. |
| SESSION_AUDIO_AUTOSTARTERR | Audio autostart error. |
| MEETING_FAIL_REGISTERWEBINAR_FULL | The number of webinar registered has reached the upper limit. |
| MEETING_FAIL_REGISTERWEBINAR_HOSTREGISTER | Register webinar with the role of webinar host. |
| MEETING_FAIL_REGISTERWEBINAR_PANELISTREGISTER | Register webinar with the role of panelist member. |
| MEETING_FAIL_REGISTERWEBINAR_DENIED_EMAIL | Register webinar with the denied email. |
| MEETING_FAIL_ENFORCE_LOGIN | Webinar request to login. |
| CONF_FAIL_ZC_CERTIFICATE_CHANGED | Invalid for Windows SDK. |
| CONF_FAIL_VANITY_NOT_EXIST | Vanity conference ID does not exist. |
| CONF_FAIL_JOIN_WEBINAR_WITHSAMEEMAIL | Join webinar with the same email. |
| CONF_FAIL_DISALLOW_HOST_MEETING | Meeting settings is not allowed to start a meeting. |
| MEETING_FAIL_WRITE_CONFIG_FILE | Disabled to write the configure file. |
| MEETING_FAIL_FORBID_TO_JOIN_INTERNAL_MEETING | Forbidden to join the internal meeting. |
| CONF_FAIL_REMOVED_BY_HOST | Removed by the host. |
| MEETING_FAIL_HOST_DISALLOW_OUTSIDE_USER_JOIN | Forbidden to join meeting |
| MEETING_FAIL_UNABLE_TO_JOIN_EXTERNAL_MEETING | To join a meeting hosted by an external Zoom account, your SDK app has to be published on Zoom Marketplace. You can refer to Section 6.1 of Zoom's API License Terms of Use. |
| MEETING_FAIL_BLOCKED_BY_ACCOUNT_ADMIN | Join failed because this Meeting SDK key is blocked by the host's account admin. |
| MEETING_FAIL_NEED_SIGN_IN_FOR_PRIVATE_MEETING | Need sign in using the same account as the meeting organizer. |
| MEETING_FAIL_NEED_CONFIRM_PLINK | Join meeting param vanityID is duplicated and needs to be confirmed.For more information about Vanity URLs, see https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061540#multipleVanity |
| MEETING_FAIL_NEED_INPUT_PLINK | Join meeting param vanityID does not exist in the current account.For more information about Vanity URLs, see https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061540#multipleVanity |
| MEETING_FAIL_APP_PRIVILEGE_TOKEN_ERROR | App join token error. |
| MEETING_FAIL_AUTHORIZED_USER_NOT_INMEETING | Authorized user not in meeting. |
| MEETING_FAIL_ON_BEHALF_TOKEN_CONFLICT_LOGIN_ERROR | On-behalf token error: conflict with login credentials. |
| MEETING_FAIL_USER_LEVEL_TOKEN_NOT_HAVE_HOST_ZAK_OBF | User level privilege token not have host zak/obf. |
| MEETING_FAIL_APP_CAN_NOT_ANONYMOUS_JOIN_MEETING | App can not anonymous join meeting. |
| MEETING_FAIL_ON_BEHALF_TOKEN_INVALID | On-behalf token invalid. |
| MEETING_FAIL_ON_BEHALF_TOKEN_NOT_MATCH_MEETING | On-behalf token meeting number not match. |
| MEETING_FAIL_JMAK_USER_EMAIL_NOT_MATCH | Jmak user email not match. |
| MEETING_FAIL_UNKNOWN | |
Definition at line 57 of file meeting_service_interface.h.
| enum MeetingStatus |
Enumeration of meeting status. Here are more detailed structural descriptions.
Definition at line 17 of file meeting_service_interface.h.
| enum MeetingType |
Enumeration of meeting type. Here are more detailed structural descriptions.
| Enumerator | |
|---|---|
| MEETING_TYPE_NONE | For initialization. |
| MEETING_TYPE_NORMAL | Ordinary meeting. |
| MEETING_TYPE_WEBINAR | Webinar. |
| MEETING_TYPE_BREAKOUTROOM | Breakout meeting. |
Definition at line 183 of file meeting_service_interface.h.
| enum SDKUserType |
Enumeration of SDK user type. Here are more detailed structural descriptions.
| Enumerator | |
|---|---|
| SDK_UT_NORMALUSER | Type of ordinary user who needs to login. |
| SDK_UT_WITHOUT_LOGIN | Start meeting without login. |
Definition at line 211 of file meeting_service_interface.h.
Enumeration of meeting statistics warning type. Here are more detailed structural descriptions.
| Enumerator | |
|---|---|
| Statistics_Warning_None | No warning. |
| Statistics_Warning_Network_Quality_Bad | The network connection quality is bad. |
| Statistics_Warning_Busy_System | The system is busy. |
Definition at line 795 of file meeting_service_interface.h.
Enumeration of video rawdata colorspace. Here are more detailed structural descriptions.
Definition at line 235 of file meeting_service_interface.h.
| enum ZoomUserType |
Enumeration of Zoom user type. Here are more detailed structural descriptions.
Definition at line 363 of file meeting_service_interface.h.