zoom_meeting

Zoom Meeting
Description:
  • Zoom Meeting
Source:
Parameters:
Name Type Description
meetingstatuscb function Meeting status changed callback.
Returns:
Type
ZoomMeeting
Description:
  • Zoom Meeting
Source:
Parameters:
Name Type Description
meetingstatuscb function Meeting status changed callback.
Returns:
Type
ZoomMeeting

Methods

(inner) CanSetMeetingTopic() → {Boolean}

Description:
  • Determine if the current user can change the meeting topic.
Source:
Returns:
If it can change the meeting topic, the return value is true.
Type
Boolean

(inner) CanSetMeetingTopic() → {Boolean}

Description:
  • Determine if the current user can change the meeting topic.
Source:
Returns:
If it can change the meeting topic, the return value is true.
Type
Boolean

(inner) GetAudioConnQuality() → {AudioConnQuality}

Description:
  • Get the Internet connection quality of audio. If you are not in the meeting, the Conn_Quality_Unknown will be returned.
Source:
Returns:
If the function succeed, the return is one of those enums Defined in: ConnectionQuality
Type
AudioConnQuality

(inner) GetAudioConnQuality() → {AudioConnQuality}

Description:
  • Get the Internet connection quality of audio. If you are not in the meeting, the Conn_Quality_Unknown will be returned.
Source:
Returns:
If the function succeed, the return is one of those enums Defined in: ConnectionQuality
Type
AudioConnQuality

(inner) GetSharingConnQuality() → {Number}

Description:
  • Get the quality of Internet connection when sharing. If you are not in the meeting, the Conn_Quality_Unknown will be returned.
Source:
Returns:
If the function succeed, the return is one of those enums Defined in: ConnectionQuality
Type
Number

(inner) GetSharingConnQuality() → {Number}

Description:
  • Get the quality of Internet connection when sharing. If you are not in the meeting, the Conn_Quality_Unknown will be returned.
Source:
Returns:
If the function succeed, the return is one of those enums Defined in: ConnectionQuality
Type
Number

(inner) GetVideoConnQuality() → {Number}

Description:
  • Get the Internet connection quality of video. If you are not in the meeting, the Conn_Quality_Unknown will be returned.
Source:
Returns:
If the function succeed, the return is one of those enums Defined in: ConnectionQuality
Type
Number

(inner) GetVideoConnQuality() → {Number}

Description:
  • Get the Internet connection quality of video. If you are not in the meeting, the Conn_Quality_Unknown will be returned.
Source:
Returns:
If the function succeed, the return is one of those enums Defined in: ConnectionQuality
Type
Number

(inner) HandleZoomWebUriProtocolAction(protocol_action) → {Number}

Description:
  • Join meeting with web uri
Source:
Parameters:
Name Type Description
protocol_action String
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) HandleZoomWebUriProtocolAction(protocol_action) → {Number}

Description:
  • Join meeting with web uri
Source:
Parameters:
Name Type Description
protocol_action String
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) JoinMeeting(meetingnum, vanityid, username, psw, directshareappwndhandle, customer_key, webinartoken, isvideooff, isaudiooff, isdirectsharedesktop, app_privilege_token, join_token) → {Number}

Description:
  • Join the meeting.
Source:
Parameters:
Name Type Description
meetingnum Number A number to the meeting to be joined, meetingnum or vanityid is Required
vanityid String vanityid is suffix of Personal Link, meetingnum or vanityid is Required
username String
psw String Meeting password
directshareappwndhandle Number Windows handle of which window you want to share directly (require hexadecimal)
customer_key String The customer key that need the app intergrated with sdk to specify. The SDK will set this value when the associated settings are turned on. The max length of customer_key is 35
webinartoken String webinar token
isvideooff Boolean
isaudiooff Boolean
isdirectsharedesktop Boolean
app_privilege_token String
join_token String
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) JoinMeeting(meetingnum, vanityid, username, psw, directshareappwndhandle, customer_key, webinartoken, isvideooff, isaudiooff, isdirectsharedesktop, app_privilege_token, join_token) → {Number}

Description:
  • Join the meeting.
Source:
Parameters:
Name Type Description
meetingnum Number A number to the meeting to be joined, meetingnum or vanityid is Required
vanityid String vanityid is suffix of Personal Link, meetingnum or vanityid is Required
username String
psw String Meeting password
directshareappwndhandle Number Windows handle of which window you want to share directly (require hexadecimal)
customer_key String The customer key that need the app intergrated with sdk to specify. The SDK will set this value when the associated settings are turned on. The max length of customer_key is 35
webinartoken String webinar token
isvideooff Boolean
isaudiooff Boolean
isdirectsharedesktop Boolean
app_privilege_token String
join_token String
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) JoinMeetingWithoutLogin(meetingnum, vanityid, username, psw, directshareappwndhandle:, toke4enfrocelogin, customer_key, webinartoken, isdirectsharedesktop, isvideooff, isaudiooff, app_privilege_token, join_token) → {Number}

