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) CanShowPanel() → {Boolean}

Description:
  • Check if the app signal panel can be shown.
Source:
Returns:
true if the app signal panel can be shown, false otherwise.
Type
Boolean

(inner) CanShowPanel() → {Boolean}

Description:
  • Check if the app signal panel can be shown.
Source:
Returns:
true if the app signal panel can be shown, false otherwise.
Type
Boolean

(inner) GetAudioConnQuality(bSending) → {Number}

Description:
  • Get the Internet connection quality of audio.
Source:
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:
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) GetMeetingAudioStatisticInfo() → {Object}

Description:
  • Get meeting audio statistics information.
Source:
Returns:
If the function succeeds, the return value is an object with properties: - sendFrequency: This meeting's sent audio frequency in kilohertz (KHz) - sendBandwidth: This meeting's sent band width of audio - sendRTT: This meeting's sent audio rtt - sendJitter: This meeting's sent audio jitter - sendPacketLossAvg: This meeting's average of send audio packet loss - sendPacketLossMax: This meeting's maximum send audio packet loss - recvFrequency: This meeting's received audio frequency in kilohertz (KHz) - recvBandwidth: This meeting's received band width of audio - recvRTT: This meeting's received audio rtt - recvJitter: This meeting's received audio jitter - recvPacketLossAvg: This meeting's average of received audio packet loss - recvPacketLossMax: This meeting's maximum received audio packet loss
Type
Object

(inner) GetMeetingAudioStatisticInfo() → {Object}

Description:
  • Get meeting audio statistics information.
Source:
Returns:
If the function succeeds, the return value is an object with properties: - sendFrequency: This meeting's sent audio frequency in kilohertz (KHz) - sendBandwidth: This meeting's sent band width of audio - sendRTT: This meeting's sent audio rtt - sendJitter: This meeting's sent audio jitter - sendPacketLossAvg: This meeting's average of send audio packet loss - sendPacketLossMax: This meeting's maximum send audio packet loss - recvFrequency: This meeting's received audio frequency in kilohertz (KHz) - recvBandwidth: This meeting's received band width of audio - recvRTT: This meeting's received audio rtt - recvJitter: This meeting's received audio jitter - recvPacketLossAvg: This meeting's average of received audio packet loss - recvPacketLossMax: This meeting's maximum received audio packet loss
Type
Object

(inner) GetMeetingShareStatisticInfo() → {Object}

Description:
  • Get meeting share statistics information.
Source:
Returns:
If the function succeeds, the return value is an object with properties: - sendBandwidth: This meeting's sent band-width for video or sharing - sendFps: This meeting's sent frame rate for video or sharing - sendRTT: This meeting's sent video or sharing rtt data - sendJitter: This meeting's sent video or sharing jitter data - sendResolution: This meeting's sent video or sharing resolution. HIWORD->height, LOWORD->width - sendPacketLossAvg: This meeting's average video or sharing packet loss for sent data - sendPacketLossMax: This meeting's maximum video or sharing packet loss for sent data - recvBandwidth: This meeting's received band-width for video or sharing - recvFps: This meeting's received frame rate for video or sharing - recvRTT: This meeting's received video or sharing rtt data - recvJitter: This meeting's received video or sharing jitter data - recvResolution: This meeting's received video or sharing resolution. HIWORD->height, LOWORD->width - recvPacketLossAvg: This meeting's average video or sharing packet loss for received data - recvPacketLossMax: This meeting's maximum video or sharing packet loss for received data
Type
Object

(inner) GetMeetingShareStatisticInfo() → {Object}

Description:
  • Get meeting share statistics information.
Source:
Returns:
If the function succeeds, the return value is an object with properties: - sendBandwidth: This meeting's sent band-width for video or sharing - sendFps: This meeting's sent frame rate for video or sharing - sendRTT: This meeting's sent video or sharing rtt data - sendJitter: This meeting's sent video or sharing jitter data - sendResolution: This meeting's sent video or sharing resolution. HIWORD->height, LOWORD->width - sendPacketLossAvg: This meeting's average video or sharing packet loss for sent data - sendPacketLossMax: This meeting's maximum video or sharing packet loss for sent data - recvBandwidth: This meeting's received band-width for video or sharing - recvFps: This meeting's received frame rate for video or sharing - recvRTT: This meeting's received video or sharing rtt data - recvJitter: This meeting's received video or sharing jitter data - recvResolution: This meeting's received video or sharing resolution. HIWORD->height, LOWORD->width - recvPacketLossAvg: This meeting's average video or sharing packet loss for received data - recvPacketLossMax: This meeting's maximum video or sharing packet loss for received data
Type
Object

