zoom_meeting

Zoom Meeting

Description:

Zoom Meeting

Source:

zoom_meeting.js, line 63

Parameters:

Name	Type	Description
`meetingstatuscb`	function	Meeting status changed callback.

Returns:

Type: ZoomMeeting

Description:

Zoom Meeting

Source:

zoom_meeting.js, line 63

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:

zoom_meeting.js, line 586

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:

zoom_meeting.js, line 586

Returns:

If it can change the meeting topic, the return value is true.

Type: Boolean

(inner) GetAudioConnQuality(bSending) → {Number}

Description:

Get the Internet connection quality of audio.

Source:

zoom_meeting.js, line 644

Parameters:

Name	Type	Description
`bSending`	Boolean	TRUE indicates to get the connection quality of sending the audio. FALSE indicates to get the connection quality of receiving the audio.

Returns:

If the function succeeds, the return value is one of those enumerated in ConnectionQuality enum.

Type: Number

(inner) GetAudioConnQuality(bSending) → {Number}

Description:

Get the Internet connection quality of audio.

Source:

zoom_meeting.js, line 644

Parameters:

Name	Type	Description
`bSending`	Boolean	TRUE indicates to get the connection quality of sending the audio. FALSE indicates to get the connection quality of receiving the audio.

Returns:

If the function succeeds, the return value is one of those enumerated in ConnectionQuality enum.

Type: Number

(inner) GetSharingConnQuality(bSending) → {Number}

Description:

Get the quality of Internet connection when sharing.

Source:

zoom_meeting.js, line 618

Parameters:

Name	Type	Description
`bSending`	Boolean	TRUE indicates to get the connection quality of sending the sharing statistics. FALSE indicates to get the connection quality of receiving the sharing statistics.

Returns:

If the function succeeds, the return is one of those enumerated in ConnectionQuality enum.

Type: Number

(inner) GetSharingConnQuality(bSending) → {Number}

Description:

Get the quality of Internet connection when sharing.

Source:

zoom_meeting.js, line 618

Parameters:

Name	Type	Description
`bSending`	Boolean	TRUE indicates to get the connection quality of sending the sharing statistics. FALSE indicates to get the connection quality of receiving the sharing statistics.

Returns:

If the function succeeds, the return is one of those enumerated in ConnectionQuality enum.

Type: Number

(inner) GetVideoConnQuality(bSending) → {Number}

Description:

Get the Internet connection quality of video.

Source:

zoom_meeting.js, line 631

Parameters:

Name	Type	Description
`bSending`	Boolean	TRUE indicates to get the connection quality of sending the video. FALSE indicates to get the connection quality of receiving the video.

Returns:

If the function succeeds, the return is one of those enumerated in ConnectionQuality enum.

Type: Number

(inner) GetVideoConnQuality(bSending) → {Number}

Description:

Get the Internet connection quality of video.

Source:

zoom_meeting.js, line 631

Parameters:

Name	Type	Description
`bSending`	Boolean	TRUE indicates to get the connection quality of sending the video. FALSE indicates to get the connection quality of receiving the video.

Returns:

If the function succeeds, the return is one of those enumerated in ConnectionQuality enum.

Type: Number

(inner) HandleZoomWebUriProtocolAction(protocol_action) → {Number}

Description:

Join meeting with web uri

Source:

zoom_meeting.js, line 657

Parameters:

Name	Type	Description
`protocol_action`	String

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

(inner) HandleZoomWebUriProtocolAction(protocol_action) → {Number}

Description:

Join meeting with web uri

Source:

zoom_meeting.js, line 657

Parameters:

Name	Type	Description
`protocol_action`	String

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

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:

zoom_meeting.js, line 409

Parameters:

Name	Type	Description
`meetingnum`	Number	Meeting number, meetingnum or vanityid is Required
`vanityid`	String	Meeting vanity ID, meetingnum or vanityid is Required
`username`	String	Username when logged in the meeting
`psw`	String	Meeting password
`directshareappwndhandle`	Number	The window handle of the direct sharing application (require hexadecimal)
`customer_key`	String	The customer key that need the app integrated 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	Turn off the video or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`isaudiooff`	Boolean	Turn off the audio or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`isdirectsharedesktop`	Boolean	Share the desktop directly or not. True indicates to share
`app_privilege_token`	String	app_privilege_token
`join_token`	String	Join token

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

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:

zoom_meeting.js, line 409

Parameters:

Name	Type	Description
`meetingnum`	Number	Meeting number, meetingnum or vanityid is Required
`vanityid`	String	Meeting vanity ID, meetingnum or vanityid is Required
`username`	String	Username when logged in the meeting
`psw`	String	Meeting password
`directshareappwndhandle`	Number	The window handle of the direct sharing application (require hexadecimal)
`customer_key`	String	The customer key that need the app integrated 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	Turn off the video or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`isaudiooff`	Boolean	Turn off the audio or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`isdirectsharedesktop`	Boolean	Share the desktop directly or not. True indicates to share
`app_privilege_token`	String	app_privilege_token
`join_token`	String	Join token

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

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

