zoom_setting_general

Zoom General Setting
Description:
  • Zoom General Setting
Source:
Returns:
Type
ZoomGeneralSetting
Description:
  • Zoom General Setting
Source:
Returns:
Type
ZoomGeneralSetting

Methods

(inner) Checking_IsAeroModeInSharingTurnOff() → {Boolean}

Description:
  • Determine if the aero mode is turned off when sharing the screen.
Source:
Returns:
TRUE indicates to turn off the mode.
Type
Boolean

(inner) Checking_IsAeroModeInSharingTurnOff() → {Boolean}

Description:
  • Determine if the aero mode is turned off when sharing the screen.
Source:
Returns:
TRUE indicates to turn off the mode.
Type
Boolean

(inner) Checking_IsAutoFullScreenVideoWhenJoinMeetingEnabled() → {Boolean}

Description:
  • Determine if it is able to enter the full screen video mode automatically when join meeting.
Source:
Returns:
TRUE indicates to enter the full screen video mode.
Type
Boolean

(inner) Checking_IsAutoFullScreenVideoWhenJoinMeetingEnabled() → {Boolean}

Description:
  • Determine if it is able to enter the full screen video mode automatically when join meeting.
Source:
Returns:
TRUE indicates to enter the full screen video mode.
Type
Boolean

(inner) Checking_IsDualScreenModeEnabled() → {Boolean}

Description:
  • Determine if the dual screen mode is supported.
Source:
Returns:
TRUE indicates to enable the dual screen mode.
Type
Boolean

(inner) Checking_IsDualScreenModeEnabled() → {Boolean}

Description:
  • Determine if the dual screen mode is supported.
Source:
Returns:
TRUE indicates to enable the dual screen mode.
Type
Boolean

(inner) Checking_IsSplitScreenModeEnabled() → {Boolean}

Description:
  • Determine if the split screen mode is enabled.
Source:
Returns:
TRUE indicates enabled. FALSE not.
Type
Boolean

(inner) Checking_IsSplitScreenModeEnabled() → {Boolean}

Description:
  • Determine if the split screen mode is enabled.
Source:
Returns:
TRUE indicates enabled. FALSE not.
Type
Boolean

(inner) Setting_EnableAutoFullScreenVideoWhenJoinMeeting(zn_bEnable) → {Number}

Description:
  • Enable or disable to enter the full screen video mode automatically when join meeting.
Source:
Parameters:
Name Type Description
zn_bEnable Boolean TRUE indicates to enter the full screen video mode.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Setting_EnableAutoFullScreenVideoWhenJoinMeeting(zn_bEnable) → {Number}

Description:
  • Enable or disable to enter the full screen video mode automatically when join meeting.
Source:
Parameters:
Name Type Description
zn_bEnable Boolean TRUE indicates to enter the full screen video mode.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Setting_EnableDisplayReminderWindowWhenExit(bEnable) → {Number}

Description:
  • Enable/Disable reminder window when user exits the meeting. Available only for normal attendees (non-host).
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to enable reminder window.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Setting_EnableDisplayReminderWindowWhenExit(bEnable) → {Number}

Description:
  • Enable/Disable reminder window when user exits the meeting. Available only for normal attendees (non-host).
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to enable reminder window.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Setting_EnableDualScreenMode(zn_bEnable) → {Number}

Description:
  • Enable or disable dual screen mode.
Source:
Parameters:
Name Type Description
zn_bEnable Boolean TRUE indicates to set to enable the dual screen mode.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Setting_EnableDualScreenMode(zn_bEnable) → {Number}

Description:
  • Enable or disable dual screen mode.
Source:
Parameters:
Name Type Description
zn_bEnable Boolean TRUE indicates to set to enable the dual screen mode.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Setting_EnableShowMyMeetingElapseTime(bEnable) → {Number}

Description:
  • Enable/Disable to show the elapsed time of the meeting.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to show the elapsed time. 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) Setting_EnableShowMyMeetingElapseTime(bEnable) → {Number}

Description:
  • Enable/Disable to show the elapsed time of the meeting.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to show the elapsed time. 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) Setting_EnableSplitScreenMode(zn_bEnable) → {Number}

Description:
  • Enable or disable to use the split screen mode, which enables the attendees to view the lectures or the gallery.