(inner) GetMeetingVideoStatisticInfo() → {Object}

Description:
  • Get meeting video statistics information.
Source:
Returns:
If the function succeeds, the return value is an object with properties: - sendBandwidth: This meeting's sent band-width for video or sharing - sendFps: This meeting's sent frame rate for video or sharing - sendRTT: This meeting's sent video or sharing rtt data - sendJitter: This meeting's sent video or sharing jitter data - sendResolution: This meeting's sent video or sharing resolution. HIWORD->height, LOWORD->width - sendPacketLossAvg: This meeting's average video or sharing packet loss for sent data - sendPacketLossMax: This meeting's maximum video or sharing packet loss for sent data - recvBandwidth: This meeting's received band-width for video or sharing - recvFps: This meeting's received frame rate for video or sharing - recvRTT: This meeting's received video or sharing rtt data - recvJitter: This meeting's received video or sharing jitter data - recvResolution: This meeting's received video or sharing resolution. HIWORD->height, LOWORD->width - recvPacketLossAvg: This meeting's average video or sharing packet loss for received data - recvPacketLossMax: This meeting's maximum video or sharing packet loss for received data
Type
Object

(inner) GetMeetingVideoStatisticInfo() → {Object}

Description:
  • Get meeting video statistics information.
Source:
Returns:
If the function succeeds, the return value is an object with properties: - sendBandwidth: This meeting's sent band-width for video or sharing - sendFps: This meeting's sent frame rate for video or sharing - sendRTT: This meeting's sent video or sharing rtt data - sendJitter: This meeting's sent video or sharing jitter data - sendResolution: This meeting's sent video or sharing resolution. HIWORD->height, LOWORD->width - sendPacketLossAvg: This meeting's average video or sharing packet loss for sent data - sendPacketLossMax: This meeting's maximum video or sharing packet loss for sent data - recvBandwidth: This meeting's received band-width for video or sharing - recvFps: This meeting's received frame rate for video or sharing - recvRTT: This meeting's received video or sharing rtt data - recvJitter: This meeting's received video or sharing jitter data - recvResolution: This meeting's received video or sharing resolution. HIWORD->height, LOWORD->width - recvPacketLossAvg: This meeting's average video or sharing packet loss for received data - recvPacketLossMax: This meeting's maximum video or sharing packet loss for received data
Type
Object

(inner) GetSharingConnQuality(bSending) → {Number}

Description:
  • Get the quality of Internet connection when sharing.
Source:
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:
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:
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:
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:
Parameters:
Name Type Description
protocol_action String
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
Type
Number

(inner) HidePanel() → {Number}

Description:
  • Hide the app signal panel window.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
Type
Number

(inner) HidePanel() → {Number}

Description:
  • Hide the app signal panel window.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
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 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, this function returns an error.
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 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, this function returns an error.
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:
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, this function returns an error.
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:
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, this function returns an error.
Type
Number

(inner) LeaveMeeting(endMeeting) → {Number}

Description:
  • Leave meeting.
Source:
Parameters:
Name Type Description
endMeeting Boolean
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
Type
Number

(inner) LeaveMeeting(endMeeting) → {Number}

Description:
  • Leave meeting.
Source:
Parameters:
Name Type Description
endMeeting Boolean
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
Type
Number

(inner) Lock_Meeting() → {Number}

Description:
  • Lock the current meeting.
Source:
Returns:
If the function succeeds, the return value is the SDKERR_SUCCESS. Otherwise, this function returns an error.
Type
Number

(inner) Lock_Meeting() → {Number}

Description:
  • Lock the current meeting.
Source:
Returns:
If the function succeeds, the return value is the SDKERR_SUCCESS. Otherwise, this function returns an error.
Type
Number

(inner) SetMeetingParameterNotificationCB(onMeetingParameterNotification) → {Boolean}

Description:
  • Set onMeetingParameterNotification callback.