Description:

Join meeting without login

Source:

zoom_meeting.js, line 473

Parameters:

Name	Type	Description
`meetingnum`	Number	[Required] Meeting Number, meetingnum or vanityid is Required
`vanityid`	String	[Optional] vanityid is suffix of Personal Link, meetingnum or vanityid is Required
`username`	String	[Optional] User Name
`psw`	String	[Optional] Meeting password
`directshareappwndhandle`	Number	[Optional] The window handle of the direct sharing application (require hexadecimal)
`userZAK`	String	[Optional] ZOOM access token
`customer_key`	String	[Optional] The customer key that need the app integrated 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	[Optional] Webinar token, if try to join webinar as a panelist
`isdirectsharedesktop`	Boolean	[Optional] Share the desktop directly or not. True indicates to share
`isvideooff`	Boolean	[Optional] Turn off the video or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`isaudiooff`	Boolean	[Optional] Turn off the audio or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`app_privilege_token`	String	App privilege token
`join_token`	String	Join token
`onBehalfToken`	String	On behalf token

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

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

Description:

Join meeting without login

Source:

zoom_meeting.js, line 473

Parameters:

Name	Type	Description
`meetingnum`	Number	[Required] Meeting Number, meetingnum or vanityid is Required
`vanityid`	String	[Optional] vanityid is suffix of Personal Link, meetingnum or vanityid is Required
`username`	String	[Optional] User Name
`psw`	String	[Optional] Meeting password
`directshareappwndhandle`	Number	[Optional] The window handle of the direct sharing application (require hexadecimal)
`userZAK`	String	[Optional] ZOOM access token
`customer_key`	String	[Optional] The customer key that need the app integrated 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	[Optional] Webinar token, if try to join webinar as a panelist
`isdirectsharedesktop`	Boolean	[Optional] Share the desktop directly or not. True indicates to share
`isvideooff`	Boolean	[Optional] Turn off the video or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`isaudiooff`	Boolean	[Optional] Turn off the audio or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`app_privilege_token`	String	App privilege token
`join_token`	String	Join token
`onBehalfToken`	String	On behalf token

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

(inner) LeaveMeeting(endMeeting) → {Number}

Description:

Leave meeting.

Source:

zoom_meeting.js, line 543

Parameters:

Name	Type	Description
`endMeeting`	Boolean

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

(inner) LeaveMeeting(endMeeting) → {Number}

Description:

Leave meeting.

Source:

zoom_meeting.js, line 543

Parameters:

Name	Type	Description
`endMeeting`	Boolean

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

(inner) Lock_Meeting() → {Number}

Description:

Lock the current meeting.

Source:

zoom_meeting.js, line 564

Returns:

If the function succeeds, the return value is the SDKERR_SUCCESS. Otherwise failed.

Type: Number

(inner) Lock_Meeting() → {Number}

Description:

Lock the current meeting.

Source:

zoom_meeting.js, line 564

Returns:

If the function succeeds, the return value is the SDKERR_SUCCESS. Otherwise failed.

Type: Number

(inner) SetMeetingParameterNotificationCB(onMeetingParameterNotification) → {Boolean}

Description:

Set onMeetingParameterNotification callback.

Source:

zoom_meeting.js, line 239

Parameters:

Name	Type	Description
`onMeetingParameterNotification`	function

Returns:

true or false

Type: Boolean

(inner) SetMeetingParameterNotificationCB(onMeetingParameterNotification) → {Boolean}

Description:

Set onMeetingParameterNotification callback.

Source:

zoom_meeting.js, line 239

Parameters:

Name	Type	Description
`onMeetingParameterNotification`	function

Returns:

true or false

Type: Boolean

(inner) SetMeetingStatisticsWarningNotificationCB(onMeetingStatisticsWarningNotification) → {Boolean}

Description:

Set onMeetingStatisticsWarningNotification callback.

Source:

zoom_meeting.js, line 226

Parameters:

Name	Type	Description
`onMeetingStatisticsWarningNotification`	function

Returns:

true or false

Type: Boolean

(inner) SetMeetingStatisticsWarningNotificationCB(onMeetingStatisticsWarningNotification) → {Boolean}

Description:

Set onMeetingStatisticsWarningNotification callback.

Source:

zoom_meeting.js, line 226

Parameters:

Name	Type	Description
`onMeetingStatisticsWarningNotification`	function

Returns:

true or false

Type: Boolean

(inner) SetMeetingStatusCB(meetingstatuscb) → {Boolean}

