meeting_service_interface.h File Reference

Meeting Service Interface. 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
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	IMeetingService
	Meeting Service Interface. More...

Typedefs
typedef struct tagJoinParam4WithoutLogin	JoinParam4WithoutLogin
typedef struct tagJoinParam4NormalUser	JoinParam4NormalUser
typedef struct tagJoinParam	JoinParam
typedef struct tagStartParam4WithoutLogin	StartParam4WithoutLogin
typedef struct tagStartParam4NormalUser	StartParam4NormalUser
typedef struct tagStartParam	StartParam
typedef struct tagMeetingParameter	MeetingParameter

Enumerations
enum	MeetingStatus {   MEETING_STATUS_IDLE , MEETING_STATUS_CONNECTING , MEETING_STATUS_WAITINGFORHOST , MEETING_STATUS_INMEETING ,   MEETING_STATUS_DISCONNECTING , MEETING_STATUS_RECONNECTING , MEETING_STATUS_FAILED , MEETING_STATUS_ENDED ,   MEETING_STATUS_UNKNOWN , MEETING_STATUS_LOCKED , MEETING_STATUS_UNLOCKED , MEETING_STATUS_IN_WAITING_ROOM ,   MEETING_STATUS_WEBINAR_PROMOTE , MEETING_STATUS_WEBINAR_DEPROMOTE , MEETING_STATUS_JOIN_BREAKOUT_ROOM , MEETING_STATUS_LEAVE_BREAKOUT_ROOM }
	Meeting status. Here are more detailed structural descriptions. More...
enum	MeetingFailCode {   MEETING_SUCCESS = 0 , MEETING_FAIL_NETWORK_ERR = 1 , MEETING_FAIL_RECONNECT_ERR = 2 , MEETING_FAIL_MMR_ERR = 3 ,   MEETING_FAIL_PASSWORD_ERR = 4 , MEETING_FAIL_SESSION_ERR = 5 , MEETING_FAIL_MEETING_OVER = 6 , MEETING_FAIL_MEETING_NOT_START = 7 ,   MEETING_FAIL_MEETING_NOT_EXIST = 8 , MEETING_FAIL_MEETING_USER_FULL = 9 , MEETING_FAIL_CLIENT_INCOMPATIBLE = 10 , MEETING_FAIL_NO_MMR = 11 ,   MEETING_FAIL_CONFLOCKED = 12 , MEETING_FAIL_MEETING_RESTRICTED = 13 , MEETING_FAIL_MEETING_RESTRICTED_JBH = 14 , MEETING_FAIL_CANNOT_EMIT_WEBREQUEST = 15 ,   MEETING_FAIL_CANNOT_START_TOKENEXPIRE = 16 , SESSION_VIDEO_ERR = 17 , SESSION_AUDIO_AUTOSTARTERR = 18 , MEETING_FAIL_REGISTERWEBINAR_FULL = 19 ,   MEETING_FAIL_REGISTERWEBINAR_HOSTREGISTER = 20 , MEETING_FAIL_REGISTERWEBINAR_PANELISTREGISTER = 21 , MEETING_FAIL_REGISTERWEBINAR_DENIED_EMAIL = 22 , MEETING_FAIL_ENFORCE_LOGIN = 23 ,   CONF_FAIL_ZC_CERTIFICATE_CHANGED = 24 , CONF_FAIL_VANITY_NOT_EXIST = 27 , CONF_FAIL_JOIN_WEBINAR_WITHSAMEEMAIL = 28 , CONF_FAIL_DISALLOW_HOST_MEETING = 29 ,   MEETING_FAIL_WRITE_CONFIG_FILE = 50 , MEETING_FAIL_FORBID_TO_JOIN_INTERNAL_MEETING = 60 , CONF_FAIL_REMOVED_BY_HOST = 61 , MEETING_FAIL_HOST_DISALLOW_OUTSIDE_USER_JOIN = 62 ,   MEETING_FAIL_UNABLE_TO_JOIN_EXTERNAL_MEETING = 63 , MEETING_FAIL_BLOCKED_BY_ACCOUNT_ADMIN = 64 , MEETING_FAIL_NEED_SIGN_IN_FOR_PRIVATE_MEETING = 82 , MEETING_FAIL_APP_PRIVILEGE_TOKEN_ERROR = 500 ,   MEETING_FAIL_JMAK_USER_EMAIL_NOT_MATCH = 1143 , MEETING_FAIL_UNKNOWN = 0xffff }
	Meeting failure code. Here are more detailed structural descriptions. More...