Source:
Parameters:
Name Type Description
onMeetingParameterNotification function
Returns:
true or false
Type
Boolean

(inner) SetMeetingParameterNotificationCB(onMeetingParameterNotification) → {Boolean}

Description:
  • Set onMeetingParameterNotification callback.
Source:
Parameters:
Name Type Description
onMeetingParameterNotification function
Returns:
true or false
Type
Boolean

(inner) SetMeetingStatisticsWarningNotificationCB(onMeetingStatisticsWarningNotification) → {Boolean}

Description:
  • Set onMeetingStatisticsWarningNotification callback.
Source:
Parameters:
Name Type Description
onMeetingStatisticsWarningNotification function
Returns:
true or false
Type
Boolean

(inner) SetMeetingStatisticsWarningNotificationCB(onMeetingStatisticsWarningNotification) → {Boolean}

Description:
  • Set onMeetingStatisticsWarningNotification callback.
Source:
Parameters:
Name Type Description
onMeetingStatisticsWarningNotification function
Returns:
true or false
Type
Boolean

(inner) SetMeetingStatusCB(meetingstatuscb) → {Boolean}

Description:
  • Set meetingstatuscb callback.
Source:
Parameters:
Name Type Description
meetingstatuscb function
Returns:
true or false
Type
Boolean

(inner) SetMeetingStatusCB(meetingstatuscb) → {Boolean}

Description:
  • Set meetingstatuscb callback.
Source:
Parameters:
Name Type Description
meetingstatuscb function
Returns:
true or false
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
Type
Number

(inner) SetOnAppSignalPanelUpdatedCB(onAppSignalPanelUpdated) → {Boolean}

Description:
  • Set onAppSignalPanelUpdated callback.
Source:
Parameters:
Name Type Description
onAppSignalPanelUpdated function
Returns:
true or false
Type
Boolean

(inner) SetOnAppSignalPanelUpdatedCB(onAppSignalPanelUpdated) → {Boolean}

Description:
  • Set onAppSignalPanelUpdated callback.
Source:
Parameters:
Name Type Description
onAppSignalPanelUpdated function
Returns:
true or false
Type
Boolean

(inner) SetOnMeetingFullToWatchLiveStreamCB(onMeetingFullToWatchLiveStream) → {Boolean}

Description:
  • Set onMeetingFullToWatchLiveStream callback.
Source:
Parameters:
Name Type Description
onMeetingFullToWatchLiveStream function
Returns:
true or false
Type
Boolean

(inner) SetOnMeetingFullToWatchLiveStreamCB(onMeetingFullToWatchLiveStream) → {Boolean}

Description:
  • Set onMeetingFullToWatchLiveStream callback.
Source:
Parameters:
Name Type Description
onMeetingFullToWatchLiveStream function
Returns:
true or false
Type
Boolean

(inner) SetOnMeetingTopicChangedCB(onMeetingTopicChanged) → {Boolean}

Description:
  • Set onMeetingTopicChanged callback.
Source:
Parameters:
Name Type Description
onMeetingTopicChanged function
Returns:
true or false
Type
Boolean

(inner) SetOnMeetingTopicChangedCB(onMeetingTopicChanged) → {Boolean}

Description:
  • Set onMeetingTopicChanged callback.
Source:
Parameters:
Name Type Description
onMeetingTopicChanged function
Returns:
true or false
Type
Boolean

(inner) SetOnUserNetworkStatusChangedCB(onUserNetworkStatusChanged) → {Boolean}

Description:
  • Set onUserNetworkStatusChanged callback.
Source:
Parameters:
Name Type Description
onUserNetworkStatusChanged function
Returns:
true or false
Type
Boolean

(inner) SetOnUserNetworkStatusChangedCB(onUserNetworkStatusChanged) → {Boolean}

Description:
  • Set onUserNetworkStatusChanged callback.
Source:
Parameters:
Name Type Description
onUserNetworkStatusChanged function
Returns:
true or false
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
Type
Number

(inner) ShowPanel(x, y, windowID) → {Number}

Description:
  • Show the app signal panel window.
Source:
Parameters:
Name Type Description
x Number The horizontal coordinate value.
y Number The vertical coordinate value.
windowID Number Only support for MAC platform.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
Type
Number