Source:
Parameters:
Name Type Description
zn_bEnable Boolean TRUE indicates to enter the split screen mode.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Setting_EnableSplitScreenMode(zn_bEnable) → {Number}

Description:
  • Enable or disable to use the split screen mode, which enables the attendees to view the lectures or the gallery.
Source:
Parameters:
Name Type Description
zn_bEnable Boolean TRUE indicates to enter the split screen mode.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Setting_IsDisplayReminderWindowWhenExitEnabled() → {Boolean}

Description:
  • Determine if reminder window is enabled when user exits the meeting.
Source:
Returns:
TRUE indicates enabled. FALSE not.
Type
Boolean

(inner) Setting_IsDisplayReminderWindowWhenExitEnabled() → {Boolean}

Description:
  • Determine if reminder window is enabled when user exits the meeting.
Source:
Returns:
TRUE indicates enabled. FALSE not.
Type
Boolean

(inner) Setting_IsRemoteControlAllApplicationsEnabled() → {Boolean}

Description:
  • Determine if showing elapsed time of the meeting is enabled.
Source:
Returns:
TRUE indicates to show. FALSE not.
Type
Boolean

(inner) Setting_IsRemoteControlAllApplicationsEnabled() → {Boolean}

Description:
  • Determine if showing elapsed time of the meeting is enabled.
Source:
Returns:
TRUE indicates to show. FALSE not.
Type
Boolean

(inner) Setting_TurnOffAeroModeInSharing(zn_bEnable) → {Number}

Description:
  • Enable or disable the aero mode when sharing the screen. The function can only be called in windows 7 environment.
Source:
Parameters:
Name Type Description
zn_bEnable Boolean TRUE indicates to turn off the aero mode when sharing the screen.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Setting_TurnOffAeroModeInSharing(zn_bEnable) → {Number}

Description:
  • Enable or disable the aero mode when sharing the screen. The function can only be called in windows 7 environment.
Source:
Parameters:
Name Type Description
zn_bEnable Boolean TRUE indicates to turn off the aero mode when sharing the screen.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number
Zoom General Setting
Description:
  • Zoom General Setting
Source:
Returns:
Type
ZoomGeneralSetting
Description:
  • Zoom General Setting
Source:
Returns:
Type
ZoomGeneralSetting

Methods

(inner) Checking_IsAeroModeInSharingTurnOff() → {Boolean}

Description:
  • Determine if the aero mode is turned off when sharing the screen.
Source:
Returns:
TRUE indicates to turn off the mode.
Type
Boolean

(inner) Checking_IsAeroModeInSharingTurnOff() → {Boolean}

Description:
  • Determine if the aero mode is turned off when sharing the screen.
Source:
Returns:
TRUE indicates to turn off the mode.
Type
Boolean

(inner) Checking_IsAutoFullScreenVideoWhenJoinMeetingEnabled() → {Boolean}

Description:
  • Determine if it is able to enter the full screen video mode automatically when join meeting.
Source:
Returns:
TRUE indicates to enter the full screen video mode.
Type
Boolean

(inner) Checking_IsAutoFullScreenVideoWhenJoinMeetingEnabled() → {Boolean}

Description:
  • Determine if it is able to enter the full screen video mode automatically when join meeting.
Source:
Returns:
TRUE indicates to enter the full screen video mode.
Type
Boolean

(inner) Checking_IsDualScreenModeEnabled() → {Boolean}

Description:
  • Determine if the dual screen mode is supported.
Source:
Returns:
TRUE indicates to enable the dual screen mode.
Type
Boolean

(inner) Checking_IsDualScreenModeEnabled() → {Boolean}

Description:
  • Determine if the dual screen mode is supported.
Source:
Returns:
TRUE indicates to enable the dual screen mode.
Type
Boolean

(inner) Checking_IsSplitScreenModeEnabled() → {Boolean}

Description:
  • Determine if the split screen mode is enabled.
Source:
Returns:
TRUE indicates enabled. FALSE not.
Type
Boolean

(inner) Checking_IsSplitScreenModeEnabled() → {Boolean}

Description:
  • Determine if the split screen mode is enabled.
Source:
Returns:
TRUE indicates enabled. FALSE not.
Type
Boolean