Description:
  • Join meeting withoutlogin
Source:
Parameters:
Name Type Description
meetingnum Number [Required] Meeting Number, meetingnum or vanityid is Required
vanityid String [Optinal] vanityid is suffix of Personal Link, meetingnum or vanityid is Required
username String [Optinal] User Name
psw String [Optinal] Meeting password
directshareappwndhandle: Number [Optinal] The window handle of the direct sharing application (require hexadecimal)
toke4enfrocelogin String [Optinal] Use the token if the meeting required to login at first
customer_key String [Optinal] The customer key that need the app intergrated with sdk to specify. The SDK will set this value when the associated settings are turned on. The max length of customer_key is 35
webinartoken String [Optinal] Webinar token, if try to join webinar as a panelist
isdirectsharedesktop Boolean [Optinal] Share the desktop directly or not. True indicates to share
isvideooff Boolean [Optinal] Turn off the video or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
isaudiooff Boolean [Optinal] Turn off the audio or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
app_privilege_token String
join_token String
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) JoinMeetingWithoutLogin(meetingnum, vanityid, username, psw, directshareappwndhandle:, toke4enfrocelogin, customer_key, webinartoken, isdirectsharedesktop, isvideooff, isaudiooff, app_privilege_token, join_token) → {Number}

Description:
  • Join meeting withoutlogin
Source:
Parameters:
Name Type Description
meetingnum Number [Required] Meeting Number, meetingnum or vanityid is Required
vanityid String [Optinal] vanityid is suffix of Personal Link, meetingnum or vanityid is Required
username String [Optinal] User Name
psw String [Optinal] Meeting password
directshareappwndhandle: Number [Optinal] The window handle of the direct sharing application (require hexadecimal)
toke4enfrocelogin String [Optinal] Use the token if the meeting required to login at first
customer_key String [Optinal] The customer key that need the app intergrated with sdk to specify. The SDK will set this value when the associated settings are turned on. The max length of customer_key is 35
webinartoken String [Optinal] Webinar token, if try to join webinar as a panelist
isdirectsharedesktop Boolean [Optinal] Share the desktop directly or not. True indicates to share
isvideooff Boolean [Optinal] Turn off the video or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
isaudiooff Boolean [Optinal] Turn off the audio or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
app_privilege_token String
join_token String
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) LeaveMeeting(endMeeting) → {Number}

Description:
  • Leave meeting.
Source:
Parameters:
Name Type Description
endMeeting Boolean
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) LeaveMeeting(endMeeting) → {Number}

Description:
  • Leave meeting.
Source:
Parameters:
Name Type Description
endMeeting Boolean
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Lock_Meeting() → {Number}

Description:
  • Lock the current meeting.
Source:
Returns:
If the function succeed, the return value is the SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Lock_Meeting() → {Number}

Description:
  • Lock the current meeting.
Source:
Returns:
If the function succeed, the return value is the SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) SetMeetingParameterNotificationCB(onMeetingParameterNotification) → {Boolean}

Description:
  • Set meeting parameter notification callback function.
Source:
Parameters:
Name Type Description
onMeetingParameterNotification function
Returns:
Type
Boolean

(inner) SetMeetingParameterNotificationCB(onMeetingParameterNotification) → {Boolean}

Description:
  • Set meeting parameter notification callback function.
Source:
Parameters:
Name Type Description
onMeetingParameterNotification function
Returns:
Type
Boolean

(inner) SetMeetingStatisticsWarningNotificationCB(onMeetingStatisticsWarningNotification) → {Boolean}

Description:
  • Set meeting statistics warning notification callback function.
Source:
Parameters:
Name Type Description
onMeetingStatisticsWarningNotification function
Returns:
Type
Boolean

(inner) SetMeetingStatisticsWarningNotificationCB(onMeetingStatisticsWarningNotification) → {Boolean}

Description:
  • Set meeting statistics warning notification callback function.
Source:
Parameters:
Name Type Description
onMeetingStatisticsWarningNotification function
Returns:
Type
Boolean

(inner) SetMeetingStatusCB(meetingstatuscb) → {Boolean}

Description:
  • Set meeting status changed callback function.