Description:

Set meetingstatuscb callback.

Source:

zoom_meeting.js, line 213

Parameters:

Name	Type	Description
`meetingstatuscb`	function

Returns:

true or false

Type: Boolean

(inner) SetMeetingStatusCB(meetingstatuscb) → {Boolean}

Description:

Set meetingstatuscb callback.

Source:

zoom_meeting.js, line 213

Parameters:

Name	Type	Description
`meetingstatuscb`	function

Returns:

true or false

Type: Boolean

(inner) SetMeetingTopic(sTopic) → {Number}

Description:

Change the meeting topic.

Source:

zoom_meeting.js, line 597

Parameters:

Name	Type	Description
`sTopic`	String	The new meeting topic.

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

(inner) SetMeetingTopic(sTopic) → {Number}

Description:

Change the meeting topic.

Source:

zoom_meeting.js, line 597

Parameters:

Name	Type	Description
`sTopic`	String	The new meeting topic.

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

(inner) SetOnMeetingFullToWatchLiveStreamCB(onMeetingFullToWatchLiveStream) → {Boolean}

Description:

Set onMeetingFullToWatchLiveStream callback.

Source:

zoom_meeting.js, line 265

Parameters:

Name	Type	Description
`onMeetingFullToWatchLiveStream`	function

Returns:

true or false

Type: Boolean

(inner) SetOnMeetingFullToWatchLiveStreamCB(onMeetingFullToWatchLiveStream) → {Boolean}

Description:

Set onMeetingFullToWatchLiveStream callback.

Source:

zoom_meeting.js, line 265

Parameters:

Name	Type	Description
`onMeetingFullToWatchLiveStream`	function

Returns:

true or false

Type: Boolean

(inner) SetOnMeetingTopicChangedCB(onMeetingTopicChanged) → {Boolean}

Description:

Set onMeetingTopicChanged callback.

Source:

zoom_meeting.js, line 252

Parameters:

Name	Type	Description
`onMeetingTopicChanged`	function

Returns:

true or false

Type: Boolean

(inner) SetOnMeetingTopicChangedCB(onMeetingTopicChanged) → {Boolean}

Description:

Set onMeetingTopicChanged callback.

Source:

zoom_meeting.js, line 252

Parameters:

Name	Type	Description
`onMeetingTopicChanged`	function

Returns:

true or false

Type: Boolean

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

Description:

Set Pipe Name.

Source:

zoom_meeting.js, line 278

Parameters:

Name	Type	Description
`videoPipeName`	String
`sharePipeName`	String
`audioPipeName`	String
`maxReadLength`	Number	max value is 3840*2160

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

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

Description:

Set Pipe Name.

Source:

zoom_meeting.js, line 278

Parameters:

Name	Type	Description
`videoPipeName`	String
`sharePipeName`	String
`audioPipeName`	String
`maxReadLength`	Number	max value is 3840*2160

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

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

Description:

Start meeting.

Source:

zoom_meeting.js, line 305

Parameters:

Name	Type	Description
`meetingnum`	Number	Meeting number
`directshareappwndhandle`	String	The window handle of the direct sharing application (require hexadecimal)
`customer_key`	String	The customer key that need the app integrated 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	Turn off video or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`isaudiooff`	Boolean	Turn off audio or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`isdirectsharedesktop`	Boolean	Share the desktop directly or not. True indicates to share

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

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

Description:

Start meeting.

Source:

zoom_meeting.js, line 305

Parameters:

Name	Type	Description
`meetingnum`	Number	Meeting number
`directshareappwndhandle`	String	The window handle of the direct sharing application (require hexadecimal)
`customer_key`	String	The customer key that need the app integrated 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	Turn off video or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`isaudiooff`	Boolean	Turn off audio or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`isdirectsharedesktop`	Boolean	Share the desktop directly or not. True indicates to share

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

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

Description:

Start meeting without login

Source:

zoom_meeting.js, line 351

Parameters:

Name	Type	Description
`zoomaccesstoken`	String	[Required] ZOOM access token
`username`	String	[Required] Username when logged in the meeting
`zoomusertype`	Number	[Required] User type, see ZoomUserType in settings.js
`meetingnum`	Number	[Optional] Meeting number, meetingnum or vanityid is Required
`vanityid`	String	[Optional] Meeting vanity ID, meetingnum or vanityid is Required
`directshareappwndhandle`	Number	[Optional] The window handle of the direct sharing application (require hexadecimal)
`customer_key`	String	[Optional] The customer key that need the app integrated 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	[Optional] Share the desktop directly or not. True indicates to share
`isvideooff`	Boolean	[Optional] Turn off the video or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`isaudiooff`	Boolean	[Optional] Turn off the audio or not. True indicates to turn off. In addition, this flag is affected by meeting attributes

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

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

