zoom_meeting_configuration

Zoom Meeting Configuration
Description:
  • Zoom Meeting Configuration
Source:
Parameters:
Name Type Description
onFreeMeetingNeedToUpgrade function The callback of upgrading the free meeting.
onFreeMeetingUpgradeToGiftFreeTrialStart function Callback function of starting to upgrade the free meeting by the gift link.
onFreeMeetingUpgradeToGiftFreeTrialStop function Callback function of ending upgrade the free meeting by the gift link.
onFreeMeetingUpgradeToProMeeting function Callback function of free meting upgrades successfully.
onInputMeetingPasswordAndScreenNameNotification function The SDK will trigger the callback event if the password or screen name is required.
onAirPlayInstructionWndNotification function This callback event may be triggered when the user enables the AirPlay introduction.
onWebinarNeedRegisterNotification function During the webinar, this callback event will be triggered if the user needs to register.
onEndOtherMeetingToJoinMeetingNotification function The user will receive this callback event if the user wants to join the new meeting while the ongoing meeting is not ended.
onFreeMeetingRemainTime function The SDK will trigger this callback event during the free meeting to inform the user how much time is left for a free meeting.
onFreeMeetingRemainTimeStopCountDown function The callback of free meeting stops the countdown.
onWebinarNeedInputScreenName function When join the webinar, this callback will be triggered if the user needs to input username.
onJoinMeetingNeedUserInfo function When joining the meeting, this callback is triggered if the user needs to input a username and email.
onUserConfirmToStartArchive function Callback event when joining a meeting if the admin allows the the user to choose to archive the meeting.
Returns:
Type
ZoomMeetingConfiguration
Description:
  • Zoom Meeting Configuration
Source:
Parameters:
Name Type Description
onFreeMeetingNeedToUpgrade function The callback of upgrading the free meeting.
onFreeMeetingUpgradeToGiftFreeTrialStart function Callback function of starting to upgrade the free meeting by the gift link.
onFreeMeetingUpgradeToGiftFreeTrialStop function Callback function of ending upgrade the free meeting by the gift link.
onFreeMeetingUpgradeToProMeeting function Callback function of free meting upgrades successfully.
onInputMeetingPasswordAndScreenNameNotification function The SDK will trigger the callback event if the password or screen name is required.
onAirPlayInstructionWndNotification function This callback event may be triggered when the user enables the AirPlay introduction.
onWebinarNeedRegisterNotification function During the webinar, this callback event will be triggered if the user needs to register.
onEndOtherMeetingToJoinMeetingNotification function The user will receive this callback event if the user wants to join the new meeting while the ongoing meeting is not ended.
onFreeMeetingRemainTime function The SDK will trigger this callback event during the free meeting to inform the user how much time is left for a free meeting.
onFreeMeetingRemainTimeStopCountDown function The callback of free meeting stops the countdown.
onWebinarNeedInputScreenName function When join the webinar, this callback will be triggered if the user needs to input username.
onJoinMeetingNeedUserInfo function When joining the meeting, this callback is triggered if the user needs to input a username and email.
onUserConfirmToStartArchive function Callback event when joining a meeting if the admin allows the the user to choose to archive the meeting.
Returns:
Type
ZoomMeetingConfiguration

Methods

(inner) MeetingConfig_AlwaysShowIconOnTaskBar(bEnable) → {Number}

Description:
  • Set if it is able to display the preview window of the Meeting Controls on the task bar during sharing. Default value: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display always the icon on the task-bar.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_AlwaysShowIconOnTaskBar(bEnable) → {Number}

Description:
  • Set if it is able to display the preview window of the Meeting Controls on the task bar during sharing. Default value: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display always the icon on the task-bar.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_CanModifyDefaultDisplayName() → {Boolean}

Description:
  • Check whether the user can modify default display name.
Source:
Returns:
true means can modify default display name.
Type
Boolean

(inner) MeetingConfig_CanModifyDefaultDisplayName() → {Boolean}

Description:
  • Check whether the user can modify default display name.
Source:
Returns:
true means can modify default display name.
Type
Boolean

(inner) MeetingConfig_CancelInputUserInfo() → {Number}

Description:
  • Ignore the prompt of completing the information. The SDK will destroy this object instance after calling this function.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_CancelInputUserInfo() → {Number}

Description:
  • Ignore the prompt of completing the information. The SDK will destroy this object instance after calling this function.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_CancelJoinWebinar() → {Number}

Description:
  • Cancel to join webinar. The SDK will destroy this object instance after calling this function.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_CancelJoinWebinar() → {Number}

Description:
  • Cancel to join webinar. The SDK will destroy this object instance after calling this function.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_CancelRegisterWebinarByEmail() → {Number}

Description:
  • Cancel Register Webinar By Email
Source:
Returns:
Type
Number

(inner) MeetingConfig_CancelRegisterWebinarByEmail() → {Number}

Description:
  • Cancel Register Webinar By Email
Source:
Returns:
Type
Number

(inner) MeetingConfig_ConfigDSCP(dscpAudio, dscpVideo, bReset) → {Number}

Description:
  • Configure DSCP(Differential services code point) values. This interface satisfies some users who have other requirements. It is not recommended to configure it. Contact the support engineer for more details.
Source:
Parameters:
Name Type Description
dscpAudio Number Configure DSCP value for audio.
dscpVideo Number Configure DSCP value for video.
bReset Boolean Reset DSCP values. This param is just used for Windows. For Mac, you can pass TRUE or FALSE as you like
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_ConfigDSCP(dscpAudio, dscpVideo, bReset) → {Number}

Description:
  • Configure DSCP(Differential services code point) values. This interface satisfies some users who have other requirements. It is not recommended to configure it. Contact the support engineer for more details.
Source:
Parameters:
Name Type Description
dscpAudio Number Configure DSCP value for audio.
dscpVideo Number Configure DSCP value for video.
bReset Boolean Reset DSCP values. This param is just used for Windows. For Mac, you can pass TRUE or FALSE as you like
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisableAutoShowSelectJoinAudioDlgWhenJoinMeeting(bEnable) → {Number}

Description:
  • Set the visibility of the dialog SELECT JOIN AUDIO when joining meeting. Default: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide the dialog box.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisableAutoShowSelectJoinAudioDlgWhenJoinMeeting(bEnable) → {Number}

Description:
  • Set the visibility of the dialog SELECT JOIN AUDIO when joining meeting. Default: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide the dialog box.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisableFreeMeetingRemainTimeNotify(bEnable) → {Number}

Description:
  • Set the visibility of the REMAINING MEETING TIME button in the meeting. Default: FALSE. If the button is disabled to show, you will retrieve onFreeMeetingRemainTime callback event.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide the button when the free meeting need be reminded. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisableFreeMeetingRemainTimeNotify(bEnable) → {Number}

Description:
  • Set the visibility of the REMAINING MEETING TIME button in the meeting. Default: FALSE. If the button is disabled to show, you will retrieve onFreeMeetingRemainTime callback event.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide the button when the free meeting need be reminded. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisablePopupMeetingWrongPSWDlg(bDisable) → {Number}

Description:
  • Set the visibility of the dialog box if the password is wrong when join the meeting. Default: FALSE. If it is disabled to display the dialog box of wrong password, the system will directly exit the state of trying to join the meeting.
Source:
Parameters:
Name Type Description
bDisable Boolean TRUE indicates to hide the dialog box of wrong password.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisablePopupMeetingWrongPSWDlg(bDisable) → {Number}

Description:
  • Set the visibility of the dialog box if the password is wrong when join the meeting. Default: FALSE. If it is disabled to display the dialog box of wrong password, the system will directly exit the state of trying to join the meeting.
Source:
Parameters:
Name Type Description
bDisable Boolean TRUE indicates to hide the dialog box of wrong password.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisableShowJoinMeetingWnd(bDisable) → {Number}

Description:
  • Set the visibility of the dialog box of joining a meeting. Default: FALSE.
Source:
Parameters:
Name Type Description
bDisable Boolean TRUE indicates to hide the dialog box. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisableShowJoinMeetingWnd(bDisable) → {Number}

Description:
  • Set the visibility of the dialog box of joining a meeting. Default: FALSE.
Source:
Parameters:
Name Type Description
bDisable Boolean TRUE indicates to hide the dialog box. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisableSplitScreenModeUIElements(bEnable) → {Number}

Description:
  • Set if it is able to enable split screen during the meeting. Default value: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to disable the split screen. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisableSplitScreenModeUIElements(bEnable) → {Number}

Description:
  • Set if it is able to enable split screen during the meeting. Default value: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to disable the split screen. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisableToolbarInviteButtonClickOriginAction(bDisable) → {Number}

Description:
  • Disable Toolbar Invite Button Click Origin Action, only support for MAC platform
Source:
Parameters:
Name Type Description
bDisable Boolean
Returns:
Type
Number

(inner) MeetingConfig_DisableToolbarInviteButtonClickOriginAction(bDisable) → {Number}

Description:
  • Disable Toolbar Invite Button Click Origin Action, only support for MAC platform
Source:
Parameters:
Name Type Description
bDisable Boolean
Returns:
Type
Number

(inner) MeetingConfig_DisableTopMostAttr4SettingDialog(bEnable) → {Number}

Description:
  • Whether to remove the topmost attribute of setting dialog. Default is not removed.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to remove. FALSE not.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisableTopMostAttr4SettingDialog(bEnable) → {Number}

Description:
  • Whether to remove the topmost attribute of setting dialog. Default is not removed.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to remove. FALSE not.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisableWaitingForHostDialog(bDisable) → {Number}

Description:
  • Set the visibility of the dialog box of waiting for the host after joining the meeting. Only invalidate when the host is not in the meeting. Default: FALSE.
Source:
Parameters:
Name Type Description
bDisable Boolean TRUE indicates to hide the dialog box. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisableWaitingForHostDialog(bDisable) → {Number}

Description:
  • Set the visibility of the dialog box of waiting for the host after joining the meeting. Only invalidate when the host is not in the meeting. Default: FALSE.
Source:
Parameters:
Name Type Description
bDisable Boolean TRUE indicates to hide the dialog box. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableApproveRemoteControlDlg(bEnable) → {Number}

Description:
  • Set the visibility of the dialog box when receiving the request of remote control during the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the dialog box. FALSE not. If it is FALSE, the user can deal with this request in the IMeetingRemoteCtrlEvent::onRemoteControlStatus() callback event sent by SDK when receiving the request of the remote control and then enters the sharing status at the end of callback event.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableApproveRemoteControlDlg(bEnable) → {Number}

Description:
  • Set the visibility of the dialog box when receiving the request of remote control during the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the dialog box. FALSE not. If it is FALSE, the user can deal with this request in the IMeetingRemoteCtrlEvent::onRemoteControlStatus() callback event sent by SDK when receiving the request of the remote control and then enters the sharing status at the end of callback event.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableAudioButtonOnMeetingUI(bEnable) → {Number}

Description:
  • Set the visibility of the Audio button in the toolbar during the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the button. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableAudioButtonOnMeetingUI(bEnable) → {Number}

Description:
  • Set the visibility of the Audio button in the toolbar during the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the button. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableAutoAdjustMicVolumeWhenJoinAudio(bEnable) → {Number}

Description:
  • Set if it is able to auto-adjust the volume of the mic when joining the meeting. Default: TRUE. If it is SDKERR_SUCCESS, the SDK will adjust the mic volume automatically. It will unmute if the mic was muted.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to auto-adjust the volume of the mic. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableAutoAdjustMicVolumeWhenJoinAudio(bEnable) → {Number}

Description:
  • Set if it is able to auto-adjust the volume of the mic when joining the meeting. Default: TRUE. If it is SDKERR_SUCCESS, the SDK will adjust the mic volume automatically. It will unmute if the mic was muted.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to auto-adjust the volume of the mic. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableAutoAdjustSpeakerVolumeWhenJoinAudio(bEnable) → {Number}

Description:
  • Set if it is able to auto-adjust the volume of the speaker when joining the meeting. Default: TRUE. If it is SDKERR_SUCCESS, the SDK will adjust the speaker volume automatically. It will unmute if the speaker was muted.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to auto-adjust the volume of the speaker. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableAutoAdjustSpeakerVolumeWhenJoinAudio(bEnable) → {Number}

Description:
  • Set if it is able to auto-adjust the volume of the speaker when joining the meeting. Default: TRUE. If it is SDKERR_SUCCESS, the SDK will adjust the speaker volume automatically. It will unmute if the speaker was muted.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to auto-adjust the volume of the speaker. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableAutoEndOtherMeetingWhenStartMeeting(bEnable) → {Number}

Description:
  • Set if it is able to end automatically another ongoing meeting when joining a new meeting. Default: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to end the other ongoing meetings. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableAutoEndOtherMeetingWhenStartMeeting(bEnable) → {Number}

Description:
  • Set if it is able to end automatically another ongoing meeting when joining a new meeting. Default: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to end the other ongoing meetings. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableAutoHideJoinAudioDialog(bEnable) → {Number}

Description:
  • Set the visibility of the dialog box of choosing audio when joining the meeting. Default value: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide the dialog box of choosing audio when joining the meeting. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableAutoHideJoinAudioDialog(bEnable) → {Number}

Description:
  • Set the visibility of the dialog box of choosing audio when joining the meeting. Default value: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide the dialog box of choosing audio when joining the meeting. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableClaimHostFeature(bEnable) → {Number}

Description:
  • Set if it is able to retrieve the permission of host (when the original host gives up the host permission). Default value: TRUE. The original host can always claim host and is not affected by this API.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates that he can retrieve the permission of host. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableClaimHostFeature(bEnable) → {Number}

Description:
  • Set if it is able to retrieve the permission of host (when the original host gives up the host permission). Default value: TRUE. The original host can always claim host and is not affected by this API.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates that he can retrieve the permission of host. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableDeclineRemoteControlResponseDlg(bEnable) → {Number}

Description:
  • Set the visibility of the dialog box when the request of the remote control is refused. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the dialog box. FALSE not. If it is FALSE, the user can deal with this request in the IMeetingRemoteCtrlEvent::onRemoteControlStatus() callback event sent by SDK when receiving the decline request of the remote control and then exists the sharing status at the end of callback event.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableDeclineRemoteControlResponseDlg(bEnable) → {Number}

Description:
  • Set the visibility of the dialog box when the request of the remote control is refused. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the dialog box. FALSE not. If it is FALSE, the user can deal with this request in the IMeetingRemoteCtrlEvent::onRemoteControlStatus() callback event sent by SDK when receiving the decline request of the remote control and then exists the sharing status at the end of callback event.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableEnterAndExitFullScreenButtonOnMeetingUI(bEnable) → {Number}

Description:
  • Enable Set the visibility of the buttons to enter or exit the full screen in the meeting window. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the button. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableEnterAndExitFullScreenButtonOnMeetingUI(bEnable) → {Number}

Description:
  • Enable Set the visibility of the buttons to enter or exit the full screen in the meeting window. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the button. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableForceAutoStartMyVideoWhenJoinMeeting(bEnable) → {Number}

Description:
  • Force to enable the video when join meeting. The default behavior depends on the configuration of the meeting.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to force to start video.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableForceAutoStartMyVideoWhenJoinMeeting(bEnable) → {Number}

Description:
  • Force to enable the video when join meeting. The default behavior depends on the configuration of the meeting.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to force to start video.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableForceAutoStopMyVideoWhenJoinMeeting(bEnable) → {Number}

Description:
  • Force to turn off video when joining the meeting. The default behavior depends on the configuration of the meeting.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to force to turn off the video.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableForceAutoStopMyVideoWhenJoinMeeting(bEnable) → {Number}

Description:
  • Force to turn off video when joining the meeting. The default behavior depends on the configuration of the meeting.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to force to turn off the video.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableGrabShareWithoutReminder(bEnable) → {Number}

Description:
  • Set whether to close the current sharing of another user without prompt and directly beginning a new sharing content by the closer. Default value: FALSE(prompt).
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates no prompt. FALSE not.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableGrabShareWithoutReminder(bEnable) → {Number}