Source:
Parameters:
Name Type Description
meetingstatuscb function
Returns:
Type
Boolean

(inner) SetMeetingStatusCB(meetingstatuscb) → {Boolean}

Description:
  • Set meeting status changed callback function.
Source:
Parameters:
Name Type Description
meetingstatuscb function
Returns:
Type
Boolean

(inner) SetMeetingTopic(sTopic) → {Number}

Description:
  • Change the meeting topic.
Source:
Parameters:
Name Type Description
sTopic String The new meeting topic.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) SetMeetingTopic(sTopic) → {Number}

Description:
  • Change the meeting topic.
Source:
Parameters:
Name Type Description
sTopic String The new meeting topic.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) SetOnMeetingFullToWatchLiveStreamCB(onMeetingFullToWatchLiveStream) → {Boolean}

Description:
  • Set calback event that the meeting users have reached the meeting capacity.
Source:
Parameters:
Name Type Description
onMeetingFullToWatchLiveStream function
Returns:
Type
Boolean

(inner) SetOnMeetingFullToWatchLiveStreamCB(onMeetingFullToWatchLiveStream) → {Boolean}

Description:
  • Set calback event that the meeting users have reached the meeting capacity.
Source:
Parameters:
Name Type Description
onMeetingFullToWatchLiveStream function
Returns:
Type
Boolean

(inner) SetOnMeetingTopicChangedCB(onMeetingTopicChanged) → {Boolean}

Description:
  • Set callback event for the meeting topic changed.
Source:
Parameters:
Name Type Description
onMeetingTopicChanged function
Returns:
Type
Boolean

(inner) SetOnMeetingTopicChangedCB(onMeetingTopicChanged) → {Boolean}

Description:
  • Set callback event for the meeting topic changed.
Source:
Parameters:
Name Type Description
onMeetingTopicChanged function
Returns:
Type
Boolean

(inner) SetPipeName(videoPipeName, sharePipeName, audioPipeName, maxReadLength) → {Number}

Description:
  • Set Pipe Name.
Source:
Parameters:
Name Type Description
videoPipeName String
sharePipeName String
audioPipeName String
maxReadLength Number max value is 3840*2160
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) SetPipeName(videoPipeName, sharePipeName, audioPipeName, maxReadLength) → {Number}

Description:
  • Set Pipe Name.
Source:
Parameters:
Name Type Description
videoPipeName String
sharePipeName String
audioPipeName String
maxReadLength Number max value is 3840*2160
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) StartMeeting(meetingnum, directshareappwndhandle, customer_key, isvideooff, isaudiooff, isdirectsharedesktop) → {Number}

Description:
  • Start meeting.
Source:
Parameters:
Name Type Description
meetingnum Number A number to the meeting to be started.
directshareappwndhandle String Windows handle of which window you want to share directly (require hexadecimal)
customer_key String The customer key that need the app intergrated with sdk to specify. The SDK will set this value when the associated settings are turned on. The max length of customer_key is 35
isvideooff Boolean
isaudiooff Boolean
isdirectsharedesktop Boolean
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) StartMeeting(meetingnum, directshareappwndhandle, customer_key, isvideooff, isaudiooff, isdirectsharedesktop) → {Number}

Description:
  • Start meeting.
Source:
Parameters:
Name Type Description
meetingnum Number A number to the meeting to be started.
directshareappwndhandle String Windows handle of which window you want to share directly (require hexadecimal)
customer_key String The customer key that need the app intergrated with sdk to specify. The SDK will set this value when the associated settings are turned on. The max length of customer_key is 35
isvideooff Boolean
isaudiooff Boolean
isdirectsharedesktop Boolean
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) StartMeetingWithOutLogin(usertoken, zoomaccesstoken, username, zoomusertype, meetingnum, vanityid, directshareappwndhandle, customer_key, isdirectsharedesktop, isvideooff, isaudiooff) → {Number}

Description:
  • Start meeting without login
Source:
Parameters:
Name Type Description
usertoken String [Required] User token
zoomaccesstoken String [Required] Zoom access token
username String [Required] User Name
zoomusertype Number [Required] User type, See ZoomUserType in settings.js
meetingnum Number [Optinal] Meeting number, meetingnum or vanityid is Required
vanityid String [Optinal] vanityid is suffix of Personal Link, meetingnum or vanityid is Required
directshareappwndhandle Number [Optinal] The window handle of the direct sharing application (require hexadecimal)
customer_key String [Optinal] The customer key that need the app intergrated with sdk to specify. The SDK will set this value when the associated settings are turned on. The max length of customer_key is 35
isdirectsharedesktop Boolean [Optinal] Share the desktop directly or not. True indicates to share
isvideooff Boolean [Optinal] Turn off the video or not, True indicates to turn off. In addition, this flag is affected by meeting attributes
isaudiooff Boolean [Optinal] Turn off the audio or not, True indicates to turn off. In addition, this flag is affected by meeting attributes.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) StartMeetingWithOutLogin(usertoken, zoomaccesstoken, username, zoomusertype, meetingnum, vanityid, directshareappwndhandle, customer_key, isdirectsharedesktop, isvideooff, isaudiooff) → {Number}