Description:

Start meeting without login

Source:

zoom_meeting.js, line 351

Parameters:

Name	Type	Description
`zoomaccesstoken`	String	[Required] ZOOM access token
`username`	String	[Required] Username when logged in the meeting
`zoomusertype`	Number	[Required] User type, see ZoomUserType in settings.js
`meetingnum`	Number	[Optional] Meeting number, meetingnum or vanityid is Required
`vanityid`	String	[Optional] Meeting vanity ID, meetingnum or vanityid is Required
`directshareappwndhandle`	Number	[Optional] The window handle of the direct sharing application (require hexadecimal)
`customer_key`	String	[Optional] The customer key that need the app integrated 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	[Optional] Share the desktop directly or not. True indicates to share
`isvideooff`	Boolean	[Optional] Turn off the video or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`isaudiooff`	Boolean	[Optional] Turn off the audio or not. True indicates to turn off. In addition, this flag is affected by meeting attributes

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

(inner) Un_lock_Meeting() → {Number}

Description:

Unlock the current meeting.

Source:

zoom_meeting.js, line 575

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

(inner) Un_lock_Meeting() → {Number}

Description:

Unlock the current meeting.

Source:

zoom_meeting.js, line 575

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

Events

onMeetingFullToWatchLiveStream

Description:

Callback 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:

zoom_meeting.js, line 160

Parameters:

Name	Type	Description
`sLiveStreamUrl`	String	The live stream URL to watch the meeting live stream.

onMeetingFullToWatchLiveStream

Description:

Callback 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:

zoom_meeting.js, line 160

Parameters:

Name	Type	Description
`sLiveStreamUrl`	String	The live stream URL to watch the meeting live stream.

onMeetingParameterNotification

Description:

Meeting parameter notification callback.

Source:

zoom_meeting.js, line 121

Parameters:

Name	Type	Description
`meeting_param`	Object	Meeting parameter with the following properties: - meeting_type: Meeting type MeetingType - is_view_only: View only or not. True indicates to view only - is_auto_recording_local: Auto local recording or not. True indicates to auto local recording - is_auto_recording_cloud: Auto cloud recording or not. True indicates to auto cloud recording - meeting_number: Meeting number - meeting_topic: Meeting topic - meeting_host: Meeting host

onMeetingParameterNotification

Description:

Meeting parameter notification callback.

Source:

zoom_meeting.js, line 121

Parameters:

Name	Type	Description
`meeting_param`	Object	Meeting parameter with the following properties: - meeting_type: Meeting type MeetingType - is_view_only: View only or not. True indicates to view only - is_auto_recording_local: Auto local recording or not. True indicates to auto local recording - is_auto_recording_cloud: Auto cloud recording or not. True indicates to auto cloud recording - meeting_number: Meeting number - meeting_topic: Meeting topic - meeting_host: Meeting host

onMeetingStatisticsWarningNotification

Description:

Meeting statistics warning notification callback.

Source:

zoom_meeting.js, line 110

Parameters:

Name	Type	Description
`type`	Number	The warning type of the meeting statistics StatisticsWarningType

onMeetingStatisticsWarningNotification

Description:

Meeting statistics warning notification callback.

Source:

zoom_meeting.js, line 110

Parameters:

Name	Type	Description
`type`	Number	The warning type of the meeting statistics StatisticsWarningType

onMeetingStatusChanged

Description:

Meeting status changed callback.

Source:

zoom_meeting.js, line 80

Parameters:

Name	Type	Description
`status`	String	The value of meeting ZoomMeetingStatus
`result`	String	Detailed reasons for special meeting status. If the status is MEETING_STATUS_FAILED, the value of result is one of those listed in MeetingFailCode enum. If the status is MEETING_STATUS_ENDED, the value of result is one of those listed in MeetingEndReason.

onMeetingStatusChanged

Description:

Meeting status changed callback.

Source:

zoom_meeting.js, line 80

Parameters:

Name	Type	Description
`status`	String	The value of meeting ZoomMeetingStatus
`result`	String	Detailed reasons for special meeting status. If the status is MEETING_STATUS_FAILED, the value of result is one of those listed in MeetingFailCode enum. If the status is MEETING_STATUS_ENDED, the value of result is one of those listed in MeetingEndReason.

onMeetingTopicChanged

Description:

Callback event for the meeting topic changed.

Source:

zoom_meeting.js, line 149

Parameters:

Name	Type	Description
`sTopic`	String	The new meeting topic.

onMeetingTopicChanged

Description:

Callback event for the meeting topic changed.

Source:

zoom_meeting.js, line 149

Parameters:

Name	Type	Description
`sTopic`	String	The new meeting topic.

Zoom Meeting

Description:

Zoom Meeting

Source:

zoom_meeting.js, line 63

Parameters:

Name	Type	Description
`meetingstatuscb`	function	Meeting status changed callback.

Returns:

Type: ZoomMeeting

Description:

Zoom Meeting

Source:

zoom_meeting.js, line 63

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:

zoom_meeting.js, line 586

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:

zoom_meeting.js, line 586

Returns:

If it can change the meeting topic, the return value is true.

Type: Boolean

(inner) GetAudioConnQuality(bSending) → {Number}

Description:

Get the Internet connection quality of audio.

Source:

zoom_meeting.js, line 644

Parameters:

Name	Type	Description
`bSending`	Boolean	TRUE indicates to get the connection quality of sending the audio. FALSE indicates to get the connection quality of receiving the audio.

Returns:

If the function succeeds, the return value is one of those enumerated in ConnectionQuality enum.

Type: Number

(inner) GetAudioConnQuality(bSending) → {Number}

Description:

Get the Internet connection quality of audio.

Source:

zoom_meeting.js, line 644

Parameters:

Name	Type	Description
`bSending`	Boolean	TRUE indicates to get the connection quality of sending the audio. FALSE indicates to get the connection quality of receiving the audio.

Returns:

If the function succeeds, the return value is one of those enumerated in ConnectionQuality enum.

Type: Number

(inner) GetSharingConnQuality(bSending) → {Number}

Description:

Get the quality of Internet connection when sharing.

Source:

zoom_meeting.js, line 618

Parameters:

Name	Type	Description
`bSending`	Boolean	TRUE indicates to get the connection quality of sending the sharing statistics. FALSE indicates to get the connection quality of receiving the sharing statistics.

Returns:

If the function succeeds, the return is one of those enumerated in ConnectionQuality enum.

Type: Number

(inner) GetSharingConnQuality(bSending) → {Number}

Description:

Get the quality of Internet connection when sharing.

Source:

zoom_meeting.js, line 618

Parameters:

Name	Type	Description
`bSending`	Boolean	TRUE indicates to get the connection quality of sending the sharing statistics. FALSE indicates to get the connection quality of receiving the sharing statistics.

Returns:

If the function succeeds, the return is one of those enumerated in ConnectionQuality enum.

Type: Number

(inner) GetVideoConnQuality(bSending) → {Number}

Description:

Get the Internet connection quality of video.

Source:

zoom_meeting.js, line 631

Parameters:

Name	Type	Description
`bSending`	Boolean	TRUE indicates to get the connection quality of sending the video. FALSE indicates to get the connection quality of receiving the video.

Returns:

If the function succeeds, the return is one of those enumerated in ConnectionQuality enum.

Type: Number

(inner) GetVideoConnQuality(bSending) → {Number}

Description:

Get the Internet connection quality of video.

Source:

zoom_meeting.js, line 631

Parameters:

Name	Type	Description
`bSending`	Boolean	TRUE indicates to get the connection quality of sending the video. FALSE indicates to get the connection quality of receiving the video.

Returns:

If the function succeeds, the return is one of those enumerated in ConnectionQuality enum.

Type: Number

(inner) HandleZoomWebUriProtocolAction(protocol_action) → {Number}

Description:

Join meeting with web uri

Source:

zoom_meeting.js, line 657

Parameters:

Name	Type	Description
`protocol_action`	String

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

(inner) HandleZoomWebUriProtocolAction(protocol_action) → {Number}

Description:

Join meeting with web uri

Source:

zoom_meeting.js, line 657

Parameters:

Name	Type	Description
`protocol_action`	String

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

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:

zoom_meeting.js, line 409

Parameters:

Name	Type	Description
`meetingnum`	Number	Meeting number, meetingnum or vanityid is Required
`vanityid`	String	Meeting vanity ID, meetingnum or vanityid is Required
`username`	String	Username when logged in the meeting
`psw`	String	Meeting password
`directshareappwndhandle`	Number	The window handle of the direct sharing application (require hexadecimal)
`customer_key`	String	The customer key that need the app integrated 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	Turn off the video or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`isaudiooff`	Boolean	Turn off the audio or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`isdirectsharedesktop`	Boolean	Share the desktop directly or not. True indicates to share
`app_privilege_token`	String	app_privilege_token
`join_token`	String	Join token

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

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:

zoom_meeting.js, line 409

Parameters:

Name	Type	Description
`meetingnum`	Number	Meeting number, meetingnum or vanityid is Required
`vanityid`	String	Meeting vanity ID, meetingnum or vanityid is Required
`username`	String	Username when logged in the meeting
`psw`	String	Meeting password
`directshareappwndhandle`	Number	The window handle of the direct sharing application (require hexadecimal)
`customer_key`	String	The customer key that need the app integrated 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	Turn off the video or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`isaudiooff`	Boolean	Turn off the audio or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`isdirectsharedesktop`	Boolean	Share the desktop directly or not. True indicates to share
`app_privilege_token`	String	app_privilege_token
`join_token`	String	Join token

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

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