(inner) ShowPanel(x, y, windowID) → {Number}

Description:
  • Show the app signal panel window.
Source:
Parameters:
Name Type Description
x Number The horizontal coordinate value.
y Number The vertical coordinate value.
windowID Number Only support for MAC platform.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
Type
Number

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

Description:
  • Start meeting.
Source:
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, this function returns an error.
Type
Number

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

Description:
  • Start meeting.
Source:
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, this function returns an error.
Type
Number

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

Description:
  • Start meeting without login
Source:
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, this function returns an error.
Type
Number

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

Description:
  • Start meeting without login
Source:
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, this function returns an error.
Type
Number

(inner) Un_lock_Meeting() → {Number}

Description:
  • Unlock the current meeting.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
Type
Number

(inner) Un_lock_Meeting() → {Number}

Description:
  • Unlock the current meeting.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
Type
Number

Events

onAppSignalPanelUpdated

Description:
  • Callback event when the app signal panel is updated.
Source:

onAppSignalPanelUpdated

Description:
  • Callback event when the app signal panel is updated.
Source:

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:
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:
Parameters:
Name Type Description
sLiveStreamUrl String The live stream URL to watch the meeting live stream.

onMeetingParameterNotification

Description:
  • Meeting parameter notification callback.
Source:
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:
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:
Parameters:
Name Type Description
type Number The warning type of the meeting statistics StatisticsWarningType

onMeetingStatisticsWarningNotification

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

onMeetingStatusChanged

Description:
  • Meeting status changed callback.
Source:
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:
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:
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.

onUserNetworkStatusChanged

Description:
  • Called when the user's share network quality changes.
Source:
Parameters:
Name Type Description
type Number The data type whose network quality changed.
level Number The new network quality level for the specified data type.
userId Number The user whose network quality changed.
uplink Boolean This data is uplink or downlink.

onUserNetworkStatusChanged

Description:
  • Called when the user's share network quality changes.
Source:
Parameters:
Name Type Description
type Number The data type whose network quality changed.
level Number The new network quality level for the specified data type.
userId Number The user whose network quality changed.
uplink Boolean This data is uplink or downlink.
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) CanShowPanel() → {Boolean}

Description:
  • Check if the app signal panel can be shown.
Source:
Returns:
true if the app signal panel can be shown, false otherwise.
Type
Boolean

(inner) CanShowPanel() → {Boolean}

Description:
  • Check if the app signal panel can be shown.
Source:
Returns:
true if the app signal panel can be shown, false otherwise.
Type
Boolean

(inner) GetAudioConnQuality(bSending) → {Number}

Description:
  • Get the Internet connection quality of audio.
Source:
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:
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) GetMeetingAudioStatisticInfo() → {Object}

Description:
  • Get meeting audio statistics information.
Source:
Returns:
If the function succeeds, the return value is an object with properties: - sendFrequency: This meeting's sent audio frequency in kilohertz (KHz) - sendBandwidth: This meeting's sent band width of audio - sendRTT: This meeting's sent audio rtt - sendJitter: This meeting's sent audio jitter - sendPacketLossAvg: This meeting's average of send audio packet loss - sendPacketLossMax: This meeting's maximum send audio packet loss - recvFrequency: This meeting's received audio frequency in kilohertz (KHz) - recvBandwidth: This meeting's received band width of audio - recvRTT: This meeting's received audio rtt - recvJitter: This meeting's received audio jitter - recvPacketLossAvg: This meeting's average of received audio packet loss - recvPacketLossMax: This meeting's maximum received audio packet loss
Type
Object

(inner) GetMeetingAudioStatisticInfo() → {Object}

Description:
  • Get meeting audio statistics information.
Source:
Returns:
If the function succeeds, the return value is an object with properties: - sendFrequency: This meeting's sent audio frequency in kilohertz (KHz) - sendBandwidth: This meeting's sent band width of audio - sendRTT: This meeting's sent audio rtt - sendJitter: This meeting's sent audio jitter - sendPacketLossAvg: This meeting's average of send audio packet loss - sendPacketLossMax: This meeting's maximum send audio packet loss - recvFrequency: This meeting's received audio frequency in kilohertz (KHz) - recvBandwidth: This meeting's received band width of audio - recvRTT: This meeting's received audio rtt - recvJitter: This meeting's received audio jitter - recvPacketLossAvg: This meeting's average of received audio packet loss - recvPacketLossMax: This meeting's maximum received audio packet loss
Type
Object