enum	MeetingEndReason {   EndMeetingReason_None = 0 , EndMeetingReason_KickByHost = 1 , EndMeetingReason_EndByHost = 2 , EndMeetingReason_JBHTimeOut = 3 ,   EndMeetingReason_NoAttendee = 4 , EndMeetingReason_HostStartAnotherMeeting = 5 , EndMeetingReason_FreeMeetingTimeOut = 6 , EndMeetingReason_NetworkBroken }
	Meeting end reason. Here are more detailed structural descriptions. More...
enum	MeetingType { MEETING_TYPE_NONE , MEETING_TYPE_NORMAL , MEETING_TYPE_WEBINAR , MEETING_TYPE_BREAKOUTROOM }
	Meeting type. Here are more detailed structural descriptions. More...
enum	LeaveMeetingCmd { LEAVE_MEETING , END_MEETING }
	Leave meeting command. Here are more detailed structural descriptions. More...
enum	SDKUserType { SDK_UT_NORMALUSER = 100 , SDK_UT_WITHOUT_LOGIN }
	SDK user type. Here are more detailed structural descriptions. More...
enum	AudioRawdataSamplingRate { AudioRawdataSamplingRate_32K , AudioRawdataSamplingRate_48K }
	The sampling rate of raw audio data. Here are more detailed structural descriptions. More...
enum	ZoomUserType {   ZoomUserType_APIUSER , ZoomUserType_EMAIL_LOGIN , ZoomUserType_FACEBOOK , ZoomUserType_GoogleOAuth ,   ZoomUserType_SSO , ZoomUserType_Unknown }
	SDK user type. Here are more detailed structural descriptions. More...
enum	ConnectionQuality {   Conn_Quality_Unknown , Conn_Quality_Very_Bad , Conn_Quality_Bad , Conn_Quality_Not_Good ,   Conn_Quality_Normal , Conn_Quality_Good , Conn_Quality_Excellent }
	Connection quality. Here are more detailed structural descriptions. More...
enum	InMeetingSupportAudioType { AUDIO_TYPE_NONE = 0 , AUDIO_TYPE_VOIP = 1 , AUDIO_TYPE_TELEPHONY = 1 << 1 }
	meeting supported audio type. Here are more detailed structural descriptions. More...
enum	MeetingConnType { Meeting_Conn_None , Meeting_Conn_Normal , Meeting_Conn_FailOver }
	Meeting connection type. Here are more detailed structural descriptions. More...
enum	StatisticsWarningType { Statistics_Warning_None , Statistics_Warning_Network_Quality_Bad , Statistics_Warning_Busy_System }
	Meeting statistics warning type. Here are more detailed structural descriptions. More...

Detailed Description

Meeting Service Interface.

Definition in file meeting_service_interface.h.

Typedef Documentation

JoinParam

typedef struct tagJoinParam JoinParam

JoinParam4NormalUser

typedef struct tagJoinParam4NormalUser JoinParam4NormalUser

JoinParam4WithoutLogin

typedef struct tagJoinParam4WithoutLogin JoinParam4WithoutLogin

MeetingParameter

typedef struct tagMeetingParameter MeetingParameter

StartParam

typedef struct tagStartParam StartParam

StartParam4NormalUser

typedef struct tagStartParam4NormalUser StartParam4NormalUser

StartParam4WithoutLogin

typedef struct tagStartParam4WithoutLogin StartParam4WithoutLogin

Enumeration Type Documentation

AudioRawdataSamplingRate

enum AudioRawdataSamplingRate

The sampling rate of raw audio data. 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 136 of file meeting_service_interface.h.

{
    AudioRawdataSamplingRate_32K, 
    AudioRawdataSamplingRate_48K, 
};

ConnectionQuality

enum ConnectionQuality

Connection quality. Here are more detailed structural descriptions.

Enumerator
Conn_Quality_Unknown	Unknown connection status.
Conn_Quality_Very_Bad	The connection quality is very poor.
Conn_Quality_Bad	The connection quality is poor.
Conn_Quality_Not_Good	The connection quality is not good.
Conn_Quality_Normal	The connection quality is normal.
Conn_Quality_Good	The connection quality is good.
Conn_Quality_Excellent	The connection quality is excellent.

Definition at line 297 of file meeting_service_interface.h.

{
    Conn_Quality_Unknown,
    Conn_Quality_Very_Bad,
    Conn_Quality_Bad,
    Conn_Quality_Not_Good,
    Conn_Quality_Normal,
    Conn_Quality_Good,
    Conn_Quality_Excellent,
};

InMeetingSupportAudioType

enum InMeetingSupportAudioType

meeting supported audio type. Here are more detailed structural descriptions.

Enumerator
AUDIO_TYPE_NONE
AUDIO_TYPE_VOIP
AUDIO_TYPE_TELEPHONY

Definition at line 336 of file meeting_service_interface.h.