Description:
  • Set whether to close the current sharing of another user without prompt and directly beginning a new sharing content by the closer. Default value: FALSE(prompt).
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates no prompt. FALSE not.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableInputMeetingPasswordDlg(bEnable) → {Number}

Description:
  • Set the visibility of the dialog box to input the password. Default: TRUE. If it is disabled, the SDK will trigger onInputMeetingPasswordAndScreenNameNotification()callback event when the user is asked to re-enter the password, then the user shall deal with the subsequent logic.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the dialog box to input password. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableInputMeetingPasswordDlg(bEnable) → {Number}

Description:
  • Set the visibility of the dialog box to input the password. Default: TRUE. If it is disabled, the SDK will trigger onInputMeetingPasswordAndScreenNameNotification()callback event when the user is asked to re-enter the password, then the user shall deal with the subsequent logic.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the dialog box to input password. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableInputMeetingScreenNameDlg(bEnable) → {Number}

Description:
  • Set the visibility of the dialog box to input the screen name. Default: TRUE. If it is false, the SDK will trigger IMeetingConfigurationEvent::onInputMeetingPasswordAndScreenNameNotification()callback event when the user is asked to re-enter the screen name, then the user shall deal with the subsequent logic.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the dialog box to input the screen name which is to be displayed in the meeting. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableInputMeetingScreenNameDlg(bEnable) → {Number}

Description:
  • Set the visibility of the dialog box to input the screen name. Default: TRUE. If it is false, the SDK will trigger IMeetingConfigurationEvent::onInputMeetingPasswordAndScreenNameNotification()callback event when the user is asked to re-enter the screen name, then the user shall deal with the subsequent logic.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the dialog box to input the screen name which is to be displayed in the meeting. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableInviteButtonOnMeetingUI(bEnable) → {Number}

Description:
  • Set the visibility of the INVITE button in the panelist action bar during the meeting. Default value: TRUE. The user will receive the IMeetingUIControllerEvent::onInviteBtnClicked() callback event when he clicks the INVITE button. If the callback event is not handled, the SDK will pop up a Zoom custom invitation dialog. The user will receive the IMeetingUIControllerEvent::onZoomInviteDialogFailed() callback event if the dialog box is failed to display.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the button. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableInviteButtonOnMeetingUI(bEnable) → {Number}

Description:
  • Set the visibility of the INVITE button in the panelist action bar during the meeting. Default value: TRUE. The user will receive the IMeetingUIControllerEvent::onInviteBtnClicked() callback event when he clicks the INVITE button. If the callback event is not handled, the SDK will pop up a Zoom custom invitation dialog. The user will receive the IMeetingUIControllerEvent::onZoomInviteDialogFailed() callback event if the dialog box is failed to display.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the button. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableInviteLinkOnMeetingUI(bEnable) → {Boolean}

Description:
  • Set the visibility of the INVITE link during the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the link. Otherwise not.
Returns:
Type
Boolean

(inner) MeetingConfig_EnableInviteLinkOnMeetingUI(bEnable) → {Boolean}

Description:
  • Set the visibility of the INVITE link during the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the link. Otherwise not.
Returns:
Type
Boolean

(inner) MeetingConfig_EnableLButtonDBClick4SwitchFullScreenMode(bEnable) → {Number}

Description:
  • Set if it is able to switch between the full screen mode and normal mode by double-click. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to switch. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableLButtonDBClick4SwitchFullScreenMode(bEnable) → {Number}

Description:
  • Set if it is able to switch between the full screen mode and normal mode by double-click. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to switch. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableLeaveMeetingOptionForHost(bEnable) → {Number}

Description:
  • Set the visibility of the LEAVE MEETING button on the pop-up dialogue box when the host leaves the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the button. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableLeaveMeetingOptionForHost(bEnable) → {Number}

Description:
  • Set the visibility of the LEAVE MEETING button on the pop-up dialogue box when the host leaves the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the button. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableLengthLimitationOfMeetingNumber(bEnable) → {Number}

Description:
  • Set if it is able to limit the length of meeting ID. Default: FALSE. If it is enabled, the length of the meeting ID depends on the ID type. The ID shall be more than nine(9) figures or five(5) letters. Also, The meeting ID will be displayed as it is (not formatted).
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to limit the length of meeting ID. FALSE not
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableLengthLimitationOfMeetingNumber(bEnable) → {Number}

Description:
  • Set if it is able to limit the length of meeting ID. Default: FALSE. If it is enabled, the length of the meeting ID depends on the ID type. The ID shall be more than nine(9) figures or five(5) letters. Also, The meeting ID will be displayed as it is (not formatted).
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to limit the length of meeting ID. FALSE not
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableLocalRecordingConvertProgressBarDialog(bShow) → {Number}

Description:
  • Set the visibility of the local recording convert progress bar dialog. Default: TRUE
Source:
Parameters:
Name Type Description
bShow Boolean TRUE indicates to show the dialog box. FALSE not
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableLocalRecordingConvertProgressBarDialog(bShow) → {Number}

Description:
  • Set the visibility of the local recording convert progress bar dialog. Default: TRUE
Source:
Parameters:
Name Type Description
bShow Boolean TRUE indicates to show the dialog box. FALSE not
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableShareIOSDevice(bEnable) → {Number}

Description:
  • Set if it is able to share IOS device. Default: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to enable to share. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableShareIOSDevice(bEnable) → {Number}

Description:
  • Set if it is able to share IOS device. Default: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to enable to share. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableShareWhiteBoard(bEnable) → {Number}

Description:
  • Set if it is able to share white board. Default: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to enable to share on the white board. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableShareWhiteBoard(bEnable) → {Number}

Description:
  • Set if it is able to share white board. Default: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to enable to share on the white board. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableShowShareSwitchMultiToSingleConfirmDlg(bEnable) → {Number}

Description:
  • Set the visibility of the SWITCH TO SINGLE PARTICIPANT SHARE dialog box when multiple participants are sharing and the user try to change the setting to single share. Default: TURE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to show dialog box if the multishare option is changed. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableShowShareSwitchMultiToSingleConfirmDlg(bEnable) → {Number}

Description:
  • Set the visibility of the SWITCH TO SINGLE PARTICIPANT SHARE dialog box when multiple participants are sharing and the user try to change the setting to single share. Default: TURE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to show dialog box if the multishare option is changed. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableToolTipsShow(bEnable) → {Number}

Description:
  • Set if it is able to temporarily show tooltip of the button in the toolbar of the meeting and user can close it by click the "x". Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to enable to show the tooltip in the meeting. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableToolTipsShow(bEnable) → {Number}

Description:
  • Set if it is able to temporarily show tooltip of the button in the toolbar of the meeting and user can close it by click the "x". Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to enable to show the tooltip in the meeting. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableVideoButtonOnMeetingUI(bEnable) → {Number}

Description:
  • Set the visibility of the Video button in the toolbar during the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the button. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableVideoButtonOnMeetingUI(bEnable) → {Number}

Description:
  • Set the visibility of the Video button in the toolbar during the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the button. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableZoomDocs(bEnable) → {Number}

Description:
  • Enable or disable zoom docs features in custom UI. This is disabled by default.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to enable the zoom docs feature, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableZoomDocs(bEnable) → {Number}

Description:
  • Enable or disable zoom docs features in custom UI. This is disabled by default.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to enable the zoom docs feature, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_ForceDisableMultiShare(bDisable) → {Number}

Description:
  • Set whether to forbid multi-share. Default: FALSE.
Source:
Parameters:
Name Type Description
bDisable Boolean TRUE indicates to forbid multi-share. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_ForceDisableMultiShare(bDisable) → {Number}

Description:
  • Set whether to forbid multi-share. Default: FALSE.
Source:
Parameters:
Name Type Description
bDisable Boolean TRUE indicates to forbid multi-share. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_GetArchiveConfirmContent() → {String}

Description:
  • The content that notifies the user to confirm starting to archive when joining the meeting.
Source:
Returns:
If the function succeeds, the return value is the content that notifies the user to confirm starting to archive when joining the meeting.
Type
String

(inner) MeetingConfig_GetArchiveConfirmContent() → {String}

Description:
  • The content that notifies the user to confirm starting to archive when joining the meeting.
Source:
Returns:
If the function succeeds, the return value is the content that notifies the user to confirm starting to archive when joining the meeting.
Type
String

(inner) MeetingConfig_GetDefaultDisplayName() → {String}

Description:
  • Get default display name.
Source:
Returns:
If the function succeeds, the return value is the default display name.
Type
String

(inner) MeetingConfig_GetDefaultDisplayName() → {String}

Description:
  • Get default display name.
Source:
Returns:
If the function succeeds, the return value is the default display name.
Type
String

(inner) MeetingConfig_GetRequiredInfoType() → {Number}

Description:
  • Get the type of required information to be completed.
Source:
Returns:
If the function succeed, the return is defined in: RequiredInfoType
Type
Number

(inner) MeetingConfig_GetRequiredInfoType() → {Number}

Description:
  • Get the type of required information to be completed.
Source:
Returns:
If the function succeed, the return is defined in: RequiredInfoType
Type
Number

(inner) MeetingConfig_GetWebinarNeedRegisterType() → {Number}

Description:
  • Get the type to register.
Source:
Returns:
Defined in: WebinarNeedRegisterType
Type
Number

(inner) MeetingConfig_GetWebinarNeedRegisterType() → {Number}

Description:
  • Get the type to register.
Source:
Returns:
Defined in: WebinarNeedRegisterType
Type
Number

(inner) MeetingConfig_GetWebinarRegisterUrl() → {String}

Description:
  • Get the URL to register webinar.
Source:
Returns:
If the function succeed, the return value is an URL.
Type
String

(inner) MeetingConfig_GetWebinarRegisterUrl() → {String}

Description:
  • Get the URL to register webinar.
Source:
Returns:
If the function succeed, the return value is an URL.
Type
String

(inner) MeetingConfig_HideChatItemOnMeetingUI(bEnable) → {Number}

Description:
  • Set whether to display the button CHAT and menu item. Default is displaying.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE means hiding, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideChatItemOnMeetingUI(bEnable) → {Number}

Description:
  • Set whether to display the button CHAT and menu item. Default is displaying.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE means hiding, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideCopyInvitationOnInviteWindow(bEnable) → {Number}

Description:
  • Set the visibility of CopyInvitation button on invite window, Default: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide, FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideCopyInvitationOnInviteWindow(bEnable) → {Number}

Description:
  • Set the visibility of CopyInvitation button on invite window, Default: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide, FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideCopyUrlOnInviteWindow(bEnable) → {Number}

Description:
  • Set the visibility of CopyURL button on invite window, Default: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide, FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideCopyUrlOnInviteWindow(bEnable) → {Number}

Description:
  • Set the visibility of CopyURL button on invite window, Default: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide, FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideKeypadButtonOnMeetingWindow(bEnable) → {Number}

Description:
  • Set the visibility of Keypad button on meeting window, Default: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide, FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideKeypadButtonOnMeetingWindow(bEnable) → {Number}

Description:
  • Set the visibility of Keypad button on meeting window, Default: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide, FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HidePollOnMeetingUI(bEnable) → {Number}

Description:
  • Set the visibility of poll on meeting UI. Default is displaying.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE means hiding, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HidePollOnMeetingUI(bEnable) → {Number}

Description:
  • Set the visibility of poll on meeting UI. Default is displaying.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE means hiding, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideQAOnMeetingUI(bEnable) → {Number}

Description:
  • Set the visibility of Q&A on meeting UI. Default is displaying.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE means hiding, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideQAOnMeetingUI(bEnable) → {Number}

Description:
  • Set the visibility of Q&A on meeting UI. Default is displaying.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE means hiding, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideRecordItemOnMeetingUI(bEnable) → {Number}

Description:
  • Set whether to display the button RECORD and menu item. Default is displaying.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE means hiding, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideRecordItemOnMeetingUI(bEnable) → {Number}

Description:
  • Set whether to display the button RECORD and menu item. Default is displaying.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE means hiding, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideRemoteControlOnMeetingUI(bEnable) → {Number}

Description:
  • Set whether to display the button REMOTE CONTROL and menu item. Default is displaying. If the calling of API with parameter TRUE is successful, SDK will call EnableApproveRemoteControlDlg(false) by default.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE means hiding, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideRemoteControlOnMeetingUI(bEnable) → {Number}

Description:
  • Set whether to display the button REMOTE CONTROL and menu item. Default is displaying. If the calling of API with parameter TRUE is successful, SDK will call EnableApproveRemoteControlDlg(false) by default.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE means hiding, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideSwitchCameraButton(bEnable) → {Number}

Description:
  • Set the visibility of Switch Camera button on 2nd camera share window,Default: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide the Switch Camera button. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideSwitchCameraButton(bEnable) → {Number}

Description:
  • Set the visibility of Switch Camera button on 2nd camera share window,Default: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide the Switch Camera button. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideUpgradeFreeMeetingButton(bEnable) → {Number}

Description:
  • Set whether to display the button UPGRADE when prompt the tooltip of free meeting counts down. Default is displaying.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE means hiding, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideUpgradeFreeMeetingButton(bEnable) → {Number}

Description:
  • Set whether to display the button UPGRADE when prompt the tooltip of free meeting counts down. Default is displaying.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE means hiding, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_InputMeetingIDAndScreenName(meetingID, screenName) → {Boolean}

Description:
  • Complete the meeting id and screen name information. The SDK will destroy the object instance after calling this function. Supplement with the correct information.
Source:
Parameters:
Name Type Description
meetingID String
screenName String
Returns:
Type
Boolean

(inner) MeetingConfig_InputMeetingIDAndScreenName(meetingID, screenName) → {Boolean}

Description:
  • Complete the meeting id and screen name information. The SDK will destroy the object instance after calling this function. Supplement with the correct information.
Source:
Parameters:
Name Type Description
meetingID String
screenName String
Returns:
Type
Boolean

(inner) MeetingConfig_InputMeetingPasswordAndScreenName(meeting_Password, screenName) → {Boolean}

Description:
  • Complete the password and screen name information. The SDK will destroy the object instance after calling this function. Supplement with the correct information.
Source:
Parameters:
Name Type Description
meeting_Password String
screenName String
Returns:
Type
Boolean

(inner) MeetingConfig_InputMeetingPasswordAndScreenName(meeting_Password, screenName) → {Boolean}

Description:
  • Complete the password and screen name information. The SDK will destroy the object instance after calling this function. Supplement with the correct information.
Source:
Parameters:
Name Type Description
meeting_Password String
screenName String
Returns:
Type
Boolean

(inner) MeetingConfig_InputMeetingScreenName(screenName) → {Boolean}

Description:
  • Complete the screen name. The SDK will destroy this object instance after calling this function. Complete the information by the correct function.
Source:
Parameters:
Name Type Description
screenName String
Returns:
Type
Boolean

(inner) MeetingConfig_InputMeetingScreenName(screenName) → {Boolean}

Description:
  • Complete the screen name. The SDK will destroy this object instance after calling this function. Complete the information by the correct function.
Source:
Parameters:
Name Type Description
screenName String
Returns:
Type
Boolean

(inner) MeetingConfig_InputScreenName(screenName) → {Number}

Description:
  • Input screen name to join webinar. The SDK will destroy this object instance after calling this function. Supplement with the correct information.
Source:
Parameters:
Name Type Description
screenName String The display name for the webinar.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_InputScreenName(screenName) → {Number}

Description:
  • Input screen name to join webinar. The SDK will destroy this object instance after calling this function. Supplement with the correct information.
Source:
Parameters:
Name Type Description
screenName String The display name for the webinar.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_InputUserInfo(name, email) → {Number}

Description:
  • Complete the name and email information. The SDK will destroy this object instance after calling this function. Supplement with the correct information.
Source:
Parameters:
Name Type Description
name String
email String
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_InputUserInfo(name, email) → {Number}

Description:
  • Complete the name and email information. The SDK will destroy this object instance after calling this function. Supplement with the correct information.
