zoom_electron_sdk

Zoom Electron Sdk
Description:
  • Zoom Electron Sdk
Source:
Parameters:
Name Type Description
path String zoomsdk.node path on win os or mac os
Returns:
Type
ZoomSDK
Description:
  • Zoom Electron Sdk
Source:
Parameters:
Name Type Description
path String zoomsdk.node path on win os or mac os
Returns:
Type
ZoomSDK

Methods

(inner) CleanUPSDK() → {Number}

Description:
  • Clean up Zoom SDK.
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) CleanUPSDK() → {Number}

Description:
  • Clean up Zoom SDK.
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) GetZoomSDKVersion() → {String}

Description:
  • Get the version of Zoom SDK
Source:
Returns:
The version of Zoom SDK
Type
String

(inner) GetZoomSDKVersion() → {String}

Description:
  • Get the version of Zoom SDK
Source:
Returns:
The version of Zoom SDK
Type
String

(inner) InitSDK(path, domain, langname, langinfo, langtype, strSupportUrl, langid, enable_log, locale, logfilesize, enableGenerateDump, permonitorAwarenessMode, videoRenderMode, videoRawdataMemoryMode, shareRawdataMemoryMode, audioRawdataMemoryMode, enableRawdataIntermediateMode, renderPostProcessing, videoCaptureMethod, customLocalizationFilePath, useCustomUI, strBrandingName) → {Number}

Description:
  • Initialize Zoom SDK.
Source:
Parameters:
Name Type Description
path String [Required] sdk.dll path on win os or mac os.
domain String [Required]
langname String [Optional]
langinfo String [Optional]
langtype Number [Optional] CustomizedLanguageType
strSupportUrl String [Optional]
langid Number [Optional] ZoomSDK_LANGUAGE_ID,
enable_log Boolean [Optional]
locale Number [Optional] see ZoomAPPLocale in setings.js
logfilesize Number [Optional] Size of a log file in M(megabyte). The default size is 5M. There are 5 log files in total and the file size varies from 1M to 50M.
enableGenerateDump Boolean [Optional]
permonitorAwarenessMode Boolean [Optional]
videoRenderMode Number [Optional]
videoRawdataMemoryMode Number [Optional]
shareRawdataMemoryMode Number [Optional]
audioRawdataMemoryMode Number [Optional]
enableRawdataIntermediateMode Boolean [Optional]
renderPostProcessing Number [Optional]
videoCaptureMethod Number [Optional]
customLocalizationFilePath String [Optional] Set custom localizable string file path. only support for MAC platform
useCustomUI Number [Optional] whether to use the custom UI mode
strBrandingName Number [Optional] Branding name
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) InitSDK(path, domain, langname, langinfo, langtype, strSupportUrl, langid, enable_log, locale, logfilesize, enableGenerateDump, permonitorAwarenessMode, videoRenderMode, videoRawdataMemoryMode, shareRawdataMemoryMode, audioRawdataMemoryMode, enableRawdataIntermediateMode, renderPostProcessing, videoCaptureMethod, customLocalizationFilePath, useCustomUI, strBrandingName) → {Number}

Description:
  • Initialize Zoom SDK.
Source:
Parameters:
Name Type Description
path String [Required] sdk.dll path on win os or mac os.
domain String [Required]
langname String [Optional]
langinfo String [Optional]
langtype Number [Optional] CustomizedLanguageType
strSupportUrl String [Optional]
langid Number [Optional] ZoomSDK_LANGUAGE_ID,
enable_log Boolean [Optional]
locale Number [Optional] see ZoomAPPLocale in setings.js
logfilesize Number [Optional] Size of a log file in M(megabyte). The default size is 5M. There are 5 log files in total and the file size varies from 1M to 50M.
enableGenerateDump Boolean [Optional]
permonitorAwarenessMode Boolean [Optional]
videoRenderMode Number [Optional]
videoRawdataMemoryMode Number [Optional]
shareRawdataMemoryMode Number [Optional]
audioRawdataMemoryMode Number [Optional]
enableRawdataIntermediateMode Boolean [Optional]
renderPostProcessing Number [Optional]
videoCaptureMethod Number [Optional]
customLocalizationFilePath String [Optional] Set custom localizable string file path. only support for MAC platform
useCustomUI Number [Optional] whether to use the custom UI mode
strBrandingName Number [Optional] Branding name
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number
Zoom Electron Sdk
Description:
  • Zoom Electron Sdk