Description:

Join meeting without login

Source:

zoom_meeting.js, line 473

Parameters:

Name	Type	Description
`meetingnum`	Number	[Required] Meeting Number, meetingnum or vanityid is Required
`vanityid`	String	[Optional] vanityid is suffix of Personal Link, meetingnum or vanityid is Required
`username`	String	[Optional] User Name
`psw`	String	[Optional] Meeting password
`directshareappwndhandle`	Number	[Optional] The window handle of the direct sharing application (require hexadecimal)
`userZAK`	String	[Optional] ZOOM access token
`customer_key`	String	[Optional] The customer key that need the app integrated 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	[Optional] Webinar token, if try to join webinar as a panelist
`isdirectsharedesktop`	Boolean	[Optional] Share the desktop directly or not. True indicates to share
`isvideooff`	Boolean	[Optional] Turn off the video or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`isaudiooff`	Boolean	[Optional] Turn off the audio or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`app_privilege_token`	String	App privilege token
`join_token`	String	Join token
`onBehalfToken`	String	On behalf token

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

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

Description:

Join meeting without login

Source:

zoom_meeting.js, line 473

Parameters:

Name	Type	Description
`meetingnum`	Number	[Required] Meeting Number, meetingnum or vanityid is Required
`vanityid`	String	[Optional] vanityid is suffix of Personal Link, meetingnum or vanityid is Required
`username`	String	[Optional] User Name
`psw`	String	[Optional] Meeting password
`directshareappwndhandle`	Number	[Optional] The window handle of the direct sharing application (require hexadecimal)
`userZAK`	String	[Optional] ZOOM access token
`customer_key`	String	[Optional] The customer key that need the app integrated 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	[Optional] Webinar token, if try to join webinar as a panelist
`isdirectsharedesktop`	Boolean	[Optional] Share the desktop directly or not. True indicates to share
`isvideooff`	Boolean	[Optional] Turn off the video or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`isaudiooff`	Boolean	[Optional] Turn off the audio or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`app_privilege_token`	String	App privilege token
`join_token`	String	Join token
`onBehalfToken`	String	On behalf token

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

(inner) LeaveMeeting(endMeeting) → {Number}

Description:

Leave meeting.

Source:

zoom_meeting.js, line 543

Parameters:

Name	Type	Description
`endMeeting`	Boolean

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

(inner) LeaveMeeting(endMeeting) → {Number}

Description:

Leave meeting.

Source:

zoom_meeting.js, line 543

Parameters:

Name	Type	Description
`endMeeting`	Boolean

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

(inner) Lock_Meeting() → {Number}

Description:

Lock the current meeting.

Source:

zoom_meeting.js, line 564

Returns:

If the function succeeds, the return value is the SDKERR_SUCCESS. Otherwise failed.

Type: Number

(inner) Lock_Meeting() → {Number}

Description:

Lock the current meeting.

Source:

zoom_meeting.js, line 564

Returns:

If the function succeeds, the return value is the SDKERR_SUCCESS. Otherwise failed.

Type: Number

(inner) SetMeetingParameterNotificationCB(onMeetingParameterNotification) → {Boolean}

Description:

Set onMeetingParameterNotification callback.

Source:

zoom_meeting.js, line 239

Parameters:

Name	Type	Description
`onMeetingParameterNotification`	function

Returns:

true or false

Type: Boolean

(inner) SetMeetingParameterNotificationCB(onMeetingParameterNotification) → {Boolean}

Description:

Set onMeetingParameterNotification callback.

Source:

zoom_meeting.js, line 239

Parameters:

Name	Type	Description
`onMeetingParameterNotification`	function

Returns:

true or false

Type: Boolean

(inner) SetMeetingStatisticsWarningNotificationCB(onMeetingStatisticsWarningNotification) → {Boolean}

Description:

Set onMeetingStatisticsWarningNotification callback.

Source:

zoom_meeting.js, line 226

Parameters:

Name	Type	Description
`onMeetingStatisticsWarningNotification`	function

Returns:

true or false

Type: Boolean

(inner) SetMeetingStatisticsWarningNotificationCB(onMeetingStatisticsWarningNotification) → {Boolean}

Description:

Set onMeetingStatisticsWarningNotification callback.

Source:

zoom_meeting.js, line 226

Parameters:

Name	Type	Description
`onMeetingStatisticsWarningNotification`	function

Returns:

true or false

Type: Boolean

(inner) SetMeetingStatusCB(meetingstatuscb) → {Boolean}

Description:

Set meetingstatuscb callback.

Source:

zoom_meeting.js, line 213

Parameters:

Name	Type	Description
`meetingstatuscb`	function

Returns:

true or false

Type: Boolean

(inner) SetMeetingStatusCB(meetingstatuscb) → {Boolean}

Description:

Set meetingstatuscb callback.

Source:

zoom_meeting.js, line 213

Parameters:

Name	Type	Description
`meetingstatuscb`	function

Returns:

true or false

Type: Boolean

(inner) SetMeetingTopic(sTopic) → {Number}

Description:

Change the meeting topic.

Source:

zoom_meeting.js, line 597

Parameters:

Name	Type	Description
`sTopic`	String	The new meeting topic.

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

(inner) SetMeetingTopic(sTopic) → {Number}

Description:

Change the meeting topic.

Source:

zoom_meeting.js, line 597

Parameters:

Name	Type	Description
`sTopic`	String	The new meeting topic.

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

(inner) SetOnMeetingFullToWatchLiveStreamCB(onMeetingFullToWatchLiveStream) → {Boolean}

Description:

Set onMeetingFullToWatchLiveStream callback.

Source:

zoom_meeting.js, line 265

Parameters:

Name	Type	Description
`onMeetingFullToWatchLiveStream`	function

Returns:

true or false

Type: Boolean

(inner) SetOnMeetingFullToWatchLiveStreamCB(onMeetingFullToWatchLiveStream) → {Boolean}

Description:

Set onMeetingFullToWatchLiveStream callback.

Source:

zoom_meeting.js, line 265

Parameters:

Name	Type	Description
`onMeetingFullToWatchLiveStream`	function

Returns:

true or false

Type: Boolean

(inner) SetOnMeetingTopicChangedCB(onMeetingTopicChanged) → {Boolean}

Description:

Set onMeetingTopicChanged callback.

Source:

zoom_meeting.js, line 252

Parameters:

Name	Type	Description
`onMeetingTopicChanged`	function

Returns:

true or false

Type: Boolean

(inner) SetOnMeetingTopicChangedCB(onMeetingTopicChanged) → {Boolean}

Description:

Set onMeetingTopicChanged callback.

Source:

zoom_meeting.js, line 252

Parameters:

Name	Type	Description
`onMeetingTopicChanged`	function

Returns:

true or false

Type: Boolean

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

Description:

Set Pipe Name.

Source:

zoom_meeting.js, line 278

Parameters:

Name	Type	Description
`videoPipeName`	String
`sharePipeName`	String
`audioPipeName`	String
`maxReadLength`	Number	max value is 3840*2160

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

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

Description:

Set Pipe Name.

Source:

zoom_meeting.js, line 278

Parameters:

Name	Type	Description
`videoPipeName`	String
`sharePipeName`	String
`audioPipeName`	String
`maxReadLength`	Number	max value is 3840*2160

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

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

Description:

Start meeting.

Source:

zoom_meeting.js, line 305

Parameters:

Name	Type	Description
`meetingnum`	Number	Meeting number
`directshareappwndhandle`	String	The window handle of the direct sharing application (require hexadecimal)
`customer_key`	String	The customer key that need the app integrated 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	Turn off video or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`isaudiooff`	Boolean	Turn off audio or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`isdirectsharedesktop`	Boolean	Share the desktop directly or not. True indicates to share

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

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

Description:

Start meeting.

Source:

zoom_meeting.js, line 305

Parameters:

Name	Type	Description
`meetingnum`	Number	Meeting number
`directshareappwndhandle`	String	The window handle of the direct sharing application (require hexadecimal)
`customer_key`	String	The customer key that need the app integrated 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	Turn off video or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`isaudiooff`	Boolean	Turn off audio or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`isdirectsharedesktop`	Boolean	Share the desktop directly or not. True indicates to share

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

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

Description:

Start meeting without login

Source:

zoom_meeting.js, line 351

Parameters:

Name	Type	Description
`zoomaccesstoken`	String	[Required] ZOOM access token
`username`	String	[Required] Username when logged in the meeting
`zoomusertype`	Number	[Required] User type, see ZoomUserType in settings.js
`meetingnum`	Number	[Optional] Meeting number, meetingnum or vanityid is Required
`vanityid`	String	[Optional] Meeting vanity ID, meetingnum or vanityid is Required
`directshareappwndhandle`	Number	[Optional] The window handle of the direct sharing application (require hexadecimal)
`customer_key`	String	[Optional] The customer key that need the app integrated 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	[Optional] Share the desktop directly or not. True indicates to share
`isvideooff`	Boolean	[Optional] Turn off the video or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`isaudiooff`	Boolean	[Optional] Turn off the audio or not. True indicates to turn off. In addition, this flag is affected by meeting attributes

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

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