Description:
  • Start meeting without login
Source:
Parameters:
Name Type Description
usertoken String [Required] User token
zoomaccesstoken String [Required] Zoom access token
username String [Required] User Name
zoomusertype Number [Required] User type, See ZoomUserType in settings.js
meetingnum Number [Optinal] Meeting number, meetingnum or vanityid is Required
vanityid String [Optinal] vanityid is suffix of Personal Link, meetingnum or vanityid is Required
directshareappwndhandle Number [Optinal] The window handle of the direct sharing application (require hexadecimal)
customer_key String [Optinal] The customer key that need the app intergrated with sdk to specify. The SDK will set this value when the associated settings are turned on. The max length of customer_key is 35
isdirectsharedesktop Boolean [Optinal] Share the desktop directly or not. True indicates to share
isvideooff Boolean [Optinal] Turn off the video or not, True indicates to turn off. In addition, this flag is affected by meeting attributes
isaudiooff Boolean [Optinal] Turn off the audio or not, True indicates to turn off. In addition, this flag is affected by meeting attributes.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) Un_lock_Meeting() → {Number}

Description:
  • Unlock the current meeting.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Un_lock_Meeting() → {Number}

Description:
  • Unlock the current meeting.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

Events

meetingstatuscb

Description:
  • Meeting status changed callback.
Source:
Parameters:
Name Type Description
meetingStatus String The value of meeting. Defined in: ZoomMeetingStatus
result String Detailed reasons for special meeting status. If the status is MEETING_STATUS_FAILED, the value of iResult is one of those listed in MeetingFailCode enum. If the status is MEETING_STATUS_ENDED, the value of iResult is one of those listed in MeetingEndReason.

meetingstatuscb

Description:
  • Meeting status changed callback.
Source:
Parameters:
Name Type Description
meetingStatus String The value of meeting. Defined in: ZoomMeetingStatus
result String Detailed reasons for special meeting status. If the status is MEETING_STATUS_FAILED, the value of iResult is one of those listed in MeetingFailCode enum. If the status is MEETING_STATUS_ENDED, the value of iResult is one of those listed in MeetingEndReason.

onMeetingFullToWatchLiveStream

Description:
  • Calback event that the meeting users have reached the meeting capacity. The new join user can not join meeting, but they can watch the meeting live stream.
Source:
Parameters:
Name Type Description
sLiveStreamUrl String The live stream URL to watch the meeting live stream.

onMeetingFullToWatchLiveStream

Description:
  • Calback event that the meeting users have reached the meeting capacity. The new join user can not join meeting, but they can watch the meeting live stream.
Source:
Parameters:
Name Type Description
sLiveStreamUrl String The live stream URL to watch the meeting live stream.

onMeetingParameterNotification

Description:
  • Meeting parameter notification callback. The callback will be triggered right before the meeting starts. The meeting_param will be destroyed once the function calls end.
Source:
Parameters:
Name Type Description
meeting_param Object Meeting parameter.

onMeetingParameterNotification

Description:
  • Meeting parameter notification callback. The callback will be triggered right before the meeting starts. The meeting_param will be destroyed once the function calls end.
Source:
Parameters:
Name Type Description
meeting_param Object Meeting parameter.

onMeetingStatisticsWarningNotification

Description:
  • Meeting statistics warning notification callback.
Source:
Parameters:
Name Type Description
type Number The warning type of the meeting statistics. Defined in: StatisticsWarningType

onMeetingStatisticsWarningNotification

Description:
  • Meeting statistics warning notification callback.
Source:
Parameters:
Name Type Description
type Number The warning type of the meeting statistics. Defined in: StatisticsWarningType

onMeetingTopicChanged

Description:
  • Callback event for the meeting topic changed.
Source:
Parameters:
Name Type Description
sTopic String The new meeting topic.

onMeetingTopicChanged

Description:
  • Callback event for the meeting topic changed.