Source:
Parameters:
Name Type Description
path String zoomsdk.node path on win os or mac os
Returns:
Type
ZoomSDK
Description:
  • Zoom Electron Sdk
Source:
Parameters:
Name Type Description
path String zoomsdk.node path on win os or mac os
Returns:
Type
ZoomSDK

Methods

(inner) CleanUPSDK() → {Number}

Description:
  • Clean up Zoom SDK.
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) CleanUPSDK() → {Number}

Description:
  • Clean up Zoom SDK.
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) GetZoomSDKVersion() → {String}

Description:
  • Get the version of Zoom SDK
Source:
Returns:
The version of Zoom SDK
Type
String

(inner) GetZoomSDKVersion() → {String}

Description:
  • Get the version of Zoom SDK
Source:
Returns:
The version of Zoom SDK
Type
String

(inner) InitSDK(path, domain, langname, langinfo, langtype, strSupportUrl, langid, enable_log, locale, logfilesize, enableGenerateDump, permonitorAwarenessMode, videoRenderMode, videoRawdataMemoryMode, shareRawdataMemoryMode, audioRawdataMemoryMode, enableRawdataIntermediateMode, renderPostProcessing, videoCaptureMethod, customLocalizationFilePath, useCustomUI, strBrandingName) → {Number}

Description:
  • Initialize Zoom SDK.
Source:
Parameters:
Name Type Description
path String [Required] sdk.dll path on win os or mac os.
domain String [Required]
langname String [Optional]
langinfo String [Optional]
langtype Number [Optional] CustomizedLanguageType
strSupportUrl String [Optional]
langid Number [Optional] ZoomSDK_LANGUAGE_ID,
enable_log Boolean [Optional]
locale Number [Optional] see ZoomAPPLocale in setings.js
logfilesize Number [Optional] Size of a log file in M(megabyte). The default size is 5M. There are 5 log files in total and the file size varies from 1M to 50M.
enableGenerateDump Boolean [Optional]
permonitorAwarenessMode Boolean [Optional]
videoRenderMode Number [Optional]
videoRawdataMemoryMode Number [Optional]
shareRawdataMemoryMode Number [Optional]
audioRawdataMemoryMode Number [Optional]
enableRawdataIntermediateMode Boolean [Optional]
renderPostProcessing Number [Optional]
videoCaptureMethod Number [Optional]
customLocalizationFilePath String [Optional] Set custom localizable string file path. only support for MAC platform
useCustomUI Number [Optional] whether to use the custom UI mode
strBrandingName Number [Optional] Branding name
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) InitSDK(path, domain, langname, langinfo, langtype, strSupportUrl, langid, enable_log, locale, logfilesize, enableGenerateDump, permonitorAwarenessMode, videoRenderMode, videoRawdataMemoryMode, shareRawdataMemoryMode, audioRawdataMemoryMode, enableRawdataIntermediateMode, renderPostProcessing, videoCaptureMethod, customLocalizationFilePath, useCustomUI, strBrandingName) → {Number}

Description:
  • Initialize Zoom SDK.
Source:
Parameters:
Name Type Description
path String [Required] sdk.dll path on win os or mac os.
domain String [Required]
langname String [Optional]
langinfo String [Optional]
langtype Number [Optional] CustomizedLanguageType
strSupportUrl String [Optional]
langid Number [Optional] ZoomSDK_LANGUAGE_ID,
enable_log Boolean [Optional]
locale Number [Optional] see ZoomAPPLocale in setings.js
logfilesize Number [Optional] Size of a log file in M(megabyte). The default size is 5M. There are 5 log files in total and the file size varies from 1M to 50M.
enableGenerateDump Boolean [Optional]
permonitorAwarenessMode Boolean [Optional]
videoRenderMode Number [Optional]
videoRawdataMemoryMode Number [Optional]
shareRawdataMemoryMode Number [Optional]
audioRawdataMemoryMode Number [Optional]
enableRawdataIntermediateMode Boolean [Optional]
renderPostProcessing Number [Optional]
videoCaptureMethod Number [Optional]
customLocalizationFilePath String [Optional] Set custom localizable string file path. only support for MAC platform
useCustomUI Number [Optional] whether to use the custom UI mode
strBrandingName Number [Optional] Branding name
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number