(inner) GetMeetingShareStatisticInfo() → {Object}

Description:
  • Get meeting share statistics information.
Source:
Returns:
If the function succeeds, the return value is an object with properties: - sendBandwidth: This meeting's sent band-width for video or sharing - sendFps: This meeting's sent frame rate for video or sharing - sendRTT: This meeting's sent video or sharing rtt data - sendJitter: This meeting's sent video or sharing jitter data - sendResolution: This meeting's sent video or sharing resolution. HIWORD->height, LOWORD->width - sendPacketLossAvg: This meeting's average video or sharing packet loss for sent data - sendPacketLossMax: This meeting's maximum video or sharing packet loss for sent data - recvBandwidth: This meeting's received band-width for video or sharing - recvFps: This meeting's received frame rate for video or sharing - recvRTT: This meeting's received video or sharing rtt data - recvJitter: This meeting's received video or sharing jitter data - recvResolution: This meeting's received video or sharing resolution. HIWORD->height, LOWORD->width - recvPacketLossAvg: This meeting's average video or sharing packet loss for received data - recvPacketLossMax: This meeting's maximum video or sharing packet loss for received data
Type
Object

(inner) GetMeetingShareStatisticInfo() → {Object}

Description:
  • Get meeting share statistics information.
Source:
Returns:
If the function succeeds, the return value is an object with properties: - sendBandwidth: This meeting's sent band-width for video or sharing - sendFps: This meeting's sent frame rate for video or sharing - sendRTT: This meeting's sent video or sharing rtt data - sendJitter: This meeting's sent video or sharing jitter data - sendResolution: This meeting's sent video or sharing resolution. HIWORD->height, LOWORD->width - sendPacketLossAvg: This meeting's average video or sharing packet loss for sent data - sendPacketLossMax: This meeting's maximum video or sharing packet loss for sent data - recvBandwidth: This meeting's received band-width for video or sharing - recvFps: This meeting's received frame rate for video or sharing - recvRTT: This meeting's received video or sharing rtt data - recvJitter: This meeting's received video or sharing jitter data - recvResolution: This meeting's received video or sharing resolution. HIWORD->height, LOWORD->width - recvPacketLossAvg: This meeting's average video or sharing packet loss for received data - recvPacketLossMax: This meeting's maximum video or sharing packet loss for received data
Type
Object

(inner) GetMeetingVideoStatisticInfo() → {Object}

Description:
  • Get meeting video statistics information.
Source:
Returns:
If the function succeeds, the return value is an object with properties: - sendBandwidth: This meeting's sent band-width for video or sharing - sendFps: This meeting's sent frame rate for video or sharing - sendRTT: This meeting's sent video or sharing rtt data - sendJitter: This meeting's sent video or sharing jitter data - sendResolution: This meeting's sent video or sharing resolution. HIWORD->height, LOWORD->width - sendPacketLossAvg: This meeting's average video or sharing packet loss for sent data - sendPacketLossMax: This meeting's maximum video or sharing packet loss for sent data - recvBandwidth: This meeting's received band-width for video or sharing - recvFps: This meeting's received frame rate for video or sharing - recvRTT: This meeting's received video or sharing rtt data - recvJitter: This meeting's received video or sharing jitter data - recvResolution: This meeting's received video or sharing resolution. HIWORD->height, LOWORD->width - recvPacketLossAvg: This meeting's average video or sharing packet loss for received data - recvPacketLossMax: This meeting's maximum video or sharing packet loss for received data
Type
Object

(inner) GetMeetingVideoStatisticInfo() → {Object}

Description:
  • Get meeting video statistics information.
Source:
Returns:
If the function succeeds, the return value is an object with properties: - sendBandwidth: This meeting's sent band-width for video or sharing - sendFps: This meeting's sent frame rate for video or sharing - sendRTT: This meeting's sent video or sharing rtt data - sendJitter: This meeting's sent video or sharing jitter data - sendResolution: This meeting's sent video or sharing resolution. HIWORD->height, LOWORD->width - sendPacketLossAvg: This meeting's average video or sharing packet loss for sent data - sendPacketLossMax: This meeting's maximum video or sharing packet loss for sent data - recvBandwidth: This meeting's received band-width for video or sharing - recvFps: This meeting's received frame rate for video or sharing - recvRTT: This meeting's received video or sharing rtt data - recvJitter: This meeting's received video or sharing jitter data - recvResolution: This meeting's received video or sharing resolution. HIWORD->height, LOWORD->width - recvPacketLossAvg: This meeting's average video or sharing packet loss for received data - recvPacketLossMax: This meeting's maximum video or sharing packet loss for received data
Type
Object

(inner) GetSharingConnQuality(bSending) → {Number}

Description:
  • Get the quality of Internet connection when sharing.
Source:
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:
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:
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:
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:
Parameters:
Name Type Description
protocol_action String
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
Type
Number

(inner) HidePanel() → {Number}

Description:
  • Hide the app signal panel window.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
Type
Number

(inner) HidePanel() → {Number}

Description:
  • Hide the app signal panel window.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
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 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, this function returns an error.
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 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, this function returns an error.
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:
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, this function returns an error.
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:
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, this function returns an error.
Type
Number

(inner) LeaveMeeting(endMeeting) → {Number}

Description:
  • Leave meeting.
Source:
Parameters:
Name Type Description
endMeeting Boolean
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
Type
Number

(inner) LeaveMeeting(endMeeting) → {Number}

Description:
  • Leave meeting.
Source:
Parameters:
Name Type Description
endMeeting Boolean
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
Type
Number

(inner) Lock_Meeting() → {Number}

Description:
  • Lock the current meeting.
Source:
Returns:
If the function succeeds, the return value is the SDKERR_SUCCESS. Otherwise, this function returns an error.
Type
Number

(inner) Lock_Meeting() → {Number}

Description:
  • Lock the current meeting.
Source:
Returns:
If the function succeeds, the return value is the SDKERR_SUCCESS. Otherwise, this function returns an error.
Type
Number

(inner) SetMeetingParameterNotificationCB(onMeetingParameterNotification) → {Boolean}

Description:
  • Set onMeetingParameterNotification callback.
Source:
Parameters:
Name Type Description
onMeetingParameterNotification function
Returns:
true or false
Type
Boolean

(inner) SetMeetingParameterNotificationCB(onMeetingParameterNotification) → {Boolean}

Description:
  • Set onMeetingParameterNotification callback.
Source:
Parameters:
Name Type Description
onMeetingParameterNotification function
Returns:
true or false
Type
Boolean

(inner) SetMeetingStatisticsWarningNotificationCB(onMeetingStatisticsWarningNotification) → {Boolean}

Description:
  • Set onMeetingStatisticsWarningNotification callback.
Source:
Parameters:
Name Type Description
onMeetingStatisticsWarningNotification function
Returns:
true or false
Type
Boolean

(inner) SetMeetingStatisticsWarningNotificationCB(onMeetingStatisticsWarningNotification) → {Boolean}

Description:
  • Set onMeetingStatisticsWarningNotification callback.
Source:
Parameters:
Name Type Description
onMeetingStatisticsWarningNotification function
Returns:
true or false
Type
Boolean

(inner) SetMeetingStatusCB(meetingstatuscb) → {Boolean}

Description:
  • Set meetingstatuscb callback.
Source:
Parameters:
Name Type Description
meetingstatuscb function
Returns:
true or false
Type
Boolean

(inner) SetMeetingStatusCB(meetingstatuscb) → {Boolean}

Description:
  • Set meetingstatuscb callback.
Source:
Parameters:
Name Type Description
meetingstatuscb function
Returns:
true or false
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
Type
Number

(inner) SetOnAppSignalPanelUpdatedCB(onAppSignalPanelUpdated) → {Boolean}

Description:
  • Set onAppSignalPanelUpdated callback.
Source:
Parameters:
Name Type Description
onAppSignalPanelUpdated function
Returns:
true or false
Type
Boolean

(inner) SetOnAppSignalPanelUpdatedCB(onAppSignalPanelUpdated) → {Boolean}

Description:
  • Set onAppSignalPanelUpdated callback.
Source:
Parameters:
Name Type Description
onAppSignalPanelUpdated function
Returns:
true or false
Type
Boolean