Source:
Parameters:
Name Type Description
name String
email String
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_InputWebinarRegisterEmailAndScreenName(email, screenName) → {Number}

Description:
  • Configure the information of email and screen name. The SDK will destroy this object instance after calling this function. Supplement with the correct information.
Source:
Parameters:
Name Type Description
email String
screenName String
Returns:
Type
Number

(inner) MeetingConfig_InputWebinarRegisterEmailAndScreenName(email, screenName) → {Number}

Description:
  • Configure the information of email and screen name. The SDK will destroy this object instance after calling this function. Supplement with the correct information.
Source:
Parameters:
Name Type Description
email String
screenName String
Returns:
Type
Number

(inner) MeetingConfig_IsValidEmail(email) → {Boolean}

Description:
  • Check whether the inputed email is a valid email format.
Source:
Parameters:
Name Type Description
email String The email must meet the email format requirements.The email input by the logged in user must be the email of the logged in account.
Returns:
true if the email input is valid
Type
Boolean

(inner) MeetingConfig_IsValidEmail(email) → {Boolean}

Description:
  • Check whether the inputed email is a valid email format.
Source:
Parameters:
Name Type Description
email String The email must meet the email format requirements.The email input by the logged in user must be the email of the logged in account.
Returns:
true if the email input is valid
Type
Boolean

(inner) MeetingConfig_JoinWithArchive(bStartArchive) → {Boolean}

Description:
  • Join the meeting.
Source:
Parameters:
Name Type Description
bStartArchive Boolean true means start the archive when joining the meeting, false means do not start the archive when joining the meeting.
Returns:
Type
Boolean

(inner) MeetingConfig_JoinWithArchive(bStartArchive) → {Boolean}

Description:
  • Join the meeting.
Source:
Parameters:
Name Type Description
bStartArchive Boolean true means start the archive when joining the meeting, false means do not start the archive when joining the meeting.
Returns:
Type
Boolean

(inner) MeetingConfig_MeetingPasswordAndScreenNameHandler_Cancel() → {Number}

Description:
  • Meeting Password And Screen Name Handler Cancel
Source:
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_MeetingPasswordAndScreenNameHandler_Cancel() → {Number}

Description:
  • Meeting Password And Screen Name Handler Cancel
Source:
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_PrePopulateWebinarRegistrationInfo(email, userName) → {Number}

Description:
  • Pre-set email and username information before joining the webinar.
Source:
Parameters:
Name Type Description
email String Configure the default email.
userName String Configure default username.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_PrePopulateWebinarRegistrationInfo(email, userName) → {Number}

Description:
  • Pre-set email and username information before joining the webinar.
Source:
Parameters:
Name Type Description
email String Configure the default email.
userName String Configure default username.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickAudioBTNEvent(bRedirect) → {Number}

Description:
  • Set if it is able to handle the event with SDK user's own program by clicking Audio button in the meeting. Default value: FALSE. If the user calls this function to convert, the SDK will trigger the onAudioBtnClicked(AudioBtnClickedCallbackInfo info), and the user shall deal with the subsequent logic himself.
Source:
Parameters:
Name Type Description
bRedirect Boolean TRUE indicates to handle with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickAudioBTNEvent(bRedirect) → {Number}

Description:
  • Set if it is able to handle the event with SDK user's own program by clicking Audio button in the meeting. Default value: FALSE. If the user calls this function to convert, the SDK will trigger the onAudioBtnClicked(AudioBtnClickedCallbackInfo info), and the user shall deal with the subsequent logic himself.
Source:
Parameters:
Name Type Description
bRedirect Boolean TRUE indicates to handle with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickAudioMenuBTNEvent(bRedirect) → {Number}

Description:
  • Set if it is able to handle the event with SDK user's own program by clicking Audio Menu button in the meeting. Default value: FALSE. If the user calls this function to convert, the SDK will trigger the onAudioMenuBtnClicked(), and the user shall deal with the subsequent logic himself.
Source:
Parameters:
Name Type Description
bRedirect Boolean TRUE indicates to handle with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickAudioMenuBTNEvent(bRedirect) → {Number}

Description:
  • Set if it is able to handle the event with SDK user's own program by clicking Audio Menu button in the meeting. Default value: FALSE. If the user calls this function to convert, the SDK will trigger the onAudioMenuBtnClicked(), and the user shall deal with the subsequent logic himself.
Source:
Parameters:
Name Type Description
bRedirect Boolean TRUE indicates to handle with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickCCBTNEvent(bEnable) → {Number}

Description:
  • Set if it is able to handle the event with SDK user's own program by clicking Closed Caption button in the meeting. Default value: FALSE. If the user calls this function to convert, the SDK will trigger the onCCBTNClicked(), and the user shall deal with the subsequent logic himself.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to handle with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickCCBTNEvent(bEnable) → {Number}

Description:
  • Set if it is able to handle the event with SDK user's own program by clicking Closed Caption button in the meeting. Default value: FALSE. If the user calls this function to convert, the SDK will trigger the onCCBTNClicked(), and the user shall deal with the subsequent logic himself.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to handle with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickCustomLiveStreamMenuEvent(bEnable) → {Number}

Description:
  • Set if it is able to handle the event with SDK user's own program by clicking CUSTOM LIVE STREAM button in the meeting. Default value: FALSE. If the user calls this function to convert, the SDK will trigger the onCustomLiveStreamMenuClicked() instead of jumping to the live video page when clicking on the custom live stream, then deal with the subsequent logic.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to handle with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickCustomLiveStreamMenuEvent(bEnable) → {Number}

Description:
  • Set if it is able to handle the event with SDK user's own program by clicking CUSTOM LIVE STREAM button in the meeting. Default value: FALSE. If the user calls this function to convert, the SDK will trigger the onCustomLiveStreamMenuClicked() instead of jumping to the live video page when clicking on the custom live stream, then deal with the subsequent logic.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to handle with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickEndMeetingBTNEvent(bEnable) → {Number}

Description:
  • Set if it is able to handle the event with user's own program by clicking END MEETING button in the meeting. Default value: FALSE. The SDK won't end the meeting if the user calls this function and set to convert. The user will deal with the subsequent logic after receiving the onEndMeetingBtnClicked() callback event.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to handle with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickEndMeetingBTNEvent(bEnable) → {Number}

Description:
  • Set if it is able to handle the event with user's own program by clicking END MEETING button in the meeting. Default value: FALSE. The SDK won't end the meeting if the user calls this function and set to convert. The user will deal with the subsequent logic after receiving the onEndMeetingBtnClicked() callback event.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to handle with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickParticipantListBTNEvent(bEnable) → {Number}

Description:
  • Set if it is able to handle the event with SDK user's own program by clicking PARTICIPANT LIST button in the meeting. Default value: FALSE. The list won't unfold by clicking participant list button if the user calls this function to set to convert. The SDK will trigger the onParticipantListBtnClicked(), and the user shall deal with the subsequent logic himself.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to handle with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickParticipantListBTNEvent(bEnable) → {Number}

Description:
  • Set if it is able to handle the event with SDK user's own program by clicking PARTICIPANT LIST button in the meeting. Default value: FALSE. The list won't unfold by clicking participant list button if the user calls this function to set to convert. The SDK will trigger the onParticipantListBtnClicked(), and the user shall deal with the subsequent logic himself.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to handle with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickShareBTNEvent(bEnable) → {Number}

Description:
  • Set if it is able to handle the event with user's own program by clicking START SHARE button in the meeting. Default value: FALSE. The SDK won't enable the share if the user calls this function and sets to convert. The user will deal with the subsequent logic after receiving the onStartShareBtnClicked() callback event.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to deal with the event with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickShareBTNEvent(bEnable) → {Number}

Description:
  • Set if it is able to handle the event with user's own program by clicking START SHARE button in the meeting. Default value: FALSE. The SDK won't enable the share if the user calls this function and sets to convert. The user will deal with the subsequent logic after receiving the onStartShareBtnClicked() callback event.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to deal with the event with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectConfirmStartArchiveDialog(bRedirect) → {Number}

Description:
  • Set if it is able to handle the confirm start archive dialog dlg with user's own program in the meeting. Default: FALSE.
Source:
Parameters:
Name Type Description
bRedirect Boolean TRUE indicates to redirect. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectConfirmStartArchiveDialog(bRedirect) → {Number}

Description:
  • Set if it is able to handle the confirm start archive dialog dlg with user's own program in the meeting. Default: FALSE.
Source:
Parameters:
Name Type Description
bRedirect Boolean TRUE indicates to redirect. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectEndOtherMeeting(bEnable) → {Number}

Description:
  • Set if it is able to redirect the process to end another meeting by user's own program. Default: FALSE. This function doesn't work if the IJoinMeetingBehaviorConfiguration::EnableAutoEndOtherMeetingWhenStartMeeting(true) is also called. If redirect successfully, the SDK will trigger the IMeetingConfigurationEvent::onEndOtherMeetingToJoinMeetingNotification() callback event.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to redirect. FALSE not. If it is TRUE, the SDK will trigger the onEndOtherMeetingToJoinMeetingNotification().
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectEndOtherMeeting(bEnable) → {Number}

Description:
  • Set if it is able to redirect the process to end another meeting by user's own program. Default: FALSE. This function doesn't work if the IJoinMeetingBehaviorConfiguration::EnableAutoEndOtherMeetingWhenStartMeeting(true) is also called. If redirect successfully, the SDK will trigger the IMeetingConfigurationEvent::onEndOtherMeetingToJoinMeetingNotification() callback event.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to redirect. FALSE not. If it is TRUE, the SDK will trigger the onEndOtherMeetingToJoinMeetingNotification().
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectFreeMeetingEndingReminderDlg(bEnable) → {Number}

Description:
  • An upgrade dialog box will pop up when the free meeting is over. Use this function to set if it is able to handle the reminder message with user's own program. Default value: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to handle the reminder message with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectFreeMeetingEndingReminderDlg(bEnable) → {Number}

Description:
  • An upgrade dialog box will pop up when the free meeting is over. Use this function to set if it is able to handle the reminder message with user's own program. Default value: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to handle the reminder message with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectMeetingInputUserInfoDialog(bRedirect) → {Number}

Description:
  • Set the visibility of the OPTIMIZE FOR FULL SCREEN VIDEO CLIP check-box in the sharing window. Default value: TRUE.
Source:
Parameters:
Name Type Description
bRedirect Boolean TRUE indicates to display. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectMeetingInputUserInfoDialog(bRedirect) → {Number}

Description:
  • Set the visibility of the OPTIMIZE FOR FULL SCREEN VIDEO CLIP check-box in the sharing window. Default value: TRUE.
Source:
Parameters:
Name Type Description
bRedirect Boolean TRUE indicates to display. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectMeetingWarningMsg(bRedirectBadNetwork, bRedirectWarnHighCPU) → {Number}

Description:
  • Set if it is able to handle the warning message with SDK user's own program in the meeting. Default value: None.
Source:
Parameters:
Name Type Description
bRedirectBadNetwork Boolean
bRedirectWarnHighCPU Boolean
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectMeetingWarningMsg(bRedirectBadNetwork, bRedirectWarnHighCPU) → {Number}

Description:
  • Set if it is able to handle the warning message with SDK user's own program in the meeting. Default value: None.
Source:
Parameters:
Name Type Description
bRedirectBadNetwork Boolean
bRedirectWarnHighCPU Boolean
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectWebinarNeedRegister(bEnable) → {Number}

Description:
  • Set if it is able to handle the webinar register process with user's own program in the meeting. Default: FALSE. If it is true, the SDK will trigger the IMeetingConfigurationEvent::onWebinarNeedRegisterNotification()callback event.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to redirect. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectWebinarNeedRegister(bEnable) → {Number}

Description:
  • Set if it is able to handle the webinar register process with user's own program in the meeting. Default: FALSE. If it is true, the SDK will trigger the IMeetingConfigurationEvent::onWebinarNeedRegisterNotification()callback event.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to redirect. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_ReleaseRegisterWebinarByUrl() → {Number}

Description:
  • Release Register Webinar By Url
Source:
Returns:
Type
Number

(inner) MeetingConfig_ReleaseRegisterWebinarByUrl() → {Number}

Description:
  • Release Register Webinar By Url
Source:
Returns:
Type
Number

(inner) MeetingConfig_Reset() → {Number}

Description:
  • Reset the meeting configuration and back to the default state.
Source:
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_Reset() → {Number}

Description:
  • Reset the meeting configuration and back to the default state.
Source:
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetAirPlayInstructionWndNotificationCB(onAirPlayInstructionWndNotification) → {Boolean}

Description:
  • Set Air Play Instruction Wnd Notification Callback
Source:
Parameters:
Name Type Description
onAirPlayInstructionWndNotification function
Returns:
Type
Boolean

(inner) MeetingConfig_SetAirPlayInstructionWndNotificationCB(onAirPlayInstructionWndNotification) → {Boolean}

Description:
  • Set Air Play Instruction Wnd Notification Callback
Source:
Parameters:
Name Type Description
onAirPlayInstructionWndNotification function
Returns:
Type
Boolean

(inner) MeetingConfig_SetBottomFloatToolbarWndVisibility(bShow) → {Number}

Description:
  • Set the visibility of the toolbar at the bottom of the meeting window. Default value: TRUE.
Source:
Parameters:
Name Type Description
bShow Boolean TRUE means to enable the feature to display always the toolbar at the bottom. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetBottomFloatToolbarWndVisibility(bShow) → {Number}

Description:
  • Set the visibility of the toolbar at the bottom of the meeting window. Default value: TRUE.
Source:
Parameters:
Name Type Description
bShow Boolean TRUE means to enable the feature to display always the toolbar at the bottom. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetDirectShareMonitorID(monitorID) → {Number}

Description:
  • Set the shared device ID when sharing directly.
Source:
Parameters:
Name Type Description
monitorID String Specify the device ID to be shared.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetDirectShareMonitorID(monitorID) → {Number}

Description:
  • Set the shared device ID when sharing directly.
Source:
Parameters:
Name Type Description
monitorID String Specify the device ID to be shared.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetFloatVideoPos(left, top, hSelfWnd, hParent) → {Number}

Description:
  • Set the position of the floating video window when sharing. The value shall be set before the sharing begins. If you set the value during the process of share, the function will not be valid until the next share.
Source:
Parameters:
Name Type Description
left String Specify the left position of the floating video window when sharing.
top String Specify the top position of the floating video window when sharing.
hSelfWnd String SelfWnd (require hexadecimal)
hParent String parent window handle (require hexadecimal)
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetFloatVideoPos(left, top, hSelfWnd, hParent) → {Number}

Description:
  • Set the position of the floating video window when sharing. The value shall be set before the sharing begins. If you set the value during the process of share, the function will not be valid until the next share.
Source:
Parameters:
Name Type Description
left String Specify the left position of the floating video window when sharing.
top String Specify the top position of the floating video window when sharing.
hSelfWnd String SelfWnd (require hexadecimal)
hParent String parent window handle (require hexadecimal)
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetFloatVideoWndVisibility(bShow) → {Number}

Description:
  • Set the visibility of the floating video window when sharing in the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bShow Boolean TRUE indicates to display the floating video window. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetFloatVideoWndVisibility(bShow) → {Number}

Description:
  • Set the visibility of the floating video window when sharing in the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bShow Boolean TRUE indicates to display the floating video window. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetFreeMeetingNeedToUpgradeCB(onFreeMeetingNeedToUpgrade) → {Boolean}

Description:
  • Set the callback of upgrading the free meeting.
Source:
Parameters:
Name Type Description
onFreeMeetingNeedToUpgrade function
Returns:
Type
Boolean

(inner) MeetingConfig_SetFreeMeetingNeedToUpgradeCB(onFreeMeetingNeedToUpgrade) → {Boolean}

Description:
  • Set the callback of upgrading the free meeting.
Source:
Parameters:
Name Type Description
onFreeMeetingNeedToUpgrade function
Returns:
Type
Boolean

(inner) MeetingConfig_SetFreeMeetingUpgradeToGiftFreeTrialStartCB(onFreeMeetingUpgradeToGiftFreeTrialStart) → {Boolean}

