Zoom Video Setting
- Description:
- Zoom Video Setting
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onComputerCamDeviceChanged |
function | Callback event if the SDK detects that the computer camera devices have been changed. |
onDefaultCamDeviceChanged |
function | Notify the user that a camera device is selected. |
Returns:
- Type
- ZoomVideoSetting
- Description:
- Zoom Video Setting
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onComputerCamDeviceChanged |
function | Callback event if the SDK detects that the computer camera devices have been changed. |
onDefaultCamDeviceChanged |
function | Notify the user that a camera device is selected. |
Returns:
- Type
- ZoomVideoSetting
Methods
(inner) Checking_IsFaceBeautyEffectEnabled() → {Boolean}
- Description:
- Get the flag to enable/disable the video facial beauty effect.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Checking_IsFaceBeautyEffectEnabled() → {Boolean}
- Description:
- Get the flag to enable/disable the video facial beauty effect.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Checking_IsMirrorEffectEnabled() → {Boolean}
- Description:
- Check if Video Mirror Effect Enabled
- Source:
Returns:
- Type
- Boolean
(inner) Checking_IsMirrorEffectEnabled() → {Boolean}
- Description:
- Check if Video Mirror Effect Enabled
- Source:
Returns:
- Type
- Boolean
(inner) Setting_Enable49VideoesInGallaryView(bEnable) → {Number}
- Description:
- Enable or disable to show the participants in Gallery View up to 49 per screen.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to show the participants in Gallery View up to 49 per 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_Enable49VideoesInGallaryView(bEnable) → {Number}
- Description:
- Enable or disable to show the participants in Gallery View up to 49 per screen.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to show the participants in Gallery View up to 49 per 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_EnableAlwaysShowNameOnVideo(bEnable) → {Number}
- Description:
- Enable or disable to show the username on the video.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to show the username on the video. |
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_EnableAlwaysShowNameOnVideo(bEnable) → {Number}
- Description:
- Enable or disable to show the username on the video.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to show the username on the video. |
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_EnableAutoTurnOffVideoWhenJoinMeeting(bEnable) → {Number}
- Description:
- Enable or disable to turn off the video when join meeting
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to enable to turn off the video when join meeting |
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_EnableAutoTurnOffVideoWhenJoinMeeting(bEnable) → {Number}
- Description:
- Enable or disable to turn off the video when join meeting
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to enable to turn off the video when join meeting |
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_EnableFaceBeautyEffect(zn_bEnable) → {Number}
- Description:
- Enable or disable the video facial beauty effect.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
zn_bEnable |
Boolean | TRUE indicates to enable the video facial beauty effect. |
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_EnableFaceBeautyEffect(zn_bEnable) → {Number}
- Description:
- Enable or disable the video facial beauty effect.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
zn_bEnable |
Boolean | TRUE indicates to enable the video facial beauty effect. |
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_EnableHDVideo(bEnable) → {Number}
- Description:
- Enable or disable HD video.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to enable the HD video. |
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_EnableHDVideo(bEnable) → {Number}
- Description:
- Enable or disable HD video.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to enable the HD video. |
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_EnableHardwareEncode(bEnable, encodeType) → {Number}
- Description:
- Enable or disable the hardware acceleration.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to enable the hardware acceleration. |
encodeType |
Number | Defined in: ZoomSDKVideoHardwareEncodeType |
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_EnableHardwareEncode(bEnable, encodeType) → {Number}
- Description:
- Enable or disable the hardware acceleration.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to enable the hardware acceleration. |
encodeType |
Number | Defined in: ZoomSDKVideoHardwareEncodeType |
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_EnableHideNoVideoUsersOnWallView(bEnable) → {Number}
- Description:
- Enable or disable to hide the non-video participants.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to hide the non-video Participants. |
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_EnableHideNoVideoUsersOnWallView(bEnable) → {Number}
- Description:
- Enable or disable to hide the non-video participants.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to hide the non-video Participants. |
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_EnableSpotlightSelf(bEnable) → {Number}
- Description:
- Enable or disable to spotlight the video.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to enable to spotlight the video. |
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_EnableSpotlightSelf(bEnable) → {Number}
- Description:
- Enable or disable to spotlight the video.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to enable to spotlight the video. |
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_EnableVideoMirrorEffect(zn_bEnable) → {Number}
- Description:
- Enable or disable video mirror effect.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
zn_bEnable |
Boolean | TRUE indicates to enable the video mirror effect. |
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_EnableVideoMirrorEffect(zn_bEnable) → {Number}
- Description:
- Enable or disable video mirror effect.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
zn_bEnable |
Boolean | TRUE indicates to enable the video mirror effect. |
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_EnableVideoPreviewDialog(bEnable) → {Number}
- Description:
- Enable or disable to show the video preview dialog when join meeting
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to enable to show the video preview dialog when join meeting |
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_EnableVideoPreviewDialog(bEnable) → {Number}
- Description:
- Enable or disable to show the video preview dialog when join meeting
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to enable to show the video preview dialog when join meeting |
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_GetCameraList() → {Array}
- Description:
- Get camera device list.
- Source:
Returns:
If the function succeed, the return value the is camera device list. Otherwise failed, returns NULL.
- Type
- Array
(inner) Setting_GetCameraList() → {Array}
- Description:
- Get camera device list.
- Source:
Returns:
If the function succeed, the return value the is camera device list. Otherwise failed, returns NULL.
- Type
- Array
(inner) Setting_Is49VideoesInGallaryViewEnabled() → {Boolean}
- Description:
- Get the flag to enable/disable to show the participants in Gallery View up to 49 per screen.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_Is49VideoesInGallaryViewEnabled() → {Boolean}
- Description:
- Get the flag to enable/disable to show the participants in Gallery View up to 49 per screen.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_IsAlwaysShowNameOnVideoEnabled() → {Boolean}
- Description:
- Get the flag to enable/disable to show the username on video.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_IsAlwaysShowNameOnVideoEnabled() → {Boolean}
- Description:
- Get the flag to enable/disable to show the username on video.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_IsAutoTurnOffVideoWhenJoinMeetingEnabled() → {Boolean}
- Description:
- Get the flag to enable to turn off the video when join meeting.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_IsAutoTurnOffVideoWhenJoinMeetingEnabled() → {Boolean}
- Description:
- Get the flag to enable to turn off the video when join meeting.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_IsHDVideoEnabled() → {Boolean}
- Description:
- Get the flag to enable/disable the HD video.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_IsHDVideoEnabled() → {Boolean}
- Description:
- Get the flag to enable/disable the HD video.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_IsHardwareEncodeEnabled(encodeType) → {Boolean}
- Description:
- Get the flag to enable/disable the hardware acceleration.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
encodeType |
Number | Defined in: ZoomSDKVideoHardwareEncodeType |
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_IsHardwareEncodeEnabled(encodeType) → {Boolean}
- Description:
- Get the flag to enable/disable the hardware acceleration.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
encodeType |
Number | Defined in: ZoomSDKVideoHardwareEncodeType |
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_IsHideNoVideoUsersOnWallViewEnabled() → {Boolean}
- Description:
- Get the flag to enable/disable to hide non-video participants.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_IsHideNoVideoUsersOnWallViewEnabled() → {Boolean}
- Description:
- Get the flag to enable/disable to hide non-video participants.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_IsSpotlightSelfEnabled() → {Boolean}
- Description:
- Get the flag to enable/disable to spotlight video.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_IsSpotlightSelfEnabled() → {Boolean}
- Description:
- Get the flag to enable/disable to spotlight video.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_IsVideoPreviewDialogEnabled() → {Boolean}
- Description:
- Get the flag to enable to show the video preview dialog when join meeting.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_IsVideoPreviewDialogEnabled() → {Boolean}
- Description:
- Get the flag to enable to show the video preview dialog when join meeting.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_SelectVideoCamera(zn_deviceId) → {Number}
- Description:
- Select camera device.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
zn_deviceId |
String | Specify a device to be selected. |
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_SelectVideoCamera(zn_deviceId) → {Number}
- Description:
- Select camera device.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
zn_deviceId |
String | Specify a device to be selected. |
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_SetComputerCamDeviceChangedCB(onComputerCamDeviceChanged) → {Boolean}
- Description:
- Set Computer Cam Device Changed Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onComputerCamDeviceChanged |
function |
Returns:
- Type
- Boolean
(inner) Setting_SetComputerCamDeviceChangedCB(onComputerCamDeviceChanged) → {Boolean}
- Description:
- Set Computer Cam Device Changed Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onComputerCamDeviceChanged |
function |
Returns:
- Type
- Boolean
(inner) Setting_SetDefaultCamDeviceChangedCB(onDefaultCamDeviceChanged) → {Boolean}
- Description:
- Set Default Cam Device Changed Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onDefaultCamDeviceChanged |
function |
Returns:
- Type
- Boolean
(inner) Setting_SetDefaultCamDeviceChangedCB(onDefaultCamDeviceChanged) → {Boolean}
- Description:
- Set Default Cam Device Changed Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onDefaultCamDeviceChanged |
function |
Returns:
- Type
- Boolean
Events
onComputerCamDeviceChanged
- Description:
- Callback event if the SDK detects that the computer camera devices have been changed.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
newCameraList |
Array | The new list of all camera devices plugged into the computer. |
onComputerCamDeviceChanged
- Description:
- Callback event if the SDK detects that the computer camera devices have been changed.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
newCameraList |
Array | The new list of all camera devices plugged into the computer. |
onDefaultCamDeviceChanged
- Description:
- Notify the user that a camera device is selected.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
deviceId |
String | Specify a device to be selected. |
deviceName |
String | Specify the device name assigned by deviceId. |
onDefaultCamDeviceChanged
- Description:
- Notify the user that a camera device is selected.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
deviceId |
String | Specify a device to be selected. |
deviceName |
String | Specify the device name assigned by deviceId. |