Zoom Virtual BG Setting
- Description:
- Zoom Virtual BG Setting
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onVBImageDidDownloaded |
function | Callback event of notification that the default virtual background images supplied by ZOOM are downloaded. |
onGreenVBDidUpdateWithReplaceColor |
function | Callback event of notification that the virtual background effect is updated with the selected color. |
onSelectedVBImageChanged |
function | Callback event of notification that the virtual background image is changed. |
onVBVideoUploadedResult |
function | Callback event of notification that the result of adding video virtual background. |
Returns:
- Type
- ZoomVirtualBGSetting
- Description:
- Zoom Virtual BG Setting
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onVBImageDidDownloaded |
function | Callback event of notification that the default virtual background images supplied by ZOOM are downloaded. |
onGreenVBDidUpdateWithReplaceColor |
function | Callback event of notification that the virtual background effect is updated with the selected color. |
onSelectedVBImageChanged |
function | Callback event of notification that the virtual background image is changed. |
onVBVideoUploadedResult |
function | Callback event of notification that the result of adding video virtual background. |
Returns:
- Type
- ZoomVirtualBGSetting
Methods
(inner) AddBGImage(filePath) → {Number}
- Description:
- Add a new image as the virtual background image and to the image list.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
filePath |
String | Specify the file name of the image. It must be the full path with the file name. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) AddBGImage(filePath) → {Number}
- Description:
- Add a new image as the virtual background image and to the image list.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
filePath |
String | Specify the file name of the image. It must be the full path with the file name. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) AddBGVideo(filePath) → {Number}
- Description:
- Add a new video as the virtual background video and to the video list.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
filePath |
String | Specify the file name of the video. It must be the full path with the file name. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) AddBGVideo(filePath) → {Number}
- Description:
- Add a new video as the virtual background video and to the video list.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
filePath |
String | Specify the file name of the video. It must be the full path with the file name. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) BeginSelectReplaceVBColor() → {Number}
- Description:
- Start to capture a color from video preview.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) BeginSelectReplaceVBColor() → {Number}
- Description:
- Start to capture a color from video preview.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) GetBGImageList() → {Array}
- Description:
- Get the list of the virtual background images.
- Source:
Returns:
If there are images in the list, the return value is a list of the poiters to IVirtualBGImageInfo.
- Type
- Array
(inner) GetBGImageList() → {Array}
- Description:
- Get the list of the virtual background images.
- Source:
Returns:
If there are images in the list, the return value is a list of the poiters to IVirtualBGImageInfo.
- Type
- Array
(inner) GetBGReplaceColor() → {Number}
- Description:
- Get the selected color after called BeginSelectReplaceVBColor() and selected a color.
- Source:
Returns:
If the function succeeds, the return value is the selected color.
- Type
- Number
(inner) GetBGReplaceColor() → {Number}
- Description:
- Get the selected color after called BeginSelectReplaceVBColor() and selected a color.
- Source:
Returns:
If the function succeeds, the return value is the selected color.
- Type
- Number
(inner) GetBGVideoList() → {Array}
- Description:
- Get the list of the virtual background videoes.
- Source:
Returns:
If there are videoes in the list, the return value is a list of the poiters to IVirtualBGImageInfo.
- Type
- Array
(inner) GetBGVideoList() → {Array}
- Description:
- Get the list of the virtual background videoes.
- Source:
Returns:
If there are videoes in the list, the return value is a list of the poiters to IVirtualBGImageInfo.
- Type
- Array
(inner) IsAllowToAddNewVBItem() → {Boolean}
- Description:
- Determine if the adding new virtual background item feature is supported by the meeting
- Source:
Returns:
TRUE indicates that the meeting supports adding new virtual background item feature.
- Type
- Boolean
(inner) IsAllowToAddNewVBItem() → {Boolean}
- Description:
- Determine if the adding new virtual background item feature is supported by the meeting
- Source:
Returns:
TRUE indicates that the meeting supports adding new virtual background item feature.
- Type
- Boolean
(inner) IsAllowToRemoveVBItem() → {Boolean}
- Description:
- Determine if the removing virtual background item feature is supported by the meeting
- Source:
- Deprecated:
- This interface is marked as deprecated.
Returns:
TRUE indicates that the meeting supports removing virtual background item feature.
- Type
- Boolean
(inner) IsAllowToRemoveVBItem() → {Boolean}
- Description:
- Determine if the removing virtual background item feature is supported by the meeting
- Source:
- Deprecated:
- This interface is marked as deprecated.
Returns:
TRUE indicates that the meeting supports removing virtual background item feature.
- Type
- Boolean
(inner) IsDeviceSupportGreenVirtualBackgroundVideo() → {Boolean}
- Description:
- Determine if the green virtual background video feature can be supported by the machine.
- Source:
Returns:
TRUE indicates that the machine can supports to use green virtual background video feature.
- Type
- Boolean
(inner) IsDeviceSupportGreenVirtualBackgroundVideo() → {Boolean}
- Description:
- Determine if the green virtual background video feature can be supported by the machine.
- Source:
Returns:
TRUE indicates that the machine can supports to use green virtual background video feature.
- Type
- Boolean
(inner) IsDeviceSupportSmartVirtualBG() → {Boolean}
- Description:
- Determine if the smart virtual background feature can be supported by the machine.
- Source:
Returns:
TRUE indicates that the machine can supports to use smart virtual background feature.
- Type
- Boolean
(inner) IsDeviceSupportSmartVirtualBG() → {Boolean}
- Description:
- Determine if the smart virtual background feature can be supported by the machine.
- Source:
Returns:
TRUE indicates that the machine can supports to use smart virtual background feature.
- Type
- Boolean
(inner) IsDeviceSupportSmartVirtualBackgroundVideo() → {Boolean}
- Description:
- Determine if the smart virtual background video feature can be supported by the machine.
- Source:
Returns:
TRUE indicates that the machine can supports to use smart virtual background video feature.
- Type
- Boolean
(inner) IsDeviceSupportSmartVirtualBackgroundVideo() → {Boolean}
- Description:
- Determine if the smart virtual background video feature can be supported by the machine.
- Source:
Returns:
TRUE indicates that the machine can supports to use smart virtual background video feature.
- Type
- Boolean
(inner) IsSupportVirtualBG() → {Boolean}
- Description:
- Determine if the virtual background feature is supported by the meeting.
- Source:
Returns:
TRUE indicates that the meeting supports the virtual background feature.
- Type
- Boolean
(inner) IsSupportVirtualBG() → {Boolean}
- Description:
- Determine if the virtual background feature is supported by the meeting.
- Source:
Returns:
TRUE indicates that the meeting supports the virtual background feature.
- Type
- Boolean
(inner) IsSupportVirtualBackgroundVideo() → {Boolean}
- Description:
- Determine if the video virtual background feature is supported by the meeting.
- Source:
Returns:
TRUE indicates that the meeting supports the video virtual background feature.
- Type
- Boolean
(inner) IsSupportVirtualBackgroundVideo() → {Boolean}
- Description:
- Determine if the video virtual background feature is supported by the meeting.
- Source:
Returns:
TRUE indicates that the meeting supports the video virtual background feature.
- Type
- Boolean
(inner) IsUsingGreenScreenOn() → {Boolean}
- Description:
- Determine if the green screen is using for the virtual background feature in the meeting.
- Source:
Returns:
TRUE indicates to use the green screen for the virtual background feature.
- Type
- Boolean
(inner) IsUsingGreenScreenOn() → {Boolean}
- Description:
- Determine if the green screen is using for the virtual background feature in the meeting.
- Source:
Returns:
TRUE indicates to use the green screen for the virtual background feature.
- Type
- Boolean
(inner) RemoveBGImage(imageHandle) → {Number}
- Description:
- Remove an image from the virtual background image list.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
imageHandle |
Number | Specify the image to remove. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) RemoveBGImage(imageHandle) → {Number}
- Description:
- Remove an image from the virtual background image list.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
imageHandle |
Number | Specify the image to remove. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) RemoveBGVideo(imageHandle) → {Number}
- Description:
- Remove a video from the virtual background video list.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
imageHandle |
Object | Specify the video to remove. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) RemoveBGVideo(imageHandle) → {Number}
- Description:
- Remove a video from the virtual background video list.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
imageHandle |
Object | Specify the video to remove. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetOnGreenVBDidUpdateWithReplaceColorCB(onGreenVBDidUpdateWithReplaceColor) → {Boolean}
- Description:
- Set callback event of notification that the virtual background effect is updated with the selected color.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onGreenVBDidUpdateWithReplaceColor |
function |
Returns:
- Type
- Boolean
(inner) SetOnGreenVBDidUpdateWithReplaceColorCB(onGreenVBDidUpdateWithReplaceColor) → {Boolean}
- Description:
- Set callback event of notification that the virtual background effect is updated with the selected color.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onGreenVBDidUpdateWithReplaceColor |
function |
Returns:
- Type
- Boolean
(inner) SetOnSelectedVBImageChangedCB(onSelectedVBImageChanged) → {Boolean}
- Description:
- Set callback event of notification that the virtual background image is changed.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onSelectedVBImageChanged |
function |
Returns:
- Type
- Boolean
(inner) SetOnSelectedVBImageChangedCB(onSelectedVBImageChanged) → {Boolean}
- Description:
- Set callback event of notification that the virtual background image is changed.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onSelectedVBImageChanged |
function |
Returns:
- Type
- Boolean
(inner) SetOnVBImageDidDownloadedCB(onVBImageDidDownloaded) → {Boolean}
- Description:
- Set callback event of notification that the default virtual background images supplied by ZOOM are downloaded.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onVBImageDidDownloaded |
function |
Returns:
- Type
- Boolean
(inner) SetOnVBImageDidDownloadedCB(onVBImageDidDownloaded) → {Boolean}
- Description:
- Set callback event of notification that the default virtual background images supplied by ZOOM are downloaded.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onVBImageDidDownloaded |
function |
Returns:
- Type
- Boolean
(inner) SetOnVBVideoUploadedResultCB(onVBVideoUploadedResult) → {Boolean}
- Description:
- Set callback event of notification that the result of adding video virtual background.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onVBVideoUploadedResult |
function |
Returns:
- Type
- Boolean
(inner) SetOnVBVideoUploadedResultCB(onVBVideoUploadedResult) → {Boolean}
- Description:
- Set callback event of notification that the result of adding video virtual background.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onVBVideoUploadedResult |
function |
Returns:
- Type
- Boolean
(inner) SetUsingGreenScreen(bUse) → {Number}
- Description:
- Set to use the green screen for the virtual background feature.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bUse |
Boolean | Specify to use the green screen or not.TRUE means using the green screen. FALSE means using smart virtual background feature. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetUsingGreenScreen(bUse) → {Number}
- Description:
- Set to use the green screen for the virtual background feature.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bUse |
Boolean | Specify to use the green screen or not.TRUE means using the green screen. FALSE means using smart virtual background feature. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) UseBGImage(imageHandle) → {Number}
- Description:
- Specify an image to be the virtual background image.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
imageHandle |
Number | Specify the image to use. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) UseBGImage(imageHandle) → {Number}
- Description:
- Specify an image to be the virtual background image.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
imageHandle |
Number | Specify the image to use. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) UseBGVideo(imageHandle) → {Number}
- Description:
- Specify a video to be the virtual background video.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
imageHandle |
Number | Specify the video to use. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) UseBGVideo(imageHandle) → {Number}
- Description:
- Specify a video to be the virtual background video.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
imageHandle |
Number | Specify the video to use. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
Events
onGreenVBDidUpdateWithReplaceColor
- Description:
- Callback event of notification that the virtual background effect is updated with the selected color.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
selectedColor |
Number | The RGB value of the selected color, organized in the format 0xFFRRGGBB. |
onGreenVBDidUpdateWithReplaceColor
- Description:
- Callback event of notification that the virtual background effect is updated with the selected color.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
selectedColor |
Number | The RGB value of the selected color, organized in the format 0xFFRRGGBB. |
onSelectedVBImageChanged
- Description:
- Callback event of notification that the virtual background image is changed.
- Source:
onSelectedVBImageChanged
- Description:
- Callback event of notification that the virtual background image is changed.
- Source:
onVBImageDidDownloaded
- Description:
- Callback event of notification that the default virtual background images supplied by ZOOM are downloaded.
- Source:
onVBImageDidDownloaded
- Description:
- Callback event of notification that the default virtual background images supplied by ZOOM are downloaded.
- Source:
onVBVideoUploadedResult
- Description:
- Callback event of notification that the result of adding video virtual background.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
success |
Boolean | True means is successfully added, otherwise not. |
error |
Number | If failed adding the video virtual background, the error will be notified. |
onVBVideoUploadedResult
- Description:
- Callback event of notification that the result of adding video virtual background.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
success |
Boolean | True means is successfully added, otherwise not. |
error |
Number | If failed adding the video virtual background, the error will be notified. |