Description:
  • Set the callback function of starting to upgrade the free meeting by the gift link.
Source:
Parameters:
Name Type Description
onFreeMeetingUpgradeToGiftFreeTrialStart function
Returns:
Type
Boolean

(inner) MeetingConfig_SetFreeMeetingUpgradeToGiftFreeTrialStartCB(onFreeMeetingUpgradeToGiftFreeTrialStart) → {Boolean}

Description:
  • Set the callback function of starting to upgrade the free meeting by the gift link.
Source:
Parameters:
Name Type Description
onFreeMeetingUpgradeToGiftFreeTrialStart function
Returns:
Type
Boolean

(inner) MeetingConfig_SetFreeMeetingUpgradeToGiftFreeTrialStopCB(onFreeMeetingUpgradeToGiftFreeTrialStop) → {Boolean}

Description:
  • Set the callback of ending upgrade the free meeting by the gift link.
Source:
Parameters:
Name Type Description
onFreeMeetingUpgradeToGiftFreeTrialStop function
Returns:
Type
Boolean

(inner) MeetingConfig_SetFreeMeetingUpgradeToGiftFreeTrialStopCB(onFreeMeetingUpgradeToGiftFreeTrialStop) → {Boolean}

Description:
  • Set the callback of ending upgrade the free meeting by the gift link.
Source:
Parameters:
Name Type Description
onFreeMeetingUpgradeToGiftFreeTrialStop function
Returns:
Type
Boolean

(inner) MeetingConfig_SetFreeMeetingUpgradeToProMeetingCB(onFreeMeetingUpgradeToProMeeting) → {Boolean}

Description:
  • Set the callback of free meting upgrades successfully.
Source:
Parameters:
Name Type Description
onFreeMeetingUpgradeToProMeeting function
Returns:
Type
Boolean

(inner) MeetingConfig_SetFreeMeetingUpgradeToProMeetingCB(onFreeMeetingUpgradeToProMeeting) → {Boolean}

Description:
  • Set the callback of free meting upgrades successfully.
Source:
Parameters:
Name Type Description
onFreeMeetingUpgradeToProMeeting function
Returns:
Type
Boolean

(inner) MeetingConfig_SetInputMeetingPasswordAndScreenNameNotificationCB(onInputMeetingPasswordAndScreenNameNotification) → {Boolean}

Description:
  • Set Input Meeting Password And Screen Name Notification Callback
Source:
Parameters:
Name Type Description
onInputMeetingPasswordAndScreenNameNotification function
Returns:
Type
Boolean

(inner) MeetingConfig_SetInputMeetingPasswordAndScreenNameNotificationCB(onInputMeetingPasswordAndScreenNameNotification) → {Boolean}

Description:
  • Set Input Meeting Password And Screen Name Notification Callback
Source:
Parameters:
Name Type Description
onInputMeetingPasswordAndScreenNameNotification function
Returns:
Type
Boolean

(inner) MeetingConfig_SetMaxDurationForOnlyHostInMeeting(nDuration) → {Number}

Description:
  • Set the maximum duration of the meeting when there is no attendee in the meeting. Default: 24*60
Source:
Parameters:
Name Type Description
nDuration Number Specify the maximum duration in minutes
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetMaxDurationForOnlyHostInMeeting(nDuration) → {Number}

Description:
  • Set the maximum duration of the meeting when there is no attendee in the meeting. Default: 24*60
Source:
Parameters:
Name Type Description
nDuration Number Specify the maximum duration in minutes
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetMeetingUIPos(left, top, hSelfWnd, hParent) → {Number}

Description:
  • Set the position of the primary view meeting window.
Source:
Parameters:
Name Type Description
left String Specify the left position of the primary view meeting window. The coordinates of the window are those of the screen.
top String Specify the top position of the primary view meeting window. The coordinates of the window are those of the screen.
hSelfWnd String (require hexadecimal)
hParent String (require hexadecimal)
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetMeetingUIPos(left, top, hSelfWnd, hParent) → {Number}

Description:
  • Set the position of the primary view meeting window.
Source:
Parameters:
Name Type Description
left String Specify the left position of the primary view meeting window. The coordinates of the window are those of the screen.
top String Specify the top position of the primary view meeting window. The coordinates of the window are those of the screen.
hSelfWnd String (require hexadecimal)
hParent String (require hexadecimal)
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetSharingToolbarVisibility(bShow) → {Number}

Description:
  • Set the visibility of the sharing toolbar. Default value: TRUE. This function works only before the meeting or the sharing starts.
Source:
Parameters:
Name Type Description
bShow Boolean TRUE means to enable the display sharing toolbar. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetSharingToolbarVisibility(bShow) → {Number}

Description:
  • Set the visibility of the sharing toolbar. Default value: TRUE. This function works only before the meeting or the sharing starts.
Source:
Parameters:
Name Type Description
bShow Boolean TRUE means to enable the display sharing toolbar. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetShowAudioUseComputerSoundChkbox(bEnable) → {Number}

Description:
  • Set the visibility of the SHARE COMPUTER SOUND check-box in the sharing window. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetShowAudioUseComputerSoundChkbox(bEnable) → {Number}

Description:
  • Set the visibility of the SHARE COMPUTER SOUND check-box in the sharing window. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetShowCallInTab(bEnable) → {Number}

Description:
  • Set the visibility of PHONE CALL tab in the audio dialog box when joining the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the tab. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetShowCallInTab(bEnable) → {Number}

Description:
  • Set the visibility of PHONE CALL tab in the audio dialog box when joining the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the tab. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetShowCallMeTab(bEnable) → {Number}

Description:
  • Set the visibility of CALL ME tab in the audio dialog box when joining the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the tab. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetShowCallMeTab(bEnable) → {Number}

Description:
  • Set the visibility of CALL ME tab in the audio dialog box when joining the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the tab. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetShowH323SubTabPage(tabPage, bShow) → {Number}

Description:
  • Set the visibility of some specified tabs in the Room System invitation dialog. Default: show all the content.Default: show all the content.
Source:
Parameters:
Name Type Description
tabPage Number Specify a tab, Defined in: SDKH323TabPage
bShow Boolean TRUE indicates to display the tab. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetShowH323SubTabPage(tabPage, bShow) → {Number}

Description:
  • Set the visibility of some specified tabs in the Room System invitation dialog. Default: show all the content.Default: show all the content.
Source:
Parameters:
Name Type Description
tabPage Number Specify a tab, Defined in: SDKH323TabPage
bShow Boolean TRUE indicates to display the tab. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetShowInviteDlgTabPage(tabPage, bShow) → {Number}

Description:
  • Set the visibility of some specified tabs in the invite dialog. Default: Show all the content.
Source:
Parameters:
Name Type Description
tabPage Number Specify a tab page, Defined in: SDKInviteDlgTabPage
bShow Boolean TRUE indicates to display the tab. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetShowInviteDlgTabPage(tabPage, bShow) → {Number}

Description:
  • Set the visibility of some specified tabs in the invite dialog. Default: Show all the content.
Source:
Parameters:
Name Type Description
tabPage Number Specify a tab page, Defined in: SDKInviteDlgTabPage
bShow Boolean TRUE indicates to display the tab. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetShowVideoOptimizeChkbox(bShow) → {Number}

Description:
  • Set the visibility of the OPTIMIZE FOR FULL SCREEN VIDEO CLIP check-box in the sharing window. Default value: TRUE.
Source:
Parameters:
Name Type Description
bShow Boolean TRUE indicates to display. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetShowVideoOptimizeChkbox(bShow) → {Number}

Description:
  • Set the visibility of the OPTIMIZE FOR FULL SCREEN VIDEO CLIP check-box in the sharing window. Default value: TRUE.
Source:
Parameters:
Name Type Description
bShow Boolean TRUE indicates to display. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetonEndOtherMeetingToJoinMeetingNotificationCB(onEndOtherMeetingToJoinMeetingNotification) → {Boolean}

Description:
  • Set on End Other Meeting To Join Meeting Notification Callback
Source:
Parameters:
Name Type Description
onEndOtherMeetingToJoinMeetingNotification function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonEndOtherMeetingToJoinMeetingNotificationCB(onEndOtherMeetingToJoinMeetingNotification) → {Boolean}

Description:
  • Set on End Other Meeting To Join Meeting Notification Callback
Source:
Parameters:
Name Type Description
onEndOtherMeetingToJoinMeetingNotification function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonFreeMeetingRemainTimeCB(onFreeMeetingRemainTime) → {Boolean}

Description:
  • Set on Free Meeting Remain Time Callback
Source:
Parameters:
Name Type Description
onFreeMeetingRemainTime function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonFreeMeetingRemainTimeCB(onFreeMeetingRemainTime) → {Boolean}

Description:
  • Set on Free Meeting Remain Time Callback
Source:
Parameters:
Name Type Description
onFreeMeetingRemainTime function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonFreeMeetingRemainTimeStopCountDownCB(onFreeMeetingRemainTimeStopCountDown) → {Boolean}

Description:
  • Set on Free Meeting Remain Time Stop Count Down Callback
Source:
Parameters:
Name Type Description
onFreeMeetingRemainTimeStopCountDown function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonFreeMeetingRemainTimeStopCountDownCB(onFreeMeetingRemainTimeStopCountDown) → {Boolean}

Description:
  • Set on Free Meeting Remain Time Stop Count Down Callback
Source:
Parameters:
Name Type Description
onFreeMeetingRemainTimeStopCountDown function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonJoinMeetingNeedUserInfoCB(onJoinMeetingNeedUserInfo) → {Boolean}

Description:
  • Set callback is triggered if the user needs to input a username and email, when joining the meeting
Source:
Parameters:
Name Type Description
onJoinMeetingNeedUserInfo function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonJoinMeetingNeedUserInfoCB(onJoinMeetingNeedUserInfo) → {Boolean}

Description:
  • Set callback is triggered if the user needs to input a username and email, when joining the meeting
Source:
Parameters:
Name Type Description
onJoinMeetingNeedUserInfo function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonUserConfirmToStartArchiveCB(onUserConfirmToStartArchive) → {Boolean}

Description:
  • Set callback is triggered when joining a meeting if the admin allows the the user to choose to archive the meeting.
Source:
Parameters:
Name Type Description
onUserConfirmToStartArchive function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonUserConfirmToStartArchiveCB(onUserConfirmToStartArchive) → {Boolean}

Description:
  • Set callback is triggered when joining a meeting if the admin allows the the user to choose to archive the meeting.
Source:
Parameters:
Name Type Description
onUserConfirmToStartArchive function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonWebinarNeedInputScreenNameCB(onWebinarNeedInputScreenName) → {Boolean}

Description:
  • Set callback is triggered if the user needs to input a username, when joining the webinar
Source:
Parameters:
Name Type Description
onWebinarNeedInputScreenName function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonWebinarNeedInputScreenNameCB(onWebinarNeedInputScreenName) → {Boolean}

Description:
  • Set callback is triggered if the user needs to input a username, when joining the webinar
Source:
Parameters:
Name Type Description
onWebinarNeedInputScreenName function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonWebinarNeedRegisterNotificationCB(onWebinarNeedRegisterNotification) → {Boolean}

Description:
  • Set on Webinar Need Register Notification Callback
Source:
Parameters:
Name Type Description
onWebinarNeedRegisterNotification function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonWebinarNeedRegisterNotificationCB(onWebinarNeedRegisterNotification) → {Boolean}

Description:
  • Set on Webinar Need Register Notification Callback
Source:
Parameters:
Name Type Description
onWebinarNeedRegisterNotification function
Returns:
Type
Boolean

Events

onAirPlayInstructionWndNotification

Description:
  • This callback event may be triggered when the user enables the AirPlay introduction.
Source:
Parameters:
Name Type Description
bShow Boolean Show or hide the AirPlay instruction window.
airhostName String The air-host name displayed on IOS device.

onAirPlayInstructionWndNotification

Description:
  • This callback event may be triggered when the user enables the AirPlay introduction.
Source:
Parameters:
Name Type Description
bShow Boolean Show or hide the AirPlay instruction window.
airhostName String The air-host name displayed on IOS device.

onEndOtherMeetingToJoinMeetingNotification

Description:
  • The user will receive this callback event if the user wants to join the new meeting while the ongoing meeting is not ended.
Source:

onEndOtherMeetingToJoinMeetingNotification

Description:
  • The user will receive this callback event if the user wants to join the new meeting while the ongoing meeting is not ended.
Source:

onFreeMeetingNeedToUpgrade

Description:
  • The callback of upgrading the free meeting.
Source:
Parameters:
Name Type Description
type String Type of upgrading the free meeting, FreeMeetingNeedUpgradeType
gift_url String Upgrade the free meeting by the gift link. When and only when the value of type_ is FreeMeetingNeedUpgradeType_BY_GIFTURL, this parameter is meaningful.

onFreeMeetingNeedToUpgrade

Description:
  • The callback of upgrading the free meeting.
Source:
Parameters:
Name Type Description
type String Type of upgrading the free meeting, FreeMeetingNeedUpgradeType
gift_url String Upgrade the free meeting by the gift link. When and only when the value of type_ is FreeMeetingNeedUpgradeType_BY_GIFTURL, this parameter is meaningful.

onFreeMeetingRemainTime

Description:
  • The SDK will trigger this callback event during the free meeting to inform the user how much time is left for a free meeting.
Source:
Parameters:
Name Type Description
leftTime String The left time of meeting calculated in seconds.

onFreeMeetingRemainTime

Description:
  • The SDK will trigger this callback event during the free meeting to inform the user how much time is left for a free meeting.
Source:
Parameters:
Name Type Description
leftTime String The left time of meeting calculated in seconds.

onFreeMeetingRemainTimeStopCountDown

Description:
  • The callback of free meeting stops the countdown.
Source:

onFreeMeetingRemainTimeStopCountDown

Description:
  • The callback of free meeting stops the countdown.
Source:

onFreeMeetingUpgradeToGiftFreeTrialStart

Description:
  • Callback function of starting to upgrade the free meeting by the gift link.
Source:

onFreeMeetingUpgradeToGiftFreeTrialStart

Description:
  • Callback function of starting to upgrade the free meeting by the gift link.
Source:

onFreeMeetingUpgradeToGiftFreeTrialStop

Description:
  • Callback function of ending upgrade the free meeting by the gift link.
Source:

onFreeMeetingUpgradeToGiftFreeTrialStop

Description:
  • Callback function of ending upgrade the free meeting by the gift link.
Source:

onFreeMeetingUpgradeToProMeeting

Description:
  • Callback function of free meting upgrades successfully.
Source:

onFreeMeetingUpgradeToProMeeting

Description:
  • Callback function of free meting upgrades successfully.
Source:

onInputMeetingPasswordAndScreenNameNotification

Description:
  • The SDK will trigger the callback event if the password or screen name is required.
Source:

onInputMeetingPasswordAndScreenNameNotification

Description:
  • The SDK will trigger the callback event if the password or screen name is required.
Source:

onJoinMeetingNeedUserInfo

Description:
  • When joining the meeting, this callback is triggered if the user needs to input a username and email.
Source:

onJoinMeetingNeedUserInfo

Description:
  • When joining the meeting, this callback is triggered if the user needs to input a username and email.
Source:

onUserConfirmToStartArchive

Description:
  • Callback event when joining a meeting if the admin allows the the user to choose to archive the meeting.
Source:

onUserConfirmToStartArchive

Description:
  • Callback event when joining a meeting if the admin allows the the user to choose to archive the meeting.
Source:

onWebinarNeedInputScreenName

Description:
  • When joining the webinar, this callback is triggered if the user needs to input a username.
Source:

onWebinarNeedInputScreenName

Description:
  • When joining the webinar, this callback is triggered if the user needs to input a username.
Source:

onWebinarNeedRegisterNotification

Description:
  • During the webinar, this callback event will be triggered if the user needs to register.
Source:

onWebinarNeedRegisterNotification

Description:
  • During the webinar, this callback event will be triggered if the user needs to register.
Source:
Zoom Meeting Configuration
Description:
  • Zoom Meeting Configuration