Description:

Start meeting without login

Source:

zoom_meeting.js, line 351

Parameters:

Name	Type	Description
`zoomaccesstoken`	String	[Required] ZOOM access token
`username`	String	[Required] Username when logged in the meeting
`zoomusertype`	Number	[Required] User type, see ZoomUserType in settings.js
`meetingnum`	Number	[Optional] Meeting number, meetingnum or vanityid is Required
`vanityid`	String	[Optional] Meeting vanity ID, meetingnum or vanityid is Required
`directshareappwndhandle`	Number	[Optional] The window handle of the direct sharing application (require hexadecimal)
`customer_key`	String	[Optional] The customer key that need the app integrated 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	[Optional] Share the desktop directly or not. True indicates to share
`isvideooff`	Boolean	[Optional] Turn off the video or not. True indicates to turn off. In addition, this flag is affected by meeting attributes
`isaudiooff`	Boolean	[Optional] Turn off the audio or not. True indicates to turn off. In addition, this flag is affected by meeting attributes

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

(inner) Un_lock_Meeting() → {Number}

Description:

Unlock the current meeting.

Source:

zoom_meeting.js, line 575

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

(inner) Un_lock_Meeting() → {Number}

Description:

Unlock the current meeting.

Source:

zoom_meeting.js, line 575

Returns:

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Type: Number

Events

onMeetingFullToWatchLiveStream

Description:

Callback 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:

zoom_meeting.js, line 160

Parameters:

Name	Type	Description
`sLiveStreamUrl`	String	The live stream URL to watch the meeting live stream.

onMeetingFullToWatchLiveStream

Description:

Callback 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:

zoom_meeting.js, line 160

Parameters:

Name	Type	Description
`sLiveStreamUrl`	String	The live stream URL to watch the meeting live stream.

onMeetingParameterNotification

Description:

Meeting parameter notification callback.

Source:

zoom_meeting.js, line 121

Parameters:

Name	Type	Description
`meeting_param`	Object	Meeting parameter with the following properties: - meeting_type: Meeting type MeetingType - is_view_only: View only or not. True indicates to view only - is_auto_recording_local: Auto local recording or not. True indicates to auto local recording - is_auto_recording_cloud: Auto cloud recording or not. True indicates to auto cloud recording - meeting_number: Meeting number - meeting_topic: Meeting topic - meeting_host: Meeting host

onMeetingParameterNotification

Description:

Meeting parameter notification callback.

Source:

zoom_meeting.js, line 121

Parameters:

Name	Type	Description
`meeting_param`	Object	Meeting parameter with the following properties: - meeting_type: Meeting type MeetingType - is_view_only: View only or not. True indicates to view only - is_auto_recording_local: Auto local recording or not. True indicates to auto local recording - is_auto_recording_cloud: Auto cloud recording or not. True indicates to auto cloud recording - meeting_number: Meeting number - meeting_topic: Meeting topic - meeting_host: Meeting host

onMeetingStatisticsWarningNotification

Description:

Meeting statistics warning notification callback.

Source:

zoom_meeting.js, line 110

Parameters:

Name	Type	Description
`type`	Number	The warning type of the meeting statistics StatisticsWarningType

onMeetingStatisticsWarningNotification

Description:

Meeting statistics warning notification callback.

Source:

zoom_meeting.js, line 110

Parameters:

Name	Type	Description
`type`	Number	The warning type of the meeting statistics StatisticsWarningType

onMeetingStatusChanged

Description:

Meeting status changed callback.

Source:

zoom_meeting.js, line 80

Parameters:

Name	Type	Description
`status`	String	The value of meeting ZoomMeetingStatus
`result`	String	Detailed reasons for special meeting status. If the status is MEETING_STATUS_FAILED, the value of result is one of those listed in MeetingFailCode enum. If the status is MEETING_STATUS_ENDED, the value of result is one of those listed in MeetingEndReason.

onMeetingStatusChanged

Description:

Meeting status changed callback.

Source:

zoom_meeting.js, line 80

Parameters:

Name	Type	Description
`status`	String	The value of meeting ZoomMeetingStatus
`result`	String	Detailed reasons for special meeting status. If the status is MEETING_STATUS_FAILED, the value of result is one of those listed in MeetingFailCode enum. If the status is MEETING_STATUS_ENDED, the value of result is one of those listed in MeetingEndReason.

onMeetingTopicChanged

Description:

Callback event for the meeting topic changed.

Source:

zoom_meeting.js, line 149

Parameters:

Name	Type	Description
`sTopic`	String	The new meeting topic.

onMeetingTopicChanged

Description:

Callback event for the meeting topic changed.

Source:

zoom_meeting.js, line 149

Parameters:

Name	Type	Description
`sTopic`	String	The new meeting topic.