(inner) Setting_EnableAutoFullScreenVideoWhenJoinMeeting(zn_bEnable) → {Number}

Description:
  • Enable or disable to enter the full screen video mode automatically when join meeting.
Source:
Parameters:
Name Type Description
zn_bEnable Boolean TRUE indicates to enter the full screen video mode.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Setting_EnableAutoFullScreenVideoWhenJoinMeeting(zn_bEnable) → {Number}

Description:
  • Enable or disable to enter the full screen video mode automatically when join meeting.
Source:
Parameters:
Name Type Description
zn_bEnable Boolean TRUE indicates to enter the full screen video mode.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Setting_EnableDisplayReminderWindowWhenExit(bEnable) → {Number}

Description:
  • Enable/Disable reminder window when user exits the meeting. Available only for normal attendees (non-host).
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to enable reminder window.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Setting_EnableDisplayReminderWindowWhenExit(bEnable) → {Number}

Description:
  • Enable/Disable reminder window when user exits the meeting. Available only for normal attendees (non-host).
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to enable reminder window.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Setting_EnableDualScreenMode(zn_bEnable) → {Number}

Description:
  • Enable or disable dual screen mode.
Source:
Parameters:
Name Type Description
zn_bEnable Boolean TRUE indicates to set to enable the dual screen mode.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Setting_EnableDualScreenMode(zn_bEnable) → {Number}

Description:
  • Enable or disable dual screen mode.
Source:
Parameters:
Name Type Description
zn_bEnable Boolean TRUE indicates to set to enable the dual screen mode.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Setting_EnableShowMyMeetingElapseTime(bEnable) → {Number}

Description:
  • Enable/Disable to show the elapsed time of the meeting.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to show the elapsed time. 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) Setting_EnableShowMyMeetingElapseTime(bEnable) → {Number}

Description:
  • Enable/Disable to show the elapsed time of the meeting.
Source:
Parameters:
Name Type Description
bEnable Boolean TRUE indicates to show the elapsed time. 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) Setting_EnableSplitScreenMode(zn_bEnable) → {Number}

Description:
  • Enable or disable to use the split screen mode, which enables the attendees to view the lectures or the gallery.
Source:
Parameters:
Name Type Description
zn_bEnable Boolean TRUE indicates to enter the split screen mode.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Setting_EnableSplitScreenMode(zn_bEnable) → {Number}

Description:
  • Enable or disable to use the split screen mode, which enables the attendees to view the lectures or the gallery.
Source:
Parameters:
Name Type Description
zn_bEnable Boolean TRUE indicates to enter the split screen mode.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Setting_IsDisplayReminderWindowWhenExitEnabled() → {Boolean}

Description:
  • Determine if reminder window is enabled when user exits the meeting.
Source:
Returns:
TRUE indicates enabled. FALSE not.
Type
Boolean

(inner) Setting_IsDisplayReminderWindowWhenExitEnabled() → {Boolean}

Description:
  • Determine if reminder window is enabled when user exits the meeting.
Source:
Returns:
TRUE indicates enabled. FALSE not.
Type
Boolean

(inner) Setting_IsRemoteControlAllApplicationsEnabled() → {Boolean}

Description:
  • Determine if showing elapsed time of the meeting is enabled.
Source:
Returns:
TRUE indicates to show. FALSE not.
Type
Boolean

(inner) Setting_IsRemoteControlAllApplicationsEnabled() → {Boolean}

Description:
  • Determine if showing elapsed time of the meeting is enabled.
Source:
Returns:
TRUE indicates to show. FALSE not.
Type
Boolean

(inner) Setting_TurnOffAeroModeInSharing(zn_bEnable) → {Number}

Description:
  • Enable or disable the aero mode when sharing the screen. The function can only be called in windows 7 environment.
Source:
Parameters:
Name Type Description
zn_bEnable Boolean TRUE indicates to turn off the aero mode when sharing the screen.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Setting_TurnOffAeroModeInSharing(zn_bEnable) → {Number}

Description:
  • Enable or disable the aero mode when sharing the screen. The function can only be called in windows 7 environment.
Source:
Parameters:
Name Type Description
zn_bEnable Boolean TRUE indicates to turn off the aero mode when sharing the screen.
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number