Source:
Parameters:
Name Type Description
onFreeMeetingNeedToUpgrade function The callback of upgrading the free meeting.
onFreeMeetingUpgradeToGiftFreeTrialStart function Callback function of starting to upgrade the free meeting by the gift link.
onFreeMeetingUpgradeToGiftFreeTrialStop function Callback function of ending upgrade the free meeting by the gift link.
onFreeMeetingUpgradeToProMeeting function Callback function of free meting upgrades successfully.
onInputMeetingPasswordAndScreenNameNotification function The SDK will trigger the callback event if the password or screen name is required.
onAirPlayInstructionWndNotification function This callback event may be triggered when the user enables the AirPlay introduction.
onWebinarNeedRegisterNotification function During the webinar, this callback event will be triggered if the user needs to register.
onEndOtherMeetingToJoinMeetingNotification function The user will receive this callback event if the user wants to join the new meeting while the ongoing meeting is not ended.
onFreeMeetingRemainTime function The SDK will trigger this callback event during the free meeting to inform the user how much time is left for a free meeting.
onFreeMeetingRemainTimeStopCountDown function The callback of free meeting stops the countdown.
onWebinarNeedInputScreenName function When join the webinar, this callback will be triggered if the user needs to input username.
onJoinMeetingNeedUserInfo function When joining the meeting, this callback is triggered if the user needs to input a username and email.
onUserConfirmToStartArchive function Callback event when joining a meeting if the admin allows the the user to choose to archive the meeting.
Returns:
Type
ZoomMeetingConfiguration
Description:
  • Zoom Meeting Configuration
Source:
Parameters:
Name Type Description
onFreeMeetingNeedToUpgrade function The callback of upgrading the free meeting.
onFreeMeetingUpgradeToGiftFreeTrialStart function Callback function of starting to upgrade the free meeting by the gift link.
onFreeMeetingUpgradeToGiftFreeTrialStop function Callback function of ending upgrade the free meeting by the gift link.
onFreeMeetingUpgradeToProMeeting function Callback function of free meting upgrades successfully.
onInputMeetingPasswordAndScreenNameNotification function The SDK will trigger the callback event if the password or screen name is required.
onAirPlayInstructionWndNotification function This callback event may be triggered when the user enables the AirPlay introduction.
onWebinarNeedRegisterNotification function During the webinar, this callback event will be triggered if the user needs to register.
onEndOtherMeetingToJoinMeetingNotification function The user will receive this callback event if the user wants to join the new meeting while the ongoing meeting is not ended.
onFreeMeetingRemainTime function The SDK will trigger this callback event during the free meeting to inform the user how much time is left for a free meeting.
onFreeMeetingRemainTimeStopCountDown function The callback of free meeting stops the countdown.
onWebinarNeedInputScreenName function When join the webinar, this callback will be triggered if the user needs to input username.
onJoinMeetingNeedUserInfo function When joining the meeting, this callback is triggered if the user needs to input a username and email.
onUserConfirmToStartArchive function Callback event when joining a meeting if the admin allows the the user to choose to archive the meeting.
Returns:
Type
ZoomMeetingConfiguration

Methods

(inner) MeetingConfig_AlwaysShowIconOnTaskBar(bEnable) → {Number}

Description:
  • Set if it is able to display the preview window of the Meeting Controls on the task bar during sharing. Default value: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display always the icon on the task-bar.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_AlwaysShowIconOnTaskBar(bEnable) → {Number}

Description:
  • Set if it is able to display the preview window of the Meeting Controls on the task bar during sharing. Default value: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display always the icon on the task-bar.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_CanModifyDefaultDisplayName() → {Boolean}

Description:
  • Check whether the user can modify default display name.
Source:
Returns:
true means can modify default display name.
Type
Boolean

(inner) MeetingConfig_CanModifyDefaultDisplayName() → {Boolean}

Description:
  • Check whether the user can modify default display name.
Source:
Returns:
true means can modify default display name.
Type
Boolean

(inner) MeetingConfig_CancelInputUserInfo() → {Number}

Description:
  • Ignore the prompt of completing the information. The SDK will destroy this object instance after calling this function.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_CancelInputUserInfo() → {Number}

Description:
  • Ignore the prompt of completing the information. The SDK will destroy this object instance after calling this function.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_CancelJoinWebinar() → {Number}

Description:
  • Cancel to join webinar. The SDK will destroy this object instance after calling this function.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_CancelJoinWebinar() → {Number}

Description:
  • Cancel to join webinar. The SDK will destroy this object instance after calling this function.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_CancelRegisterWebinarByEmail() → {Number}

Description:
  • Cancel Register Webinar By Email
Source:
Returns:
Type
Number

(inner) MeetingConfig_CancelRegisterWebinarByEmail() → {Number}

Description:
  • Cancel Register Webinar By Email
Source:
Returns:
Type
Number

(inner) MeetingConfig_ConfigDSCP(dscpAudio, dscpVideo, bReset) → {Number}

Description:
  • Configure DSCP(Differential services code point) values. This interface satisfies some users who have other requirements. It is not recommended to configure it. Contact the support engineer for more details.
Source:
Parameters:
Name Type Description
dscpAudio Number Configure DSCP value for audio.
dscpVideo Number Configure DSCP value for video.
bReset Boolean Reset DSCP values. This param is just used for Windows. For Mac, you can pass TRUE or FALSE as you like
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_ConfigDSCP(dscpAudio, dscpVideo, bReset) → {Number}

Description:
  • Configure DSCP(Differential services code point) values. This interface satisfies some users who have other requirements. It is not recommended to configure it. Contact the support engineer for more details.
Source:
Parameters:
Name Type Description
dscpAudio Number Configure DSCP value for audio.
dscpVideo Number Configure DSCP value for video.
bReset Boolean Reset DSCP values. This param is just used for Windows. For Mac, you can pass TRUE or FALSE as you like
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisableAutoShowSelectJoinAudioDlgWhenJoinMeeting(bEnable) → {Number}

Description:
  • Set the visibility of the dialog SELECT JOIN AUDIO when joining meeting. Default: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide the dialog box.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisableAutoShowSelectJoinAudioDlgWhenJoinMeeting(bEnable) → {Number}

Description:
  • Set the visibility of the dialog SELECT JOIN AUDIO when joining meeting. Default: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide the dialog box.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisableFreeMeetingRemainTimeNotify(bEnable) → {Number}

Description:
  • Set the visibility of the REMAINING MEETING TIME button in the meeting. Default: FALSE. If the button is disabled to show, you will retrieve onFreeMeetingRemainTime callback event.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide the button when the free meeting need be reminded. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisableFreeMeetingRemainTimeNotify(bEnable) → {Number}

Description:
  • Set the visibility of the REMAINING MEETING TIME button in the meeting. Default: FALSE. If the button is disabled to show, you will retrieve onFreeMeetingRemainTime callback event.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide the button when the free meeting need be reminded. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisablePopupMeetingWrongPSWDlg(bDisable) → {Number}

Description:
  • Set the visibility of the dialog box if the password is wrong when join the meeting. Default: FALSE. If it is disabled to display the dialog box of wrong password, the system will directly exit the state of trying to join the meeting.
Source:
Parameters:
Name Type Description
bDisable Boolean TRUE indicates to hide the dialog box of wrong password.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisablePopupMeetingWrongPSWDlg(bDisable) → {Number}

Description:
  • Set the visibility of the dialog box if the password is wrong when join the meeting. Default: FALSE. If it is disabled to display the dialog box of wrong password, the system will directly exit the state of trying to join the meeting.
Source:
Parameters:
Name Type Description
bDisable Boolean TRUE indicates to hide the dialog box of wrong password.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisableShowJoinMeetingWnd(bDisable) → {Number}

Description:
  • Set the visibility of the dialog box of joining a meeting. Default: FALSE.
Source:
Parameters:
Name Type Description
bDisable Boolean TRUE indicates to hide the dialog box. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisableShowJoinMeetingWnd(bDisable) → {Number}

Description:
  • Set the visibility of the dialog box of joining a meeting. Default: FALSE.
Source:
Parameters:
Name Type Description
bDisable Boolean TRUE indicates to hide the dialog box. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisableSplitScreenModeUIElements(bEnable) → {Number}

Description:
  • Set if it is able to enable split screen during the meeting. Default value: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to disable the split screen. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisableSplitScreenModeUIElements(bEnable) → {Number}

Description:
  • Set if it is able to enable split screen during the meeting. Default value: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to disable the split screen. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisableToolbarInviteButtonClickOriginAction(bDisable) → {Number}

Description:
  • Disable Toolbar Invite Button Click Origin Action, only support for MAC platform
Source:
Parameters:
Name Type Description
bDisable Boolean
Returns:
Type
Number

(inner) MeetingConfig_DisableToolbarInviteButtonClickOriginAction(bDisable) → {Number}

Description:
  • Disable Toolbar Invite Button Click Origin Action, only support for MAC platform
Source:
Parameters:
Name Type Description
bDisable Boolean
Returns:
Type
Number

(inner) MeetingConfig_DisableTopMostAttr4SettingDialog(bEnable) → {Number}

Description:
  • Whether to remove the topmost attribute of setting dialog. Default is not removed.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to remove. FALSE not.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisableTopMostAttr4SettingDialog(bEnable) → {Number}

Description:
  • Whether to remove the topmost attribute of setting dialog. Default is not removed.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to remove. FALSE not.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisableWaitingForHostDialog(bDisable) → {Number}

Description:
  • Set the visibility of the dialog box of waiting for the host after joining the meeting. Only invalidate when the host is not in the meeting. Default: FALSE.
Source:
Parameters:
Name Type Description
bDisable Boolean TRUE indicates to hide the dialog box. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_DisableWaitingForHostDialog(bDisable) → {Number}

Description:
  • Set the visibility of the dialog box of waiting for the host after joining the meeting. Only invalidate when the host is not in the meeting. Default: FALSE.
Source:
Parameters:
Name Type Description
bDisable Boolean TRUE indicates to hide the dialog box. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableApproveRemoteControlDlg(bEnable) → {Number}

Description:
  • Set the visibility of the dialog box when receiving the request of remote control during the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the dialog box. FALSE not. If it is FALSE, the user can deal with this request in the IMeetingRemoteCtrlEvent::onRemoteControlStatus() callback event sent by SDK when receiving the request of the remote control and then enters the sharing status at the end of callback event.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableApproveRemoteControlDlg(bEnable) → {Number}

Description:
  • Set the visibility of the dialog box when receiving the request of remote control during the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the dialog box. FALSE not. If it is FALSE, the user can deal with this request in the IMeetingRemoteCtrlEvent::onRemoteControlStatus() callback event sent by SDK when receiving the request of the remote control and then enters the sharing status at the end of callback event.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableAudioButtonOnMeetingUI(bEnable) → {Number}

Description:
  • Set the visibility of the Audio button in the toolbar during the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the button. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableAudioButtonOnMeetingUI(bEnable) → {Number}

Description:
  • Set the visibility of the Audio button in the toolbar during the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the button. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableAutoAdjustMicVolumeWhenJoinAudio(bEnable) → {Number}

Description:
  • Set if it is able to auto-adjust the volume of the mic when joining the meeting. Default: TRUE. If it is SDKERR_SUCCESS, the SDK will adjust the mic volume automatically. It will unmute if the mic was muted.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to auto-adjust the volume of the mic. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableAutoAdjustMicVolumeWhenJoinAudio(bEnable) → {Number}

Description:
  • Set if it is able to auto-adjust the volume of the mic when joining the meeting. Default: TRUE. If it is SDKERR_SUCCESS, the SDK will adjust the mic volume automatically. It will unmute if the mic was muted.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to auto-adjust the volume of the mic. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableAutoAdjustSpeakerVolumeWhenJoinAudio(bEnable) → {Number}

Description:
  • Set if it is able to auto-adjust the volume of the speaker when joining the meeting. Default: TRUE. If it is SDKERR_SUCCESS, the SDK will adjust the speaker volume automatically. It will unmute if the speaker was muted.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to auto-adjust the volume of the speaker. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableAutoAdjustSpeakerVolumeWhenJoinAudio(bEnable) → {Number}

Description:
  • Set if it is able to auto-adjust the volume of the speaker when joining the meeting. Default: TRUE. If it is SDKERR_SUCCESS, the SDK will adjust the speaker volume automatically. It will unmute if the speaker was muted.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to auto-adjust the volume of the speaker. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableAutoEndOtherMeetingWhenStartMeeting(bEnable) → {Number}

Description:
  • Set if it is able to end automatically another ongoing meeting when joining a new meeting. Default: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to end the other ongoing meetings. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableAutoEndOtherMeetingWhenStartMeeting(bEnable) → {Number}

Description:
  • Set if it is able to end automatically another ongoing meeting when joining a new meeting. Default: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to end the other ongoing meetings. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableAutoHideJoinAudioDialog(bEnable) → {Number}

Description:
  • Set the visibility of the dialog box of choosing audio when joining the meeting. Default value: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide the dialog box of choosing audio when joining the meeting. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableAutoHideJoinAudioDialog(bEnable) → {Number}

Description:
  • Set the visibility of the dialog box of choosing audio when joining the meeting. Default value: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide the dialog box of choosing audio when joining the meeting. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableClaimHostFeature(bEnable) → {Number}

Description:
  • Set if it is able to retrieve the permission of host (when the original host gives up the host permission). Default value: TRUE. The original host can always claim host and is not affected by this API.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates that he can retrieve the permission of host. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableClaimHostFeature(bEnable) → {Number}

Description:
  • Set if it is able to retrieve the permission of host (when the original host gives up the host permission). Default value: TRUE. The original host can always claim host and is not affected by this API.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates that he can retrieve the permission of host. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableDeclineRemoteControlResponseDlg(bEnable) → {Number}

Description:
  • Set the visibility of the dialog box when the request of the remote control is refused. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the dialog box. FALSE not. If it is FALSE, the user can deal with this request in the IMeetingRemoteCtrlEvent::onRemoteControlStatus() callback event sent by SDK when receiving the decline request of the remote control and then exists the sharing status at the end of callback event.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableDeclineRemoteControlResponseDlg(bEnable) → {Number}

Description:
  • Set the visibility of the dialog box when the request of the remote control is refused. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the dialog box. FALSE not. If it is FALSE, the user can deal with this request in the IMeetingRemoteCtrlEvent::onRemoteControlStatus() callback event sent by SDK when receiving the decline request of the remote control and then exists the sharing status at the end of callback event.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableEnterAndExitFullScreenButtonOnMeetingUI(bEnable) → {Number}

Description:
  • Enable Set the visibility of the buttons to enter or exit the full screen in the meeting window. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the button. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableEnterAndExitFullScreenButtonOnMeetingUI(bEnable) → {Number}

Description:
  • Enable Set the visibility of the buttons to enter or exit the full screen in the meeting window. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the button. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableForceAutoStartMyVideoWhenJoinMeeting(bEnable) → {Number}

Description:
  • Force to enable the video when join meeting. The default behavior depends on the configuration of the meeting.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to force to start video.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableForceAutoStartMyVideoWhenJoinMeeting(bEnable) → {Number}

Description:
  • Force to enable the video when join meeting. The default behavior depends on the configuration of the meeting.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to force to start video.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableForceAutoStopMyVideoWhenJoinMeeting(bEnable) → {Number}

Description:
  • Force to turn off video when joining the meeting. The default behavior depends on the configuration of the meeting.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to force to turn off the video.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableForceAutoStopMyVideoWhenJoinMeeting(bEnable) → {Number}

Description:
  • Force to turn off video when joining the meeting. The default behavior depends on the configuration of the meeting.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to force to turn off the video.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableGrabShareWithoutReminder(bEnable) → {Number}

Description:
  • Set whether to close the current sharing of another user without prompt and directly beginning a new sharing content by the closer. Default value: FALSE(prompt).
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates no prompt. FALSE not.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableGrabShareWithoutReminder(bEnable) → {Number}

Description:
  • Set whether to close the current sharing of another user without prompt and directly beginning a new sharing content by the closer. Default value: FALSE(prompt).
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates no prompt. FALSE not.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableInputMeetingPasswordDlg(bEnable) → {Number}