(inner) SetOnMeetingFullToWatchLiveStreamCB(onMeetingFullToWatchLiveStream) → {Boolean}

Description:
  • Set onMeetingFullToWatchLiveStream callback.
Source:
Parameters:
Name Type Description
onMeetingFullToWatchLiveStream function
Returns:
true or false
Type
Boolean

(inner) SetOnMeetingFullToWatchLiveStreamCB(onMeetingFullToWatchLiveStream) → {Boolean}

Description:
  • Set onMeetingFullToWatchLiveStream callback.
Source:
Parameters:
Name Type Description
onMeetingFullToWatchLiveStream function
Returns:
true or false
Type
Boolean

(inner) SetOnMeetingTopicChangedCB(onMeetingTopicChanged) → {Boolean}

Description:
  • Set onMeetingTopicChanged callback.
Source:
Parameters:
Name Type Description
onMeetingTopicChanged function
Returns:
true or false
Type
Boolean

(inner) SetOnMeetingTopicChangedCB(onMeetingTopicChanged) → {Boolean}

Description:
  • Set onMeetingTopicChanged callback.
Source:
Parameters:
Name Type Description
onMeetingTopicChanged function
Returns:
true or false
Type
Boolean

(inner) SetOnUserNetworkStatusChangedCB(onUserNetworkStatusChanged) → {Boolean}

Description:
  • Set onUserNetworkStatusChanged callback.
Source:
Parameters:
Name Type Description
onUserNetworkStatusChanged function
Returns:
true or false
Type
Boolean

(inner) SetOnUserNetworkStatusChangedCB(onUserNetworkStatusChanged) → {Boolean}

Description:
  • Set onUserNetworkStatusChanged callback.
Source:
Parameters:
Name Type Description
onUserNetworkStatusChanged function
Returns:
true or false
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
Type
Number

(inner) ShowPanel(x, y, windowID) → {Number}

Description:
  • Show the app signal panel window.
Source:
Parameters:
Name Type Description
x Number The horizontal coordinate value.
y Number The vertical coordinate value.
windowID Number Only support for MAC platform.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
Type
Number

(inner) ShowPanel(x, y, windowID) → {Number}

Description:
  • Show the app signal panel window.
Source:
Parameters:
Name Type Description
x Number The horizontal coordinate value.
y Number The vertical coordinate value.
windowID Number Only support for MAC platform.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
Type
Number

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

Description:
  • Start meeting.
Source:
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, this function returns an error.
Type
Number

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

Description:
  • Start meeting.
Source:
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, this function returns an error.
Type
Number

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

Description:
  • Start meeting without login
Source:
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, this function returns an error.
Type
Number

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

Description:
  • Start meeting without login
Source:
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, this function returns an error.
Type
Number

(inner) Un_lock_Meeting() → {Number}

Description:
  • Unlock the current meeting.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
Type
Number

(inner) Un_lock_Meeting() → {Number}

Description:
  • Unlock the current meeting.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
Type
Number

Events

onAppSignalPanelUpdated

Description:
  • Callback event when the app signal panel is updated.
Source:

onAppSignalPanelUpdated

Description:
  • Callback event when the app signal panel is updated.
Source:

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:
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:
Parameters:
Name Type Description
sLiveStreamUrl String The live stream URL to watch the meeting live stream.

onMeetingParameterNotification

Description:
  • Meeting parameter notification callback.
Source:
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:
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:
Parameters:
Name Type Description
type Number The warning type of the meeting statistics StatisticsWarningType

onMeetingStatisticsWarningNotification

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

onMeetingStatusChanged

Description:
  • Meeting status changed callback.
Source:
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:
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:
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.

onUserNetworkStatusChanged

Description:
  • Called when the user's share network quality changes.
Source:
Parameters:
Name Type Description
type Number The data type whose network quality changed.
level Number The new network quality level for the specified data type.
userId Number The user whose network quality changed.
uplink Boolean This data is uplink or downlink.

onUserNetworkStatusChanged

Description:
  • Called when the user's share network quality changes.
Source:
Parameters:
Name Type Description
type Number The data type whose network quality changed.
level Number The new network quality level for the specified data type.
userId Number The user whose network quality changed.
uplink Boolean This data is uplink or downlink.