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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) CleanUPSDK() → {Number}

Description:
  • Clean up ZOOM SDK.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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] Web domain
langname String [Optional] Resource name
langinfo String [Optional] The value should be the full path of the resource file when the langType value is CustomizedLanguage_FilePath, including the file name. When the langType value is CustomizedLanguage_Content, the value saves the content of the resource
langtype Number [Optional] Use the custom resource type CustomizedLanguageType
strSupportUrl String [Optional] Support URL
langid Number [Optional] The ID of the SDK language ZoomSDK_LANGUAGE_ID
enable_log Boolean [Optional] Enable log feature
locale Number [Optional] Locale ZoomAPPLocale
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] Enable generate dump file if the app crashed
permonitorAwarenessMode Boolean [Optional] Per-monitor awareness mode
videoRenderMode Number [Optional] Video render mode ZoomSDKVideoRenderMode
videoRawdataMemoryMode Number [Optional] Video rawdata memory mode SDKRawDataMemoryMode
shareRawdataMemoryMode Number [Optional] Share rawdata memory mode SDKRawDataMemoryMode
audioRawdataMemoryMode Number [Optional] Audio rawdata memory mode SDKRawDataMemoryMode
enableRawdataIntermediateMode Boolean [Optional] false -- YUV420data, true -- intermediate data
renderPostProcessing Number [Optional] Render post processing mode ZoomSDKRenderPostProcessing
videoCaptureMethod Number [Optional] Video capture method ZoomSDKVideoCaptureMethod
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 String [Optional] Branding name
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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] Web domain
langname String [Optional] Resource name
langinfo String [Optional] The value should be the full path of the resource file when the langType value is CustomizedLanguage_FilePath, including the file name. When the langType value is CustomizedLanguage_Content, the value saves the content of the resource
langtype Number [Optional] Use the custom resource type CustomizedLanguageType
strSupportUrl String [Optional] Support URL
langid Number [Optional] The ID of the SDK language ZoomSDK_LANGUAGE_ID
enable_log Boolean [Optional] Enable log feature
locale Number [Optional] Locale ZoomAPPLocale
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] Enable generate dump file if the app crashed
permonitorAwarenessMode Boolean [Optional] Per-monitor awareness mode
videoRenderMode Number [Optional] Video render mode ZoomSDKVideoRenderMode
videoRawdataMemoryMode Number [Optional] Video rawdata memory mode SDKRawDataMemoryMode
shareRawdataMemoryMode Number [Optional] Share rawdata memory mode SDKRawDataMemoryMode
audioRawdataMemoryMode Number [Optional] Audio rawdata memory mode SDKRawDataMemoryMode
enableRawdataIntermediateMode Boolean [Optional] false -- YUV420data, true -- intermediate data
renderPostProcessing Number [Optional] Render post processing mode ZoomSDKRenderPostProcessing
videoCaptureMethod Number [Optional] Video capture method ZoomSDKVideoCaptureMethod
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 String [Optional] Branding name
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) CleanUPSDK() → {Number}

Description:
  • Clean up ZOOM SDK.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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] Web domain
langname String [Optional] Resource name
langinfo String [Optional] The value should be the full path of the resource file when the langType value is CustomizedLanguage_FilePath, including the file name. When the langType value is CustomizedLanguage_Content, the value saves the content of the resource
langtype Number [Optional] Use the custom resource type CustomizedLanguageType
strSupportUrl String [Optional] Support URL
langid Number [Optional] The ID of the SDK language ZoomSDK_LANGUAGE_ID
enable_log Boolean [Optional] Enable log feature
locale Number [Optional] Locale ZoomAPPLocale
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] Enable generate dump file if the app crashed
permonitorAwarenessMode Boolean [Optional] Per-monitor awareness mode
videoRenderMode Number [Optional] Video render mode ZoomSDKVideoRenderMode
videoRawdataMemoryMode Number [Optional] Video rawdata memory mode SDKRawDataMemoryMode
shareRawdataMemoryMode Number [Optional] Share rawdata memory mode SDKRawDataMemoryMode
audioRawdataMemoryMode Number [Optional] Audio rawdata memory mode SDKRawDataMemoryMode
enableRawdataIntermediateMode Boolean [Optional] false -- YUV420data, true -- intermediate data
renderPostProcessing Number [Optional] Render post processing mode ZoomSDKRenderPostProcessing
videoCaptureMethod Number [Optional] Video capture method ZoomSDKVideoCaptureMethod
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 String [Optional] Branding name
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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] Web domain
langname String [Optional] Resource name
langinfo String [Optional] The value should be the full path of the resource file when the langType value is CustomizedLanguage_FilePath, including the file name. When the langType value is CustomizedLanguage_Content, the value saves the content of the resource
langtype Number [Optional] Use the custom resource type CustomizedLanguageType
strSupportUrl String [Optional] Support URL
langid Number [Optional] The ID of the SDK language ZoomSDK_LANGUAGE_ID
enable_log Boolean [Optional] Enable log feature
locale Number [Optional] Locale ZoomAPPLocale
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] Enable generate dump file if the app crashed
permonitorAwarenessMode Boolean [Optional] Per-monitor awareness mode
videoRenderMode Number [Optional] Video render mode ZoomSDKVideoRenderMode
videoRawdataMemoryMode Number [Optional] Video rawdata memory mode SDKRawDataMemoryMode
shareRawdataMemoryMode Number [Optional] Share rawdata memory mode SDKRawDataMemoryMode
audioRawdataMemoryMode Number [Optional] Audio rawdata memory mode SDKRawDataMemoryMode
enableRawdataIntermediateMode Boolean [Optional] false -- YUV420data, true -- intermediate data
renderPostProcessing Number [Optional] Render post processing mode ZoomSDKRenderPostProcessing
videoCaptureMethod Number [Optional] Video capture method ZoomSDKVideoCaptureMethod
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 String [Optional] Branding name
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number