Source:
Parameters:
Name Type Description
sTopic String The new meeting topic.
Zoom Meeting
Description:
  • Zoom Meeting
Source:
Parameters:
Name Type Description
meetingstatuscb function Meeting status changed callback.
Returns:
Type
ZoomMeeting
Description:
  • Zoom Meeting
Source:
Parameters:
Name Type Description
meetingstatuscb function Meeting status changed callback.
Returns:
Type
ZoomMeeting

Methods

(inner) CanSetMeetingTopic() → {Boolean}

Description:
  • Determine if the current user can change the meeting topic.
Source:
Returns:
If it can change the meeting topic, the return value is true.
Type
Boolean

(inner) CanSetMeetingTopic() → {Boolean}

Description:
  • Determine if the current user can change the meeting topic.
Source:
Returns:
If it can change the meeting topic, the return value is true.
Type
Boolean

(inner) GetAudioConnQuality() → {AudioConnQuality}

Description:
  • Get the Internet connection quality of audio. If you are not in the meeting, the Conn_Quality_Unknown will be returned.
Source:
Returns:
If the function succeed, the return is one of those enums Defined in: ConnectionQuality
Type
AudioConnQuality

(inner) GetAudioConnQuality() → {AudioConnQuality}

Description:
  • Get the Internet connection quality of audio. If you are not in the meeting, the Conn_Quality_Unknown will be returned.
Source:
Returns:
If the function succeed, the return is one of those enums Defined in: ConnectionQuality
Type
AudioConnQuality

(inner) GetSharingConnQuality() → {Number}

Description:
  • Get the quality of Internet connection when sharing. If you are not in the meeting, the Conn_Quality_Unknown will be returned.
Source:
Returns:
If the function succeed, the return is one of those enums Defined in: ConnectionQuality
Type
Number

(inner) GetSharingConnQuality() → {Number}

Description:
  • Get the quality of Internet connection when sharing. If you are not in the meeting, the Conn_Quality_Unknown will be returned.
Source:
Returns:
If the function succeed, the return is one of those enums Defined in: ConnectionQuality
Type
Number

(inner) GetVideoConnQuality() → {Number}

Description:
  • Get the Internet connection quality of video. If you are not in the meeting, the Conn_Quality_Unknown will be returned.
Source:
Returns:
If the function succeed, the return is one of those enums Defined in: ConnectionQuality
Type
Number

(inner) GetVideoConnQuality() → {Number}

Description:
  • Get the Internet connection quality of video. If you are not in the meeting, the Conn_Quality_Unknown will be returned.
Source:
Returns:
If the function succeed, the return is one of those enums Defined in: ConnectionQuality
Type
Number

(inner) HandleZoomWebUriProtocolAction(protocol_action) → {Number}

Description:
  • Join meeting with web uri
Source:
Parameters:
Name Type Description
protocol_action String
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) HandleZoomWebUriProtocolAction(protocol_action) → {Number}

Description:
  • Join meeting with web uri
Source:
Parameters:
Name Type Description
protocol_action String
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) JoinMeeting(meetingnum, vanityid, username, psw, directshareappwndhandle, customer_key, webinartoken, isvideooff, isaudiooff, isdirectsharedesktop, app_privilege_token, join_token) → {Number}

Description:
  • Join the meeting.
Source:
Parameters:
Name Type Description
meetingnum Number A number to the meeting to be joined, meetingnum or vanityid is Required
vanityid String vanityid is suffix of Personal Link, meetingnum or vanityid is Required
username String
psw String Meeting password
directshareappwndhandle Number Windows handle of which window you want to share directly (require hexadecimal)
customer_key String The customer key that need the app intergrated with sdk to specify. The SDK will set this value when the associated settings are turned on. The max length of customer_key is 35
webinartoken String webinar token
isvideooff Boolean
isaudiooff Boolean
isdirectsharedesktop Boolean
app_privilege_token String
join_token String
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) JoinMeeting(meetingnum, vanityid, username, psw, directshareappwndhandle, customer_key, webinartoken, isvideooff, isaudiooff, isdirectsharedesktop, app_privilege_token, join_token) → {Number}

Description:
  • Join the meeting.
Source:
Parameters:
Name Type Description
meetingnum Number A number to the meeting to be joined, meetingnum or vanityid is Required
vanityid String vanityid is suffix of Personal Link, meetingnum or vanityid is Required
username String
psw String Meeting password
directshareappwndhandle Number Windows handle of which window you want to share directly (require hexadecimal)
customer_key String The customer key that need the app intergrated with sdk to specify. The SDK will set this value when the associated settings are turned on. The max length of customer_key is 35
webinartoken String webinar token
isvideooff Boolean
isaudiooff Boolean
isdirectsharedesktop Boolean
app_privilege_token String
join_token String
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) JoinMeetingWithoutLogin(meetingnum, vanityid, username, psw, directshareappwndhandle:, toke4enfrocelogin, customer_key, webinartoken, isdirectsharedesktop, isvideooff, isaudiooff, app_privilege_token, join_token) → {Number}