{
    AUDIO_TYPE_NONE = 0,
    AUDIO_TYPE_VOIP = 1,
    AUDIO_TYPE_TELEPHONY = 1 << 1
};

LeaveMeetingCmd

enum LeaveMeetingCmd

Leave meeting command. Here are more detailed structural descriptions.

Enumerator
LEAVE_MEETING	Leave meeting.
END_MEETING	End meeting.

Definition at line 116 of file meeting_service_interface.h.

{
    LEAVE_MEETING,
    END_MEETING,
};

MeetingConnType

enum MeetingConnType

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 348 of file meeting_service_interface.h.

{
    Meeting_Conn_None,
    Meeting_Conn_Normal,
    Meeting_Conn_FailOver,
};

MeetingEndReason

enum MeetingEndReason

Meeting end reason. Here are more detailed structural descriptions.

Enumerator
EndMeetingReason_None	For initialization.
EndMeetingReason_KickByHost	Kicked by host.
EndMeetingReason_EndByHost	Ended by host.
EndMeetingReason_JBHTimeOut	JBH times out.
EndMeetingReason_NoAttendee	No attendee.
EndMeetingReason_HostStartAnotherMeeting	Host starts another meeting.
EndMeetingReason_FreeMeetingTimeOut	Free meeting times out.
EndMeetingReason_NetworkBroken	Network is broken.

Definition at line 88 of file meeting_service_interface.h.

{
    EndMeetingReason_None = 0,
    EndMeetingReason_KickByHost = 1,
    EndMeetingReason_EndByHost = 2,
    EndMeetingReason_JBHTimeOut = 3,
    EndMeetingReason_NoAttendee = 4,
    EndMeetingReason_HostStartAnotherMeeting = 5,
    EndMeetingReason_FreeMeetingTimeOut = 6,
    EndMeetingReason_NetworkBroken,
};

MeetingFailCode

enum MeetingFailCode

Meeting failure code. Here are more detailed structural descriptions.

Enumerator
MEETING_SUCCESS	Start meeting successfully.
MEETING_FAIL_NETWORK_ERR	Network error.
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
SESSION_VIDEO_ERR	The token is expired. 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_APP_PRIVILEGE_TOKEN_ERROR	App join token error.
MEETING_FAIL_JMAK_USER_EMAIL_NOT_MATCH	Jmak user email not match.
MEETING_FAIL_UNKNOWN

Definition at line 41 of file meeting_service_interface.h.

{
    MEETING_SUCCESS                         = 0,
    MEETING_FAIL_NETWORK_ERR                = 1,
    MEETING_FAIL_RECONNECT_ERR              = 2,
    MEETING_FAIL_MMR_ERR                    = 3,
    MEETING_FAIL_PASSWORD_ERR               = 4,
    MEETING_FAIL_SESSION_ERR                = 5,
    MEETING_FAIL_MEETING_OVER               = 6,
    MEETING_FAIL_MEETING_NOT_START          = 7,
    MEETING_FAIL_MEETING_NOT_EXIST          = 8,
    MEETING_FAIL_MEETING_USER_FULL          = 9,
    MEETING_FAIL_CLIENT_INCOMPATIBLE        = 10,
    MEETING_FAIL_NO_MMR                     = 11,
    MEETING_FAIL_CONFLOCKED                 = 12,
    MEETING_FAIL_MEETING_RESTRICTED         = 13,
    MEETING_FAIL_MEETING_RESTRICTED_JBH     = 14,
    MEETING_FAIL_CANNOT_EMIT_WEBREQUEST     = 15,
    MEETING_FAIL_CANNOT_START_TOKENEXPIRE   = 16,
    SESSION_VIDEO_ERR                       = 17,
    SESSION_AUDIO_AUTOSTARTERR              = 18,
    MEETING_FAIL_REGISTERWEBINAR_FULL       = 19,
    MEETING_FAIL_REGISTERWEBINAR_HOSTREGISTER       = 20,
    MEETING_FAIL_REGISTERWEBINAR_PANELISTREGISTER   = 21,
    MEETING_FAIL_REGISTERWEBINAR_DENIED_EMAIL       = 22,
    MEETING_FAIL_ENFORCE_LOGIN      = 23,
    CONF_FAIL_ZC_CERTIFICATE_CHANGED        = 24,  
    CONF_FAIL_VANITY_NOT_EXIST              = 27, 
    CONF_FAIL_JOIN_WEBINAR_WITHSAMEEMAIL        = 28, 
    CONF_FAIL_DISALLOW_HOST_MEETING     = 29, 
    MEETING_FAIL_WRITE_CONFIG_FILE          = 50,   
    MEETING_FAIL_FORBID_TO_JOIN_INTERNAL_MEETING = 60, 
    CONF_FAIL_REMOVED_BY_HOST = 61, 
    MEETING_FAIL_HOST_DISALLOW_OUTSIDE_USER_JOIN = 62,   
    MEETING_FAIL_UNABLE_TO_JOIN_EXTERNAL_MEETING = 63,  
    MEETING_FAIL_BLOCKED_BY_ACCOUNT_ADMIN = 64,  
    MEETING_FAIL_NEED_SIGN_IN_FOR_PRIVATE_MEETING = 82,  
    MEETING_FAIL_APP_PRIVILEGE_TOKEN_ERROR = 500,  
    MEETING_FAIL_JMAK_USER_EMAIL_NOT_MATCH = 1143, 
    MEETING_FAIL_UNKNOWN = 0xffff,
 
};  