Description:
  • Set the visibility of the dialog box to input the password. Default: TRUE. If it is disabled, the SDK will trigger onInputMeetingPasswordAndScreenNameNotification()callback event when the user is asked to re-enter the password, then the user shall deal with the subsequent logic.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the dialog box to input password. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableInputMeetingPasswordDlg(bEnable) → {Number}

Description:
  • Set the visibility of the dialog box to input the password. Default: TRUE. If it is disabled, the SDK will trigger onInputMeetingPasswordAndScreenNameNotification()callback event when the user is asked to re-enter the password, then the user shall deal with the subsequent logic.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the dialog box to input password. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableInputMeetingScreenNameDlg(bEnable) → {Number}

Description:
  • Set the visibility of the dialog box to input the screen name. Default: TRUE. If it is false, the SDK will trigger IMeetingConfigurationEvent::onInputMeetingPasswordAndScreenNameNotification()callback event when the user is asked to re-enter the screen name, then the user shall deal with the subsequent logic.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the dialog box to input the screen name which is to be displayed in the meeting. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableInputMeetingScreenNameDlg(bEnable) → {Number}

Description:
  • Set the visibility of the dialog box to input the screen name. Default: TRUE. If it is false, the SDK will trigger IMeetingConfigurationEvent::onInputMeetingPasswordAndScreenNameNotification()callback event when the user is asked to re-enter the screen name, then the user shall deal with the subsequent logic.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the dialog box to input the screen name which is to be displayed in the meeting. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableInviteButtonOnMeetingUI(bEnable) → {Number}

Description:
  • Set the visibility of the INVITE button in the panelist action bar during the meeting. Default value: TRUE. The user will receive the IMeetingUIControllerEvent::onInviteBtnClicked() callback event when he clicks the INVITE button. If the callback event is not handled, the SDK will pop up a Zoom custom invitation dialog. The user will receive the IMeetingUIControllerEvent::onZoomInviteDialogFailed() callback event if the dialog box is failed to display.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the button. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableInviteButtonOnMeetingUI(bEnable) → {Number}

Description:
  • Set the visibility of the INVITE button in the panelist action bar during the meeting. Default value: TRUE. The user will receive the IMeetingUIControllerEvent::onInviteBtnClicked() callback event when he clicks the INVITE button. If the callback event is not handled, the SDK will pop up a Zoom custom invitation dialog. The user will receive the IMeetingUIControllerEvent::onZoomInviteDialogFailed() callback event if the dialog box is failed to display.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the button. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableInviteLinkOnMeetingUI(bEnable) → {Boolean}

Description:
  • Set the visibility of the INVITE link during the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the link. Otherwise not.
Returns:
Type
Boolean

(inner) MeetingConfig_EnableInviteLinkOnMeetingUI(bEnable) → {Boolean}

Description:
  • Set the visibility of the INVITE link during the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the link. Otherwise not.
Returns:
Type
Boolean

(inner) MeetingConfig_EnableLButtonDBClick4SwitchFullScreenMode(bEnable) → {Number}

Description:
  • Set if it is able to switch between the full screen mode and normal mode by double-click. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to switch. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableLButtonDBClick4SwitchFullScreenMode(bEnable) → {Number}

Description:
  • Set if it is able to switch between the full screen mode and normal mode by double-click. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to switch. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableLeaveMeetingOptionForHost(bEnable) → {Number}

Description:
  • Set the visibility of the LEAVE MEETING button on the pop-up dialogue box when the host leaves the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the button. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableLeaveMeetingOptionForHost(bEnable) → {Number}

Description:
  • Set the visibility of the LEAVE MEETING button on the pop-up dialogue box when the host leaves the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the button. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableLengthLimitationOfMeetingNumber(bEnable) → {Number}

Description:
  • Set if it is able to limit the length of meeting ID. Default: FALSE. If it is enabled, the length of the meeting ID depends on the ID type. The ID shall be more than nine(9) figures or five(5) letters. Also, The meeting ID will be displayed as it is (not formatted).
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to limit the length of meeting ID. FALSE not
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableLengthLimitationOfMeetingNumber(bEnable) → {Number}

Description:
  • Set if it is able to limit the length of meeting ID. Default: FALSE. If it is enabled, the length of the meeting ID depends on the ID type. The ID shall be more than nine(9) figures or five(5) letters. Also, The meeting ID will be displayed as it is (not formatted).
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to limit the length of meeting ID. FALSE not
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableLocalRecordingConvertProgressBarDialog(bShow) → {Number}

Description:
  • Set the visibility of the local recording convert progress bar dialog. Default: TRUE
Source:
Parameters:
Name Type Description
bShow Boolean TRUE indicates to show the dialog box. FALSE not
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableLocalRecordingConvertProgressBarDialog(bShow) → {Number}

Description:
  • Set the visibility of the local recording convert progress bar dialog. Default: TRUE
Source:
Parameters:
Name Type Description
bShow Boolean TRUE indicates to show the dialog box. FALSE not
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableShareIOSDevice(bEnable) → {Number}

Description:
  • Set if it is able to share IOS device. Default: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to enable to share. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableShareIOSDevice(bEnable) → {Number}

Description:
  • Set if it is able to share IOS device. Default: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to enable to share. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableShareWhiteBoard(bEnable) → {Number}

Description:
  • Set if it is able to share white board. Default: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to enable to share on the white board. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableShareWhiteBoard(bEnable) → {Number}

Description:
  • Set if it is able to share white board. Default: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to enable to share on the white board. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableShowShareSwitchMultiToSingleConfirmDlg(bEnable) → {Number}

Description:
  • Set the visibility of the SWITCH TO SINGLE PARTICIPANT SHARE dialog box when multiple participants are sharing and the user try to change the setting to single share. Default: TURE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to show dialog box if the multishare option is changed. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableShowShareSwitchMultiToSingleConfirmDlg(bEnable) → {Number}

Description:
  • Set the visibility of the SWITCH TO SINGLE PARTICIPANT SHARE dialog box when multiple participants are sharing and the user try to change the setting to single share. Default: TURE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to show dialog box if the multishare option is changed. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableToolTipsShow(bEnable) → {Number}

Description:
  • Set if it is able to temporarily show tooltip of the button in the toolbar of the meeting and user can close it by click the "x". Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to enable to show the tooltip in the meeting. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableToolTipsShow(bEnable) → {Number}

Description:
  • Set if it is able to temporarily show tooltip of the button in the toolbar of the meeting and user can close it by click the "x". Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to enable to show the tooltip in the meeting. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableVideoButtonOnMeetingUI(bEnable) → {Number}

Description:
  • Set the visibility of the Video button in the toolbar during the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the button. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableVideoButtonOnMeetingUI(bEnable) → {Number}

Description:
  • Set the visibility of the Video button in the toolbar during the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the button. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableZoomDocs(bEnable) → {Number}

Description:
  • Enable or disable zoom docs features in custom UI. This is disabled by default.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to enable the zoom docs feature, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_EnableZoomDocs(bEnable) → {Number}

Description:
  • Enable or disable zoom docs features in custom UI. This is disabled by default.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to enable the zoom docs feature, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_ForceDisableMultiShare(bDisable) → {Number}

Description:
  • Set whether to forbid multi-share. Default: FALSE.
Source:
Parameters:
Name Type Description
bDisable Boolean TRUE indicates to forbid multi-share. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_ForceDisableMultiShare(bDisable) → {Number}

Description:
  • Set whether to forbid multi-share. Default: FALSE.
Source:
Parameters:
Name Type Description
bDisable Boolean TRUE indicates to forbid multi-share. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_GetArchiveConfirmContent() → {String}

Description:
  • The content that notifies the user to confirm starting to archive when joining the meeting.
Source:
Returns:
If the function succeeds, the return value is the content that notifies the user to confirm starting to archive when joining the meeting.
Type
String

(inner) MeetingConfig_GetArchiveConfirmContent() → {String}

Description:
  • The content that notifies the user to confirm starting to archive when joining the meeting.
Source:
Returns:
If the function succeeds, the return value is the content that notifies the user to confirm starting to archive when joining the meeting.
Type
String

(inner) MeetingConfig_GetDefaultDisplayName() → {String}

Description:
  • Get default display name.
Source:
Returns:
If the function succeeds, the return value is the default display name.
Type
String

(inner) MeetingConfig_GetDefaultDisplayName() → {String}

Description:
  • Get default display name.
Source:
Returns:
If the function succeeds, the return value is the default display name.
Type
String

(inner) MeetingConfig_GetRequiredInfoType() → {Number}

Description:
  • Get the type of required information to be completed.
Source:
Returns:
If the function succeed, the return is defined in: RequiredInfoType
Type
Number

(inner) MeetingConfig_GetRequiredInfoType() → {Number}

Description:
  • Get the type of required information to be completed.
Source:
Returns:
If the function succeed, the return is defined in: RequiredInfoType
Type
Number

(inner) MeetingConfig_GetWebinarNeedRegisterType() → {Number}

Description:
  • Get the type to register.
Source:
Returns:
Defined in: WebinarNeedRegisterType
Type
Number

(inner) MeetingConfig_GetWebinarNeedRegisterType() → {Number}

Description:
  • Get the type to register.
Source:
Returns:
Defined in: WebinarNeedRegisterType
Type
Number

(inner) MeetingConfig_GetWebinarRegisterUrl() → {String}

Description:
  • Get the URL to register webinar.
Source:
Returns:
If the function succeed, the return value is an URL.
Type
String

(inner) MeetingConfig_GetWebinarRegisterUrl() → {String}

Description:
  • Get the URL to register webinar.
Source:
Returns:
If the function succeed, the return value is an URL.
Type
String

(inner) MeetingConfig_HideChatItemOnMeetingUI(bEnable) → {Number}

Description:
  • Set whether to display the button CHAT and menu item. Default is displaying.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE means hiding, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideChatItemOnMeetingUI(bEnable) → {Number}

Description:
  • Set whether to display the button CHAT and menu item. Default is displaying.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE means hiding, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideCopyInvitationOnInviteWindow(bEnable) → {Number}

Description:
  • Set the visibility of CopyInvitation button on invite window, Default: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide, FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideCopyInvitationOnInviteWindow(bEnable) → {Number}

Description:
  • Set the visibility of CopyInvitation button on invite window, Default: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide, FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideCopyUrlOnInviteWindow(bEnable) → {Number}

Description:
  • Set the visibility of CopyURL button on invite window, Default: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide, FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideCopyUrlOnInviteWindow(bEnable) → {Number}

Description:
  • Set the visibility of CopyURL button on invite window, Default: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide, FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideKeypadButtonOnMeetingWindow(bEnable) → {Number}

Description:
  • Set the visibility of Keypad button on meeting window, Default: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide, FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideKeypadButtonOnMeetingWindow(bEnable) → {Number}

Description:
  • Set the visibility of Keypad button on meeting window, Default: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide, FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HidePollOnMeetingUI(bEnable) → {Number}

Description:
  • Set the visibility of poll on meeting UI. Default is displaying.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE means hiding, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HidePollOnMeetingUI(bEnable) → {Number}

Description:
  • Set the visibility of poll on meeting UI. Default is displaying.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE means hiding, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideQAOnMeetingUI(bEnable) → {Number}

Description:
  • Set the visibility of Q&A on meeting UI. Default is displaying.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE means hiding, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideQAOnMeetingUI(bEnable) → {Number}

Description:
  • Set the visibility of Q&A on meeting UI. Default is displaying.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE means hiding, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideRecordItemOnMeetingUI(bEnable) → {Number}

Description:
  • Set whether to display the button RECORD and menu item. Default is displaying.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE means hiding, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideRecordItemOnMeetingUI(bEnable) → {Number}

Description:
  • Set whether to display the button RECORD and menu item. Default is displaying.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE means hiding, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideRemoteControlOnMeetingUI(bEnable) → {Number}

Description:
  • Set whether to display the button REMOTE CONTROL and menu item. Default is displaying. If the calling of API with parameter TRUE is successful, SDK will call EnableApproveRemoteControlDlg(false) by default.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE means hiding, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideRemoteControlOnMeetingUI(bEnable) → {Number}

Description:
  • Set whether to display the button REMOTE CONTROL and menu item. Default is displaying. If the calling of API with parameter TRUE is successful, SDK will call EnableApproveRemoteControlDlg(false) by default.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE means hiding, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideSwitchCameraButton(bEnable) → {Number}

Description:
  • Set the visibility of Switch Camera button on 2nd camera share window,Default: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide the Switch Camera button. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideSwitchCameraButton(bEnable) → {Number}

Description:
  • Set the visibility of Switch Camera button on 2nd camera share window,Default: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to hide the Switch Camera button. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideUpgradeFreeMeetingButton(bEnable) → {Number}

Description:
  • Set whether to display the button UPGRADE when prompt the tooltip of free meeting counts down. Default is displaying.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE means hiding, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_HideUpgradeFreeMeetingButton(bEnable) → {Number}

Description:
  • Set whether to display the button UPGRADE when prompt the tooltip of free meeting counts down. Default is displaying.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE means hiding, otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_InputMeetingIDAndScreenName(meetingID, screenName) → {Boolean}

Description:
  • Complete the meeting id and screen name information. The SDK will destroy the object instance after calling this function. Supplement with the correct information.
Source:
Parameters:
Name Type Description
meetingID String
screenName String
Returns:
Type
Boolean

(inner) MeetingConfig_InputMeetingIDAndScreenName(meetingID, screenName) → {Boolean}

Description:
  • Complete the meeting id and screen name information. The SDK will destroy the object instance after calling this function. Supplement with the correct information.
Source:
Parameters:
Name Type Description
meetingID String
screenName String
Returns:
Type
Boolean

(inner) MeetingConfig_InputMeetingPasswordAndScreenName(meeting_Password, screenName) → {Boolean}

Description:
  • Complete the password and screen name information. The SDK will destroy the object instance after calling this function. Supplement with the correct information.
Source:
Parameters:
Name Type Description
meeting_Password String
screenName String
Returns:
Type
Boolean

(inner) MeetingConfig_InputMeetingPasswordAndScreenName(meeting_Password, screenName) → {Boolean}

Description:
  • Complete the password and screen name information. The SDK will destroy the object instance after calling this function. Supplement with the correct information.
Source:
Parameters:
Name Type Description
meeting_Password String
screenName String
Returns:
Type
Boolean

(inner) MeetingConfig_InputMeetingScreenName(screenName) → {Boolean}

Description:
  • Complete the screen name. The SDK will destroy this object instance after calling this function. Complete the information by the correct function.
Source:
Parameters:
Name Type Description
screenName String
Returns:
Type
Boolean

(inner) MeetingConfig_InputMeetingScreenName(screenName) → {Boolean}

Description:
  • Complete the screen name. The SDK will destroy this object instance after calling this function. Complete the information by the correct function.
Source:
Parameters:
Name Type Description
screenName String
Returns:
Type
Boolean

(inner) MeetingConfig_InputScreenName(screenName) → {Number}

Description:
  • Input screen name to join webinar. The SDK will destroy this object instance after calling this function. Supplement with the correct information.
Source:
Parameters:
Name Type Description
screenName String The display name for the webinar.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_InputScreenName(screenName) → {Number}

Description:
  • Input screen name to join webinar. The SDK will destroy this object instance after calling this function. Supplement with the correct information.
Source:
Parameters:
Name Type Description
screenName String The display name for the webinar.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_InputUserInfo(name, email) → {Number}

Description:
  • Complete the name and email information. The SDK will destroy this object instance after calling this function. Supplement with the correct information.
Source:
Parameters:
Name Type Description
name String
email String
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_InputUserInfo(name, email) → {Number}

Description:
  • Complete the name and email information. The SDK will destroy this object instance after calling this function. Supplement with the correct information.
Source:
Parameters:
Name Type Description
name String
email String
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_InputWebinarRegisterEmailAndScreenName(email, screenName) → {Number}