Description:
  • Join meeting withoutlogin
Source:
Parameters:
Name Type Description
meetingnum Number [Required] Meeting Number, meetingnum or vanityid is Required
vanityid String [Optinal] vanityid is suffix of Personal Link, meetingnum or vanityid is Required
username String [Optinal] User Name
psw String [Optinal] Meeting password
directshareappwndhandle: Number [Optinal] The window handle of the direct sharing application (require hexadecimal)
toke4enfrocelogin String [Optinal] Use the token if the meeting required to login at first
customer_key String [Optinal] The customer key that need the app intergrated with sdk to specify. The SDK will set this value when the associated settings are turned on. The max length of customer_key is 35
webinartoken String [Optinal] Webinar token, if try to join webinar as a panelist
isdirectsharedesktop Boolean [Optinal] Share the desktop directly or not. True indicates to share
isvideooff Boolean [Optinal] Turn off the video or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
isaudiooff Boolean [Optinal] Turn off the audio or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
app_privilege_token String
join_token String
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) JoinMeetingWithoutLogin(meetingnum, vanityid, username, psw, directshareappwndhandle:, toke4enfrocelogin, customer_key, webinartoken, isdirectsharedesktop, isvideooff, isaudiooff, app_privilege_token, join_token) → {Number}

Description:
  • Join meeting withoutlogin
Source:
Parameters:
Name Type Description
meetingnum Number [Required] Meeting Number, meetingnum or vanityid is Required
vanityid String [Optinal] vanityid is suffix of Personal Link, meetingnum or vanityid is Required
username String [Optinal] User Name
psw String [Optinal] Meeting password
directshareappwndhandle: Number [Optinal] The window handle of the direct sharing application (require hexadecimal)
toke4enfrocelogin String [Optinal] Use the token if the meeting required to login at first
customer_key String [Optinal] The customer key that need the app intergrated with sdk to specify. The SDK will set this value when the associated settings are turned on. The max length of customer_key is 35
webinartoken String [Optinal] Webinar token, if try to join webinar as a panelist
isdirectsharedesktop Boolean [Optinal] Share the desktop directly or not. True indicates to share
isvideooff Boolean [Optinal] Turn off the video or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
isaudiooff Boolean [Optinal] Turn off the audio or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
app_privilege_token String
join_token String
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) LeaveMeeting(endMeeting) → {Number}

Description:
  • Leave meeting.
Source:
Parameters:
Name Type Description
endMeeting Boolean
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) LeaveMeeting(endMeeting) → {Number}

Description:
  • Leave meeting.
Source:
Parameters:
Name Type Description
endMeeting Boolean
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Lock_Meeting() → {Number}

Description:
  • Lock the current meeting.
Source:
Returns:
If the function succeed, the return value is the SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Lock_Meeting() → {Number}

Description:
  • Lock the current meeting.
Source:
Returns:
If the function succeed, the return value is the SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) SetMeetingParameterNotificationCB(onMeetingParameterNotification) → {Boolean}

Description:
  • Set meeting parameter notification callback function.
Source:
Parameters:
Name Type Description
onMeetingParameterNotification function
Returns:
Type
Boolean

(inner) SetMeetingParameterNotificationCB(onMeetingParameterNotification) → {Boolean}

Description:
  • Set meeting parameter notification callback function.
Source:
Parameters:
Name Type Description
onMeetingParameterNotification function
Returns:
Type
Boolean

(inner) SetMeetingStatisticsWarningNotificationCB(onMeetingStatisticsWarningNotification) → {Boolean}

Description:
  • Set meeting statistics warning notification callback function.
Source:
Parameters:
Name Type Description
onMeetingStatisticsWarningNotification function
Returns:
Type
Boolean

(inner) SetMeetingStatisticsWarningNotificationCB(onMeetingStatisticsWarningNotification) → {Boolean}

Description:
  • Set meeting statistics warning notification callback function.
Source:
Parameters:
Name Type Description
onMeetingStatisticsWarningNotification function
Returns:
Type
Boolean

(inner) SetMeetingStatusCB(meetingstatuscb) → {Boolean}

Description:
  • Set meeting status changed callback function.