MeetingStatus

enum MeetingStatus

Meeting status. Here are more detailed structural descriptions.

Enumerator
MEETING_STATUS_IDLE	No meeting is running.
MEETING_STATUS_CONNECTING	Connect to the meeting server status.
MEETING_STATUS_WAITINGFORHOST	Waiting for the host to start the meeting.
MEETING_STATUS_INMEETING	Meeting is ready, in meeting status.
MEETING_STATUS_DISCONNECTING	Disconnect the meeting server, leave meeting status.
MEETING_STATUS_RECONNECTING	Reconnecting meeting server status.
MEETING_STATUS_FAILED	Failed to connect the meeting server.
MEETING_STATUS_ENDED	Meeting ends.
MEETING_STATUS_UNKNOWN	Unknown status.
MEETING_STATUS_LOCKED	Meeting is locked to prevent the further participants to join the meeting.
MEETING_STATUS_UNLOCKED	Meeting is open and participants can join the meeting.
MEETING_STATUS_IN_WAITING_ROOM	Participants who join the meeting before the start are in the waiting room.
MEETING_STATUS_WEBINAR_PROMOTE	Upgrade the attendees to panelist in webinar.
MEETING_STATUS_WEBINAR_DEPROMOTE	Downgrade the attendees from the panelist.
MEETING_STATUS_JOIN_BREAKOUT_ROOM	Join the breakout room.
MEETING_STATUS_LEAVE_BREAKOUT_ROOM	Leave the breakout room.

Definition at line 17 of file meeting_service_interface.h.

{
    MEETING_STATUS_IDLE,
    MEETING_STATUS_CONNECTING,
    MEETING_STATUS_WAITINGFORHOST,
    MEETING_STATUS_INMEETING,
    MEETING_STATUS_DISCONNECTING,
    MEETING_STATUS_RECONNECTING,
    MEETING_STATUS_FAILED,
    MEETING_STATUS_ENDED,
    MEETING_STATUS_UNKNOWN,
    MEETING_STATUS_LOCKED,
    MEETING_STATUS_UNLOCKED,
    MEETING_STATUS_IN_WAITING_ROOM,
    MEETING_STATUS_WEBINAR_PROMOTE,
    MEETING_STATUS_WEBINAR_DEPROMOTE,
    MEETING_STATUS_JOIN_BREAKOUT_ROOM,
    MEETING_STATUS_LEAVE_BREAKOUT_ROOM,
};

MeetingType

enum MeetingType

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 104 of file meeting_service_interface.h.

{
    MEETING_TYPE_NONE,
    MEETING_TYPE_NORMAL,
    MEETING_TYPE_WEBINAR,
    MEETING_TYPE_BREAKOUTROOM,
};

SDKUserType

enum SDKUserType

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 126 of file meeting_service_interface.h.

{
    SDK_UT_NORMALUSER = 100,
    SDK_UT_WITHOUT_LOGIN,
};

StatisticsWarningType

enum StatisticsWarningType

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 450 of file meeting_service_interface.h.

{
    Statistics_Warning_None,
    Statistics_Warning_Network_Quality_Bad,
    Statistics_Warning_Busy_System,
};

ZoomUserType

enum ZoomUserType

SDK user type. Here are more detailed structural descriptions.

Enumerator
ZoomUserType_APIUSER	API user.
ZoomUserType_EMAIL_LOGIN	User logged in with email.
ZoomUserType_FACEBOOK	User logged in with Facebook.
ZoomUserType_GoogleOAuth	User logged in with Google.
ZoomUserType_SSO	User logged in with SSO.
ZoomUserType_Unknown	User of unknown type.

Definition at line 218 of file meeting_service_interface.h.

{
    ZoomUserType_APIUSER,
    ZoomUserType_EMAIL_LOGIN,
    ZoomUserType_FACEBOOK,
    ZoomUserType_GoogleOAuth,
    ZoomUserType_SSO,
    ZoomUserType_Unknown,
};