Description:
  • Configure the information of email and screen name. The SDK will destroy this object instance after calling this function. Supplement with the correct information.
Source:
Parameters:
Name Type Description
email String
screenName String
Returns:
Type
Number

(inner) MeetingConfig_InputWebinarRegisterEmailAndScreenName(email, screenName) → {Number}

Description:
  • Configure the information of email and screen name. The SDK will destroy this object instance after calling this function. Supplement with the correct information.
Source:
Parameters:
Name Type Description
email String
screenName String
Returns:
Type
Number

(inner) MeetingConfig_IsValidEmail(email) → {Boolean}

Description:
  • Check whether the inputed email is a valid email format.
Source:
Parameters:
Name Type Description
email String The email must meet the email format requirements.The email input by the logged in user must be the email of the logged in account.
Returns:
true if the email input is valid
Type
Boolean

(inner) MeetingConfig_IsValidEmail(email) → {Boolean}

Description:
  • Check whether the inputed email is a valid email format.
Source:
Parameters:
Name Type Description
email String The email must meet the email format requirements.The email input by the logged in user must be the email of the logged in account.
Returns:
true if the email input is valid
Type
Boolean

(inner) MeetingConfig_JoinWithArchive(bStartArchive) → {Boolean}

Description:
  • Join the meeting.
Source:
Parameters:
Name Type Description
bStartArchive Boolean true means start the archive when joining the meeting, false means do not start the archive when joining the meeting.
Returns:
Type
Boolean

(inner) MeetingConfig_JoinWithArchive(bStartArchive) → {Boolean}

Description:
  • Join the meeting.
Source:
Parameters:
Name Type Description
bStartArchive Boolean true means start the archive when joining the meeting, false means do not start the archive when joining the meeting.
Returns:
Type
Boolean

(inner) MeetingConfig_MeetingPasswordAndScreenNameHandler_Cancel() → {Number}

Description:
  • Meeting Password And Screen Name Handler Cancel
Source:
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_MeetingPasswordAndScreenNameHandler_Cancel() → {Number}

Description:
  • Meeting Password And Screen Name Handler Cancel
Source:
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_PrePopulateWebinarRegistrationInfo(email, userName) → {Number}

Description:
  • Pre-set email and username information before joining the webinar.
Source:
Parameters:
Name Type Description
email String Configure the default email.
userName String Configure default username.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_PrePopulateWebinarRegistrationInfo(email, userName) → {Number}

Description:
  • Pre-set email and username information before joining the webinar.
Source:
Parameters:
Name Type Description
email String Configure the default email.
userName String Configure default username.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickAudioBTNEvent(bRedirect) → {Number}

Description:
  • Set if it is able to handle the event with SDK user's own program by clicking Audio button in the meeting. Default value: FALSE. If the user calls this function to convert, the SDK will trigger the onAudioBtnClicked(AudioBtnClickedCallbackInfo info), and the user shall deal with the subsequent logic himself.
Source:
Parameters:
Name Type Description
bRedirect Boolean TRUE indicates to handle with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickAudioBTNEvent(bRedirect) → {Number}

Description:
  • Set if it is able to handle the event with SDK user's own program by clicking Audio button in the meeting. Default value: FALSE. If the user calls this function to convert, the SDK will trigger the onAudioBtnClicked(AudioBtnClickedCallbackInfo info), and the user shall deal with the subsequent logic himself.
Source:
Parameters:
Name Type Description
bRedirect Boolean TRUE indicates to handle with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickAudioMenuBTNEvent(bRedirect) → {Number}

Description:
  • Set if it is able to handle the event with SDK user's own program by clicking Audio Menu button in the meeting. Default value: FALSE. If the user calls this function to convert, the SDK will trigger the onAudioMenuBtnClicked(), and the user shall deal with the subsequent logic himself.
Source:
Parameters:
Name Type Description
bRedirect Boolean TRUE indicates to handle with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickAudioMenuBTNEvent(bRedirect) → {Number}

Description:
  • Set if it is able to handle the event with SDK user's own program by clicking Audio Menu button in the meeting. Default value: FALSE. If the user calls this function to convert, the SDK will trigger the onAudioMenuBtnClicked(), and the user shall deal with the subsequent logic himself.
Source:
Parameters:
Name Type Description
bRedirect Boolean TRUE indicates to handle with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickCCBTNEvent(bEnable) → {Number}

Description:
  • Set if it is able to handle the event with SDK user's own program by clicking Closed Caption button in the meeting. Default value: FALSE. If the user calls this function to convert, the SDK will trigger the onCCBTNClicked(), and the user shall deal with the subsequent logic himself.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to handle with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickCCBTNEvent(bEnable) → {Number}

Description:
  • Set if it is able to handle the event with SDK user's own program by clicking Closed Caption button in the meeting. Default value: FALSE. If the user calls this function to convert, the SDK will trigger the onCCBTNClicked(), and the user shall deal with the subsequent logic himself.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to handle with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickCustomLiveStreamMenuEvent(bEnable) → {Number}

Description:
  • Set if it is able to handle the event with SDK user's own program by clicking CUSTOM LIVE STREAM button in the meeting. Default value: FALSE. If the user calls this function to convert, the SDK will trigger the onCustomLiveStreamMenuClicked() instead of jumping to the live video page when clicking on the custom live stream, then deal with the subsequent logic.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to handle with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickCustomLiveStreamMenuEvent(bEnable) → {Number}

Description:
  • Set if it is able to handle the event with SDK user's own program by clicking CUSTOM LIVE STREAM button in the meeting. Default value: FALSE. If the user calls this function to convert, the SDK will trigger the onCustomLiveStreamMenuClicked() instead of jumping to the live video page when clicking on the custom live stream, then deal with the subsequent logic.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to handle with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickEndMeetingBTNEvent(bEnable) → {Number}

Description:
  • Set if it is able to handle the event with user's own program by clicking END MEETING button in the meeting. Default value: FALSE. The SDK won't end the meeting if the user calls this function and set to convert. The user will deal with the subsequent logic after receiving the onEndMeetingBtnClicked() callback event.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to handle with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickEndMeetingBTNEvent(bEnable) → {Number}

Description:
  • Set if it is able to handle the event with user's own program by clicking END MEETING button in the meeting. Default value: FALSE. The SDK won't end the meeting if the user calls this function and set to convert. The user will deal with the subsequent logic after receiving the onEndMeetingBtnClicked() callback event.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to handle with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickParticipantListBTNEvent(bEnable) → {Number}

Description:
  • Set if it is able to handle the event with SDK user's own program by clicking PARTICIPANT LIST button in the meeting. Default value: FALSE. The list won't unfold by clicking participant list button if the user calls this function to set to convert. The SDK will trigger the onParticipantListBtnClicked(), and the user shall deal with the subsequent logic himself.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to handle with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickParticipantListBTNEvent(bEnable) → {Number}

Description:
  • Set if it is able to handle the event with SDK user's own program by clicking PARTICIPANT LIST button in the meeting. Default value: FALSE. The list won't unfold by clicking participant list button if the user calls this function to set to convert. The SDK will trigger the onParticipantListBtnClicked(), and the user shall deal with the subsequent logic himself.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to handle with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickShareBTNEvent(bEnable) → {Number}

Description:
  • Set if it is able to handle the event with user's own program by clicking START SHARE button in the meeting. Default value: FALSE. The SDK won't enable the share if the user calls this function and sets to convert. The user will deal with the subsequent logic after receiving the onStartShareBtnClicked() callback event.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to deal with the event with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectClickShareBTNEvent(bEnable) → {Number}

Description:
  • Set if it is able to handle the event with user's own program by clicking START SHARE button in the meeting. Default value: FALSE. The SDK won't enable the share if the user calls this function and sets to convert. The user will deal with the subsequent logic after receiving the onStartShareBtnClicked() callback event.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to deal with the event with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectConfirmStartArchiveDialog(bRedirect) → {Number}

Description:
  • Set if it is able to handle the confirm start archive dialog dlg with user's own program in the meeting. Default: FALSE.
Source:
Parameters:
Name Type Description
bRedirect Boolean TRUE indicates to redirect. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectConfirmStartArchiveDialog(bRedirect) → {Number}

Description:
  • Set if it is able to handle the confirm start archive dialog dlg with user's own program in the meeting. Default: FALSE.
Source:
Parameters:
Name Type Description
bRedirect Boolean TRUE indicates to redirect. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectEndOtherMeeting(bEnable) → {Number}

Description:
  • Set if it is able to redirect the process to end another meeting by user's own program. Default: FALSE. This function doesn't work if the IJoinMeetingBehaviorConfiguration::EnableAutoEndOtherMeetingWhenStartMeeting(true) is also called. If redirect successfully, the SDK will trigger the IMeetingConfigurationEvent::onEndOtherMeetingToJoinMeetingNotification() callback event.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to redirect. FALSE not. If it is TRUE, the SDK will trigger the onEndOtherMeetingToJoinMeetingNotification().
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectEndOtherMeeting(bEnable) → {Number}

Description:
  • Set if it is able to redirect the process to end another meeting by user's own program. Default: FALSE. This function doesn't work if the IJoinMeetingBehaviorConfiguration::EnableAutoEndOtherMeetingWhenStartMeeting(true) is also called. If redirect successfully, the SDK will trigger the IMeetingConfigurationEvent::onEndOtherMeetingToJoinMeetingNotification() callback event.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to redirect. FALSE not. If it is TRUE, the SDK will trigger the onEndOtherMeetingToJoinMeetingNotification().
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectFreeMeetingEndingReminderDlg(bEnable) → {Number}

Description:
  • An upgrade dialog box will pop up when the free meeting is over. Use this function to set if it is able to handle the reminder message with user's own program. Default value: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to handle the reminder message with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectFreeMeetingEndingReminderDlg(bEnable) → {Number}

Description:
  • An upgrade dialog box will pop up when the free meeting is over. Use this function to set if it is able to handle the reminder message with user's own program. Default value: FALSE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to handle the reminder message with user's own program. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectMeetingInputUserInfoDialog(bRedirect) → {Number}

Description:
  • Set the visibility of the OPTIMIZE FOR FULL SCREEN VIDEO CLIP check-box in the sharing window. Default value: TRUE.
Source:
Parameters:
Name Type Description
bRedirect Boolean TRUE indicates to display. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectMeetingInputUserInfoDialog(bRedirect) → {Number}

Description:
  • Set the visibility of the OPTIMIZE FOR FULL SCREEN VIDEO CLIP check-box in the sharing window. Default value: TRUE.
Source:
Parameters:
Name Type Description
bRedirect Boolean TRUE indicates to display. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectMeetingWarningMsg(bRedirectBadNetwork, bRedirectWarnHighCPU) → {Number}

Description:
  • Set if it is able to handle the warning message with SDK user's own program in the meeting. Default value: None.
Source:
Parameters:
Name Type Description
bRedirectBadNetwork Boolean
bRedirectWarnHighCPU Boolean
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectMeetingWarningMsg(bRedirectBadNetwork, bRedirectWarnHighCPU) → {Number}

Description:
  • Set if it is able to handle the warning message with SDK user's own program in the meeting. Default value: None.
Source:
Parameters:
Name Type Description
bRedirectBadNetwork Boolean
bRedirectWarnHighCPU Boolean
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectWebinarNeedRegister(bEnable) → {Number}

Description:
  • Set if it is able to handle the webinar register process with user's own program in the meeting. Default: FALSE. If it is true, the SDK will trigger the IMeetingConfigurationEvent::onWebinarNeedRegisterNotification()callback event.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to redirect. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_RedirectWebinarNeedRegister(bEnable) → {Number}

Description:
  • Set if it is able to handle the webinar register process with user's own program in the meeting. Default: FALSE. If it is true, the SDK will trigger the IMeetingConfigurationEvent::onWebinarNeedRegisterNotification()callback event.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to redirect. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_ReleaseRegisterWebinarByUrl() → {Number}

Description:
  • Release Register Webinar By Url
Source:
Returns:
Type
Number

(inner) MeetingConfig_ReleaseRegisterWebinarByUrl() → {Number}

Description:
  • Release Register Webinar By Url
Source:
Returns:
Type
Number

(inner) MeetingConfig_Reset() → {Number}

Description:
  • Reset the meeting configuration and back to the default state.
Source:
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_Reset() → {Number}

Description:
  • Reset the meeting configuration and back to the default state.
Source:
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetAirPlayInstructionWndNotificationCB(onAirPlayInstructionWndNotification) → {Boolean}

Description:
  • Set Air Play Instruction Wnd Notification Callback
Source:
Parameters:
Name Type Description
onAirPlayInstructionWndNotification function
Returns:
Type
Boolean

(inner) MeetingConfig_SetAirPlayInstructionWndNotificationCB(onAirPlayInstructionWndNotification) → {Boolean}

Description:
  • Set Air Play Instruction Wnd Notification Callback
Source:
Parameters:
Name Type Description
onAirPlayInstructionWndNotification function
Returns:
Type
Boolean

(inner) MeetingConfig_SetBottomFloatToolbarWndVisibility(bShow) → {Number}

Description:
  • Set the visibility of the toolbar at the bottom of the meeting window. Default value: TRUE.
Source:
Parameters:
Name Type Description
bShow Boolean TRUE means to enable the feature to display always the toolbar at the bottom. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetBottomFloatToolbarWndVisibility(bShow) → {Number}

Description:
  • Set the visibility of the toolbar at the bottom of the meeting window. Default value: TRUE.
Source:
Parameters:
Name Type Description
bShow Boolean TRUE means to enable the feature to display always the toolbar at the bottom. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetDirectShareMonitorID(monitorID) → {Number}

Description:
  • Set the shared device ID when sharing directly.
Source:
Parameters:
Name Type Description
monitorID String Specify the device ID to be shared.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetDirectShareMonitorID(monitorID) → {Number}

Description:
  • Set the shared device ID when sharing directly.
Source:
Parameters:
Name Type Description
monitorID String Specify the device ID to be shared.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetFloatVideoPos(left, top, hSelfWnd, hParent) → {Number}

Description:
  • Set the position of the floating video window when sharing. The value shall be set before the sharing begins. If you set the value during the process of share, the function will not be valid until the next share.
Source:
Parameters:
Name Type Description
left String Specify the left position of the floating video window when sharing.
top String Specify the top position of the floating video window when sharing.
hSelfWnd String SelfWnd (require hexadecimal)
hParent String parent window handle (require hexadecimal)
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetFloatVideoPos(left, top, hSelfWnd, hParent) → {Number}

Description:
  • Set the position of the floating video window when sharing. The value shall be set before the sharing begins. If you set the value during the process of share, the function will not be valid until the next share.
Source:
Parameters:
Name Type Description
left String Specify the left position of the floating video window when sharing.
top String Specify the top position of the floating video window when sharing.
hSelfWnd String SelfWnd (require hexadecimal)
hParent String parent window handle (require hexadecimal)
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetFloatVideoWndVisibility(bShow) → {Number}

Description:
  • Set the visibility of the floating video window when sharing in the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bShow Boolean TRUE indicates to display the floating video window. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetFloatVideoWndVisibility(bShow) → {Number}

Description:
  • Set the visibility of the floating video window when sharing in the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bShow Boolean TRUE indicates to display the floating video window. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetFreeMeetingNeedToUpgradeCB(onFreeMeetingNeedToUpgrade) → {Boolean}

Description:
  • Set the callback of upgrading the free meeting.
Source:
Parameters:
Name Type Description
onFreeMeetingNeedToUpgrade function
Returns:
Type
Boolean

(inner) MeetingConfig_SetFreeMeetingNeedToUpgradeCB(onFreeMeetingNeedToUpgrade) → {Boolean}

Description:
  • Set the callback of upgrading the free meeting.
Source:
Parameters:
Name Type Description
onFreeMeetingNeedToUpgrade function
Returns:
Type
Boolean

(inner) MeetingConfig_SetFreeMeetingUpgradeToGiftFreeTrialStartCB(onFreeMeetingUpgradeToGiftFreeTrialStart) → {Boolean}

Description:
  • Set the callback function of starting to upgrade the free meeting by the gift link.