Source:
Parameters:
Name Type Description
meetingstatuscb function
Returns:
Type
Boolean

(inner) SetMeetingStatusCB(meetingstatuscb) → {Boolean}

Description:
  • Set meeting status changed callback function.
Source:
Parameters:
Name Type Description
meetingstatuscb function
Returns:
Type
Boolean

(inner) SetMeetingTopic(sTopic) → {Number}

Description:
  • Change the meeting topic.
Source:
Parameters:
Name Type Description
sTopic String The new meeting topic.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) SetMeetingTopic(sTopic) → {Number}

Description:
  • Change the meeting topic.
Source:
Parameters:
Name Type Description
sTopic String The new meeting topic.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) SetOnMeetingFullToWatchLiveStreamCB(onMeetingFullToWatchLiveStream) → {Boolean}

Description:
  • Set calback event that the meeting users have reached the meeting capacity.
Source:
Parameters:
Name Type Description
onMeetingFullToWatchLiveStream function
Returns:
Type
Boolean

(inner) SetOnMeetingFullToWatchLiveStreamCB(onMeetingFullToWatchLiveStream) → {Boolean}

Description:
  • Set calback event that the meeting users have reached the meeting capacity.
Source:
Parameters:
Name Type Description
onMeetingFullToWatchLiveStream function
Returns:
Type
Boolean

(inner) SetOnMeetingTopicChangedCB(onMeetingTopicChanged) → {Boolean}

Description:
  • Set callback event for the meeting topic changed.
Source:
Parameters:
Name Type Description
onMeetingTopicChanged function
Returns:
Type
Boolean

(inner) SetOnMeetingTopicChangedCB(onMeetingTopicChanged) → {Boolean}

Description:
  • Set callback event for the meeting topic changed.
Source:
Parameters:
Name Type Description
onMeetingTopicChanged function
Returns:
Type
Boolean

(inner) SetPipeName(videoPipeName, sharePipeName, audioPipeName, maxReadLength) → {Number}

Description:
  • Set Pipe Name.
Source:
Parameters:
Name Type Description
videoPipeName String
sharePipeName String
audioPipeName String
maxReadLength Number max value is 3840*2160
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) SetPipeName(videoPipeName, sharePipeName, audioPipeName, maxReadLength) → {Number}

Description:
  • Set Pipe Name.
Source:
Parameters:
Name Type Description
videoPipeName String
sharePipeName String
audioPipeName String
maxReadLength Number max value is 3840*2160
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) StartMeeting(meetingnum, directshareappwndhandle, customer_key, isvideooff, isaudiooff, isdirectsharedesktop) → {Number}

Description:
  • Start meeting.
Source:
Parameters:
Name Type Description
meetingnum Number A number to the meeting to be started.
directshareappwndhandle String Windows handle of which window you want to share directly (require hexadecimal)
customer_key String The customer key that need the app intergrated with sdk to specify. The SDK will set this value when the associated settings are turned on. The max length of customer_key is 35
isvideooff Boolean
isaudiooff Boolean
isdirectsharedesktop Boolean
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) StartMeeting(meetingnum, directshareappwndhandle, customer_key, isvideooff, isaudiooff, isdirectsharedesktop) → {Number}

Description:
  • Start meeting.
Source:
Parameters:
Name Type Description
meetingnum Number A number to the meeting to be started.
directshareappwndhandle String Windows handle of which window you want to share directly (require hexadecimal)
customer_key String The customer key that need the app intergrated with sdk to specify. The SDK will set this value when the associated settings are turned on. The max length of customer_key is 35
isvideooff Boolean
isaudiooff Boolean
isdirectsharedesktop Boolean
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) StartMeetingWithOutLogin(usertoken, zoomaccesstoken, username, zoomusertype, meetingnum, vanityid, directshareappwndhandle, customer_key, isdirectsharedesktop, isvideooff, isaudiooff) → {Number}

Description:
  • Start meeting without login
Source:
Parameters:
Name Type Description
usertoken String [Required] User token
zoomaccesstoken String [Required] Zoom access token
username String [Required] User Name
zoomusertype Number [Required] User type, See ZoomUserType in settings.js
meetingnum Number [Optinal] Meeting number, meetingnum or vanityid is Required
vanityid String [Optinal] vanityid is suffix of Personal Link, meetingnum or vanityid is Required
directshareappwndhandle Number [Optinal] The window handle of the direct sharing application (require hexadecimal)
customer_key String [Optinal] The customer key that need the app intergrated with sdk to specify. The SDK will set this value when the associated settings are turned on. The max length of customer_key is 35
isdirectsharedesktop Boolean [Optinal] Share the desktop directly or not. True indicates to share
isvideooff Boolean [Optinal] Turn off the video or not, True indicates to turn off. In addition, this flag is affected by meeting attributes
isaudiooff Boolean [Optinal] Turn off the audio or not, True indicates to turn off. In addition, this flag is affected by meeting attributes.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) StartMeetingWithOutLogin(usertoken, zoomaccesstoken, username, zoomusertype, meetingnum, vanityid, directshareappwndhandle, customer_key, isdirectsharedesktop, isvideooff, isaudiooff) → {Number}

Description:
  • Start meeting without login
Source:
Parameters:
Name Type Description
usertoken String [Required] User token
zoomaccesstoken String [Required] Zoom access token
username String [Required] User Name
zoomusertype Number [Required] User type, See ZoomUserType in settings.js
meetingnum Number [Optinal] Meeting number, meetingnum or vanityid is Required
vanityid String [Optinal] vanityid is suffix of Personal Link, meetingnum or vanityid is Required
directshareappwndhandle Number [Optinal] The window handle of the direct sharing application (require hexadecimal)
customer_key String [Optinal] The customer key that need the app intergrated with sdk to specify. The SDK will set this value when the associated settings are turned on. The max length of customer_key is 35
isdirectsharedesktop Boolean [Optinal] Share the desktop directly or not. True indicates to share
isvideooff Boolean [Optinal] Turn off the video or not, True indicates to turn off. In addition, this flag is affected by meeting attributes
isaudiooff Boolean [Optinal] Turn off the audio or not, True indicates to turn off. In addition, this flag is affected by meeting attributes.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) Un_lock_Meeting() → {Number}

Description:
  • Unlock the current meeting.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Un_lock_Meeting() → {Number}

Description:
  • Unlock the current meeting.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

Events

meetingstatuscb

Description:
  • Meeting status changed callback.
Source:
Parameters:
Name Type Description
meetingStatus String The value of meeting. Defined in: ZoomMeetingStatus
result String Detailed reasons for special meeting status. If the status is MEETING_STATUS_FAILED, the value of iResult is one of those listed in MeetingFailCode enum. If the status is MEETING_STATUS_ENDED, the value of iResult is one of those listed in MeetingEndReason.

meetingstatuscb

Description:
  • Meeting status changed callback.
Source:
Parameters:
Name Type Description
meetingStatus String The value of meeting. Defined in: ZoomMeetingStatus
result String Detailed reasons for special meeting status. If the status is MEETING_STATUS_FAILED, the value of iResult is one of those listed in MeetingFailCode enum. If the status is MEETING_STATUS_ENDED, the value of iResult is one of those listed in MeetingEndReason.

onMeetingFullToWatchLiveStream

Description:
  • Calback event that the meeting users have reached the meeting capacity. The new join user can not join meeting, but they can watch the meeting live stream.
Source:
Parameters:
Name Type Description
sLiveStreamUrl String The live stream URL to watch the meeting live stream.

onMeetingFullToWatchLiveStream

Description:
  • Calback event that the meeting users have reached the meeting capacity. The new join user can not join meeting, but they can watch the meeting live stream.
Source:
Parameters:
Name Type Description
sLiveStreamUrl String The live stream URL to watch the meeting live stream.

onMeetingParameterNotification

Description:
  • Meeting parameter notification callback. The callback will be triggered right before the meeting starts. The meeting_param will be destroyed once the function calls end.
Source:
Parameters:
Name Type Description
meeting_param Object Meeting parameter.

onMeetingParameterNotification

Description:
  • Meeting parameter notification callback. The callback will be triggered right before the meeting starts. The meeting_param will be destroyed once the function calls end.
Source:
Parameters:
Name Type Description
meeting_param Object Meeting parameter.

onMeetingStatisticsWarningNotification

Description:
  • Meeting statistics warning notification callback.
Source:
Parameters:
Name Type Description
type Number The warning type of the meeting statistics. Defined in: StatisticsWarningType

onMeetingStatisticsWarningNotification

Description:
  • Meeting statistics warning notification callback.
Source:
Parameters:
Name Type Description
type Number The warning type of the meeting statistics. Defined in: StatisticsWarningType

onMeetingTopicChanged

Description:
  • Callback event for the meeting topic changed.
Source:
Parameters:
Name Type Description
sTopic String The new meeting topic.

onMeetingTopicChanged

Description:
  • Callback event for the meeting topic changed.
Source:
Parameters:
Name Type Description
sTopic String The new meeting topic.