Source:
Parameters:
Name Type Description
onFreeMeetingUpgradeToGiftFreeTrialStart function
Returns:
Type
Boolean

(inner) MeetingConfig_SetFreeMeetingUpgradeToGiftFreeTrialStartCB(onFreeMeetingUpgradeToGiftFreeTrialStart) → {Boolean}

Description:
  • Set the callback function of starting to upgrade the free meeting by the gift link.
Source:
Parameters:
Name Type Description
onFreeMeetingUpgradeToGiftFreeTrialStart function
Returns:
Type
Boolean

(inner) MeetingConfig_SetFreeMeetingUpgradeToGiftFreeTrialStopCB(onFreeMeetingUpgradeToGiftFreeTrialStop) → {Boolean}

Description:
  • Set the callback of ending upgrade the free meeting by the gift link.
Source:
Parameters:
Name Type Description
onFreeMeetingUpgradeToGiftFreeTrialStop function
Returns:
Type
Boolean

(inner) MeetingConfig_SetFreeMeetingUpgradeToGiftFreeTrialStopCB(onFreeMeetingUpgradeToGiftFreeTrialStop) → {Boolean}

Description:
  • Set the callback of ending upgrade the free meeting by the gift link.
Source:
Parameters:
Name Type Description
onFreeMeetingUpgradeToGiftFreeTrialStop function
Returns:
Type
Boolean

(inner) MeetingConfig_SetFreeMeetingUpgradeToProMeetingCB(onFreeMeetingUpgradeToProMeeting) → {Boolean}

Description:
  • Set the callback of free meting upgrades successfully.
Source:
Parameters:
Name Type Description
onFreeMeetingUpgradeToProMeeting function
Returns:
Type
Boolean

(inner) MeetingConfig_SetFreeMeetingUpgradeToProMeetingCB(onFreeMeetingUpgradeToProMeeting) → {Boolean}

Description:
  • Set the callback of free meting upgrades successfully.
Source:
Parameters:
Name Type Description
onFreeMeetingUpgradeToProMeeting function
Returns:
Type
Boolean

(inner) MeetingConfig_SetInputMeetingPasswordAndScreenNameNotificationCB(onInputMeetingPasswordAndScreenNameNotification) → {Boolean}

Description:
  • Set Input Meeting Password And Screen Name Notification Callback
Source:
Parameters:
Name Type Description
onInputMeetingPasswordAndScreenNameNotification function
Returns:
Type
Boolean

(inner) MeetingConfig_SetInputMeetingPasswordAndScreenNameNotificationCB(onInputMeetingPasswordAndScreenNameNotification) → {Boolean}

Description:
  • Set Input Meeting Password And Screen Name Notification Callback
Source:
Parameters:
Name Type Description
onInputMeetingPasswordAndScreenNameNotification function
Returns:
Type
Boolean

(inner) MeetingConfig_SetMaxDurationForOnlyHostInMeeting(nDuration) → {Number}

Description:
  • Set the maximum duration of the meeting when there is no attendee in the meeting. Default: 24*60
Source:
Parameters:
Name Type Description
nDuration Number Specify the maximum duration in minutes
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetMaxDurationForOnlyHostInMeeting(nDuration) → {Number}

Description:
  • Set the maximum duration of the meeting when there is no attendee in the meeting. Default: 24*60
Source:
Parameters:
Name Type Description
nDuration Number Specify the maximum duration in minutes
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetMeetingUIPos(left, top, hSelfWnd, hParent) → {Number}

Description:
  • Set the position of the primary view meeting window.
Source:
Parameters:
Name Type Description
left String Specify the left position of the primary view meeting window. The coordinates of the window are those of the screen.
top String Specify the top position of the primary view meeting window. The coordinates of the window are those of the screen.
hSelfWnd String (require hexadecimal)
hParent String (require hexadecimal)
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetMeetingUIPos(left, top, hSelfWnd, hParent) → {Number}

Description:
  • Set the position of the primary view meeting window.
Source:
Parameters:
Name Type Description
left String Specify the left position of the primary view meeting window. The coordinates of the window are those of the screen.
top String Specify the top position of the primary view meeting window. The coordinates of the window are those of the screen.
hSelfWnd String (require hexadecimal)
hParent String (require hexadecimal)
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetSharingToolbarVisibility(bShow) → {Number}

Description:
  • Set the visibility of the sharing toolbar. Default value: TRUE. This function works only before the meeting or the sharing starts.
Source:
Parameters:
Name Type Description
bShow Boolean TRUE means to enable the display sharing toolbar. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetSharingToolbarVisibility(bShow) → {Number}

Description:
  • Set the visibility of the sharing toolbar. Default value: TRUE. This function works only before the meeting or the sharing starts.
Source:
Parameters:
Name Type Description
bShow Boolean TRUE means to enable the display sharing toolbar. Otherwise not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetShowAudioUseComputerSoundChkbox(bEnable) → {Number}

Description:
  • Set the visibility of the SHARE COMPUTER SOUND check-box in the sharing window. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetShowAudioUseComputerSoundChkbox(bEnable) → {Number}

Description:
  • Set the visibility of the SHARE COMPUTER SOUND check-box in the sharing window. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetShowCallInTab(bEnable) → {Number}

Description:
  • Set the visibility of PHONE CALL tab in the audio dialog box when joining the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the tab. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetShowCallInTab(bEnable) → {Number}

Description:
  • Set the visibility of PHONE CALL tab in the audio dialog box when joining the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the tab. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetShowCallMeTab(bEnable) → {Number}

Description:
  • Set the visibility of CALL ME tab in the audio dialog box when joining the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the tab. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetShowCallMeTab(bEnable) → {Number}

Description:
  • Set the visibility of CALL ME tab in the audio dialog box when joining the meeting. Default value: TRUE.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to display the tab. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetShowH323SubTabPage(tabPage, bShow) → {Number}

Description:
  • Set the visibility of some specified tabs in the Room System invitation dialog. Default: show all the content.Default: show all the content.
Source:
Parameters:
Name Type Description
tabPage Number Specify a tab, Defined in: SDKH323TabPage
bShow Boolean TRUE indicates to display the tab. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetShowH323SubTabPage(tabPage, bShow) → {Number}

Description:
  • Set the visibility of some specified tabs in the Room System invitation dialog. Default: show all the content.Default: show all the content.
Source:
Parameters:
Name Type Description
tabPage Number Specify a tab, Defined in: SDKH323TabPage
bShow Boolean TRUE indicates to display the tab. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetShowInviteDlgTabPage(tabPage, bShow) → {Number}

Description:
  • Set the visibility of some specified tabs in the invite dialog. Default: Show all the content.
Source:
Parameters:
Name Type Description
tabPage Number Specify a tab page, Defined in: SDKInviteDlgTabPage
bShow Boolean TRUE indicates to display the tab. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetShowInviteDlgTabPage(tabPage, bShow) → {Number}

Description:
  • Set the visibility of some specified tabs in the invite dialog. Default: Show all the content.
Source:
Parameters:
Name Type Description
tabPage Number Specify a tab page, Defined in: SDKInviteDlgTabPage
bShow Boolean TRUE indicates to display the tab. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetShowVideoOptimizeChkbox(bShow) → {Number}

Description:
  • Set the visibility of the OPTIMIZE FOR FULL SCREEN VIDEO CLIP check-box in the sharing window. Default value: TRUE.
Source:
Parameters:
Name Type Description
bShow Boolean TRUE indicates to display. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetShowVideoOptimizeChkbox(bShow) → {Number}

Description:
  • Set the visibility of the OPTIMIZE FOR FULL SCREEN VIDEO CLIP check-box in the sharing window. Default value: TRUE.
Source:
Parameters:
Name Type Description
bShow Boolean TRUE indicates to display. FALSE not.
Returns:
Defined in: ZoomSDKError
Type
Number

(inner) MeetingConfig_SetonEndOtherMeetingToJoinMeetingNotificationCB(onEndOtherMeetingToJoinMeetingNotification) → {Boolean}

Description:
  • Set on End Other Meeting To Join Meeting Notification Callback
Source:
Parameters:
Name Type Description
onEndOtherMeetingToJoinMeetingNotification function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonEndOtherMeetingToJoinMeetingNotificationCB(onEndOtherMeetingToJoinMeetingNotification) → {Boolean}

Description:
  • Set on End Other Meeting To Join Meeting Notification Callback
Source:
Parameters:
Name Type Description
onEndOtherMeetingToJoinMeetingNotification function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonFreeMeetingRemainTimeCB(onFreeMeetingRemainTime) → {Boolean}

Description:
  • Set on Free Meeting Remain Time Callback
Source:
Parameters:
Name Type Description
onFreeMeetingRemainTime function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonFreeMeetingRemainTimeCB(onFreeMeetingRemainTime) → {Boolean}

Description:
  • Set on Free Meeting Remain Time Callback
Source:
Parameters:
Name Type Description
onFreeMeetingRemainTime function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonFreeMeetingRemainTimeStopCountDownCB(onFreeMeetingRemainTimeStopCountDown) → {Boolean}

Description:
  • Set on Free Meeting Remain Time Stop Count Down Callback
Source:
Parameters:
Name Type Description
onFreeMeetingRemainTimeStopCountDown function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonFreeMeetingRemainTimeStopCountDownCB(onFreeMeetingRemainTimeStopCountDown) → {Boolean}

Description:
  • Set on Free Meeting Remain Time Stop Count Down Callback
Source:
Parameters:
Name Type Description
onFreeMeetingRemainTimeStopCountDown function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonJoinMeetingNeedUserInfoCB(onJoinMeetingNeedUserInfo) → {Boolean}

Description:
  • Set callback is triggered if the user needs to input a username and email, when joining the meeting
Source:
Parameters:
Name Type Description
onJoinMeetingNeedUserInfo function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonJoinMeetingNeedUserInfoCB(onJoinMeetingNeedUserInfo) → {Boolean}

Description:
  • Set callback is triggered if the user needs to input a username and email, when joining the meeting
Source:
Parameters:
Name Type Description
onJoinMeetingNeedUserInfo function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonUserConfirmToStartArchiveCB(onUserConfirmToStartArchive) → {Boolean}

Description:
  • Set callback is triggered when joining a meeting if the admin allows the the user to choose to archive the meeting.
Source:
Parameters:
Name Type Description
onUserConfirmToStartArchive function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonUserConfirmToStartArchiveCB(onUserConfirmToStartArchive) → {Boolean}

Description:
  • Set callback is triggered when joining a meeting if the admin allows the the user to choose to archive the meeting.
Source:
Parameters:
Name Type Description
onUserConfirmToStartArchive function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonWebinarNeedInputScreenNameCB(onWebinarNeedInputScreenName) → {Boolean}

Description:
  • Set callback is triggered if the user needs to input a username, when joining the webinar
Source:
Parameters:
Name Type Description
onWebinarNeedInputScreenName function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonWebinarNeedInputScreenNameCB(onWebinarNeedInputScreenName) → {Boolean}

Description:
  • Set callback is triggered if the user needs to input a username, when joining the webinar
Source:
Parameters:
Name Type Description
onWebinarNeedInputScreenName function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonWebinarNeedRegisterNotificationCB(onWebinarNeedRegisterNotification) → {Boolean}

Description:
  • Set on Webinar Need Register Notification Callback
Source:
Parameters:
Name Type Description
onWebinarNeedRegisterNotification function
Returns:
Type
Boolean

(inner) MeetingConfig_SetonWebinarNeedRegisterNotificationCB(onWebinarNeedRegisterNotification) → {Boolean}

Description:
  • Set on Webinar Need Register Notification Callback
Source:
Parameters:
Name Type Description
onWebinarNeedRegisterNotification function
Returns:
Type
Boolean

Events

onAirPlayInstructionWndNotification

Description:
  • This callback event may be triggered when the user enables the AirPlay introduction.
Source:
Parameters:
Name Type Description
bShow Boolean Show or hide the AirPlay instruction window.
airhostName String The air-host name displayed on IOS device.

onAirPlayInstructionWndNotification

Description:
  • This callback event may be triggered when the user enables the AirPlay introduction.
Source:
Parameters:
Name Type Description
bShow Boolean Show or hide the AirPlay instruction window.
airhostName String The air-host name displayed on IOS device.

onEndOtherMeetingToJoinMeetingNotification

Description:
  • The user will receive this callback event if the user wants to join the new meeting while the ongoing meeting is not ended.
Source:

onEndOtherMeetingToJoinMeetingNotification

Description:
  • The user will receive this callback event if the user wants to join the new meeting while the ongoing meeting is not ended.
Source:

onFreeMeetingNeedToUpgrade

Description:
  • The callback of upgrading the free meeting.
Source:
Parameters:
Name Type Description
type String Type of upgrading the free meeting, FreeMeetingNeedUpgradeType
gift_url String Upgrade the free meeting by the gift link. When and only when the value of type_ is FreeMeetingNeedUpgradeType_BY_GIFTURL, this parameter is meaningful.

onFreeMeetingNeedToUpgrade

Description:
  • The callback of upgrading the free meeting.
Source:
Parameters:
Name Type Description
type String Type of upgrading the free meeting, FreeMeetingNeedUpgradeType
gift_url String Upgrade the free meeting by the gift link. When and only when the value of type_ is FreeMeetingNeedUpgradeType_BY_GIFTURL, this parameter is meaningful.

onFreeMeetingRemainTime

Description:
  • The SDK will trigger this callback event during the free meeting to inform the user how much time is left for a free meeting.
Source:
Parameters:
Name Type Description
leftTime String The left time of meeting calculated in seconds.

onFreeMeetingRemainTime

Description:
  • The SDK will trigger this callback event during the free meeting to inform the user how much time is left for a free meeting.
Source:
Parameters:
Name Type Description
leftTime String The left time of meeting calculated in seconds.

onFreeMeetingRemainTimeStopCountDown

Description:
  • The callback of free meeting stops the countdown.
Source:

onFreeMeetingRemainTimeStopCountDown

Description:
  • The callback of free meeting stops the countdown.
Source:

onFreeMeetingUpgradeToGiftFreeTrialStart

Description:
  • Callback function of starting to upgrade the free meeting by the gift link.
Source:

onFreeMeetingUpgradeToGiftFreeTrialStart

Description:
  • Callback function of starting to upgrade the free meeting by the gift link.
Source:

onFreeMeetingUpgradeToGiftFreeTrialStop

Description:
  • Callback function of ending upgrade the free meeting by the gift link.
Source:

onFreeMeetingUpgradeToGiftFreeTrialStop

Description:
  • Callback function of ending upgrade the free meeting by the gift link.
Source:

onFreeMeetingUpgradeToProMeeting

Description:
  • Callback function of free meting upgrades successfully.
Source:

onFreeMeetingUpgradeToProMeeting

Description:
  • Callback function of free meting upgrades successfully.
Source:

onInputMeetingPasswordAndScreenNameNotification

Description:
  • The SDK will trigger the callback event if the password or screen name is required.
Source:

onInputMeetingPasswordAndScreenNameNotification

Description:
  • The SDK will trigger the callback event if the password or screen name is required.
Source:

onJoinMeetingNeedUserInfo

Description:
  • When joining the meeting, this callback is triggered if the user needs to input a username and email.
Source:

onJoinMeetingNeedUserInfo

Description:
  • When joining the meeting, this callback is triggered if the user needs to input a username and email.
Source:

onUserConfirmToStartArchive

Description:
  • Callback event when joining a meeting if the admin allows the the user to choose to archive the meeting.
Source:

onUserConfirmToStartArchive

Description:
  • Callback event when joining a meeting if the admin allows the the user to choose to archive the meeting.
Source:

onWebinarNeedInputScreenName

Description:
  • When joining the webinar, this callback is triggered if the user needs to input a username.
Source:

onWebinarNeedInputScreenName

Description:
  • When joining the webinar, this callback is triggered if the user needs to input a username.
Source:

onWebinarNeedRegisterNotification

Description:
  • During the webinar, this callback event will be triggered if the user needs to register.
Source:

onWebinarNeedRegisterNotification

Description:
  • During the webinar, this callback event will be triggered if the user needs to register.
Source: