Zoom Audio Setting
- Description:
- Zoom Audio Setting
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onComputerMicDeviceChanged |
function | Callback event if the SDK detects that the computer mic devices have been changed. |
onComputerSpeakerDeviceChanged |
function | Callback event if the SDK detects that the computer speaker devices have been changed. |
onDefaultMicDeviceChanged |
function | Notify the user that a microphone device is selected. |
onDefaultSpeakerDeviceChanged |
function | Notify the user that a speaker device is selected. |
Returns:
- Type
- ZoomAudioSetting
- Description:
- Zoom Audio Setting
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onComputerMicDeviceChanged |
function | Callback event if the SDK detects that the computer mic devices have been changed. |
onComputerSpeakerDeviceChanged |
function | Callback event if the SDK detects that the computer speaker devices have been changed. |
onDefaultMicDeviceChanged |
function | Notify the user that a microphone device is selected. |
onDefaultSpeakerDeviceChanged |
function | Notify the user that a speaker device is selected. |
Returns:
- Type
- ZoomAudioSetting
Methods
(inner) Checking_IsAutoAdjustMicEnabled() → {Boolean}
- Description:
- Get the flag to enable/disable to auto-adjust the mic volume.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Checking_IsAutoAdjustMicEnabled() → {Boolean}
- Description:
- Get the flag to enable/disable to auto-adjust the mic volume.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Checking_IsAutoJoinAudioEnabled() → {Boolean}
- Description:
- Get the flag to enable/disable the audio automatically when join meeting.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Checking_IsAutoJoinAudioEnabled() → {Boolean}
- Description:
- Get the flag to enable/disable the audio automatically when join meeting.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_EnableAlwaysMuteMicWhenJoinVoip(bEnable) → {Number}
- Description:
- Enable or disable to mute always the mic when join the meeting by VoiP.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to enable to mute always the mic when join the meeting by VoiP. |
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_EnableAlwaysMuteMicWhenJoinVoip(bEnable) → {Number}
- Description:
- Enable or disable to mute always the mic when join the meeting by VoiP.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to enable to mute always the mic when join the meeting by VoiP. |
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_EnableAutoAdjustMic(zn_bEnable) → {Number}
- Description:
- Enable or disable the auto-adjust mic volume.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
zn_bEnable |
Boolean | TRUE indicates to enable to auto-adjust the mic volume. |
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_EnableAutoAdjustMic(zn_bEnable) → {Number}
- Description:
- Enable or disable the auto-adjust mic volume.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
zn_bEnable |
Boolean | TRUE indicates to enable to auto-adjust the mic volume. |
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_EnableAutoJoinAudio(zn_bEnable) → {Number}
- Description:
- Enable or disable the audio automatically when join meeting.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
zn_bEnable |
Boolean | TRUE indicates to enable the audio automatically 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_EnableAutoJoinAudio(zn_bEnable) → {Number}
- Description:
- Enable or disable the audio automatically when join meeting.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
zn_bEnable |
Boolean | TRUE indicates to enable the audio automatically 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_EnableEchoCancellation(level) → {Number}
- Description:
- Set the echo cancellation level.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
level |
Number | The new echo cancellation level to be set. ZoomSDKEchoCancelLationLevel |
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_EnableEchoCancellation(level) → {Number}
- Description:
- Set the echo cancellation level.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
level |
Number | The new echo cancellation level to be set. ZoomSDKEchoCancelLationLevel |
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_EnableHoldSpaceKeyToSpeak(bEnable) → {Number}
- Description:
- Enable or disable to press and hold the Space-bar to speak when muted.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to press and hold the Space-bar to speak. |
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_EnableHoldSpaceKeyToSpeak(bEnable) → {Number}
- Description:
- Enable or disable to press and hold the Space-bar to speak when muted.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to press and hold the Space-bar to speak. |
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_EnableMicOriginalInput(bEnable) → {Number}
- Description:
- Enable or disable the original input of mic.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to enable the original input of mic. |
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_EnableMicOriginalInput(bEnable) → {Number}
- Description:
- Enable or disable the original input of mic.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to enable the original input of mic. |
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_EnableStereoAudio(bEnable) → {Number}
- Description:
- Enable or disable the stereo audio. This function is valid only if mic original input is enabled, otherwise invalid.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to enable the stereo audio. |
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_EnableStereoAudio(bEnable) → {Number}
- Description:
- Enable or disable the stereo audio. This function is valid only if mic original input is enabled, otherwise invalid.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to enable the stereo audio. |
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_EnableSuppressAudioNotify(bEnable) → {Number}
- Description:
- Enable or disable to prompt when the user joins the meeting using the third party audio.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to enable to prompt. |
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_EnableSuppressAudioNotify(bEnable) → {Number}
- Description:
- Enable or disable to prompt when the user joins the meeting using the third party audio.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | TRUE indicates to enable to prompt. |
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_GetMicList() → {Array}
- Description:
- Get the mic device list.
- Source:
Returns:
If the function succeed, the return value is the camera device list. Otherwise failed, returns NULL.
- Type
- Array
(inner) Setting_GetMicList() → {Array}
- Description:
- Get the mic device list.
- Source:
Returns:
If the function succeed, the return value is the camera device list. Otherwise failed, returns NULL.
- Type
- Array
(inner) Setting_GetMicVol() → {Number}
- Description:
- Get the volume of the selected mic.
- Source:
Returns:
- Type
- Number
(inner) Setting_GetMicVol() → {Number}
- Description:
- Get the volume of the selected mic.
- Source:
Returns:
- Type
- Number
(inner) Setting_GetSpeakerList() → {Array}
- Description:
- Get the speaker device list.
- Source:
Returns:
If the function succeed, the return value is the camera device list. Otherwise failed, returns NULL.
- Type
- Array
(inner) Setting_GetSpeakerList() → {Array}
- Description:
- Get the speaker device list.
- Source:
Returns:
If the function succeed, the return value is the camera device list. Otherwise failed, returns NULL.
- Type
- Array
(inner) Setting_GetSpeakerVol() → {Number}
- Description:
- Get the volume of the selected speaker.
- Source:
Returns:
- Type
- Number
(inner) Setting_GetSpeakerVol() → {Number}
- Description:
- Get the volume of the selected speaker.
- Source:
Returns:
- Type
- Number
(inner) Setting_IsAlwaysMuteMicWhenJoinVoipEnabled() → {Boolean}
- Description:
- Get the flag to enable/disable to mute always the mic when join the meeting by VoiP.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_IsAlwaysMuteMicWhenJoinVoipEnabled() → {Boolean}
- Description:
- Get the flag to enable/disable to mute always the mic when join the meeting by VoiP.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_IsEchoCancellationEnabled() → {Number}
- Description:
- Get the echo cancellation level.
- Source:
Returns:
The the echo cancellation level. ZoomSDKEchoCancelLationLevel
- Type
- Number
(inner) Setting_IsEchoCancellationEnabled() → {Number}
- Description:
- Get the echo cancellation level.
- Source:
Returns:
The the echo cancellation level. ZoomSDKEchoCancelLationLevel
- Type
- Number
(inner) Setting_IsHoldSpaceKeyToSpeakEnabled() → {Boolean}
- Description:
- Get the flag to enable/disable to press and hold the Space-bar to speak.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_IsHoldSpaceKeyToSpeakEnabled() → {Boolean}
- Description:
- Get the flag to enable/disable to press and hold the Space-bar to speak.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_IsMicOriginalInputEnable() → {Boolean}
- Description:
- Get the flag to enable/disable the original input of mic.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_IsMicOriginalInputEnable() → {Boolean}
- Description:
- Get the flag to enable/disable the original input of mic.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_IsStereoAudioEnable() → {Boolean}
- Description:
- Get the flag to enable/disable the stereo audio.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_IsStereoAudioEnable() → {Boolean}
- Description:
- Get the flag to enable/disable the stereo audio.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_IsSuppressAudioNotifyEnabled() → {Boolean}
- Description:
- Get the flag to enable/disable to prompt when the user joins the meeting using the third party audio.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_IsSuppressAudioNotifyEnabled() → {Boolean}
- Description:
- Get the flag to enable/disable to prompt when the user joins the meeting using the third party audio.
- Source:
Returns:
Enabled or disabled.
- Type
- Boolean
(inner) Setting_SelectMic(deviceId, deviceName) → {Number}
- Description:
- Select mic device.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
deviceId |
String | Specify the device to be selected. |
deviceName |
String | Specify the device name assigned by deviceId. |
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_SelectMic(deviceId, deviceName) → {Number}
- Description:
- Select mic device.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
deviceId |
String | Specify the device to be selected. |
deviceName |
String | Specify the device name assigned by deviceId. |
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_SelectSpeaker(deviceId, deviceName) → {Number}
- Description:
- Select speaker device.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
deviceId |
String | Specify the device to be selected. |
deviceName |
String | Specify the device the device name assigned by deviceId. |
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_SelectSpeaker(deviceId, deviceName) → {Number}
- Description:
- Select speaker device.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
deviceId |
String | Specify the device to be selected. |
deviceName |
String | Specify the device the device name assigned by deviceId. |
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_SetComputerMicDeviceChangedCB(onComputerMicDeviceChanged) → {Boolean}
- Description:
- Set Computer Mic Device Changed Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onComputerMicDeviceChanged |
function |
Returns:
- Type
- Boolean
(inner) Setting_SetComputerMicDeviceChangedCB(onComputerMicDeviceChanged) → {Boolean}
- Description:
- Set Computer Mic Device Changed Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onComputerMicDeviceChanged |
function |
Returns:
- Type
- Boolean
(inner) Setting_SetComputerSpeakerDeviceChangedCB(onComputerSpeakerDeviceChanged) → {Boolean}
- Description:
- Set Computer Speaker Device Changed Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onComputerSpeakerDeviceChanged |
function |
Returns:
- Type
- Boolean
(inner) Setting_SetComputerSpeakerDeviceChangedCB(onComputerSpeakerDeviceChanged) → {Boolean}
- Description:
- Set Computer Speaker Device Changed Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onComputerSpeakerDeviceChanged |
function |
Returns:
- Type
- Boolean
(inner) Setting_SetDefaultMicDeviceChangedCB(onDefaultMicDeviceChanged) → {Boolean}
- Description:
- Set Default Mic Device Changed Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onDefaultMicDeviceChanged |
function |
Returns:
- Type
- Boolean
(inner) Setting_SetDefaultMicDeviceChangedCB(onDefaultMicDeviceChanged) → {Boolean}
- Description:
- Set Default Mic Device Changed Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onDefaultMicDeviceChanged |
function |
Returns:
- Type
- Boolean
(inner) Setting_SetDefaultSpeakerDeviceChangedCB(onDefaultSpeakerDeviceChanged) → {Boolean}
- Description:
- Set Default Speaker Device Changed Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onDefaultSpeakerDeviceChanged |
function |
Returns:
- Type
- Boolean
(inner) Setting_SetDefaultSpeakerDeviceChangedCB(onDefaultSpeakerDeviceChanged) → {Boolean}
- Description:
- Set Default Speaker Device Changed Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onDefaultSpeakerDeviceChanged |
function |
Returns:
- Type
- Boolean
(inner) Setting_SetMicVol(value) → {Number}
- Description:
- Set the volume of the selected mic.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
value |
Number | Specify the volume of the mic that varies between 0 and 255. |
Returns:
The SDK will enable the default mic if there is no mic selected via SelectMic().
- Type
- Number
(inner) Setting_SetMicVol(value) → {Number}
- Description:
- Set the volume of the selected mic.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
value |
Number | Specify the volume of the mic that varies between 0 and 255. |
Returns:
The SDK will enable the default mic if there is no mic selected via SelectMic().
- Type
- Number
(inner) Setting_SetSpeakerVol(value) → {Number}
- Description:
- Set the volume of the selected speaker.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
value |
Number | Specify the volume of the speaker that varies between 0 and 255. |
Returns:
- Type
- Number
(inner) Setting_SetSpeakerVol(value) → {Number}
- Description:
- Set the volume of the selected speaker.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
value |
Number | Specify the volume of the speaker that varies between 0 and 255. |
Returns:
- Type
- Number
Events
onComputerMicDeviceChanged
- Description:
- Callback event if the SDK detects that the computer mic devices have been changed.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
newMicList |
Array | The new list of all mic devices plugged into the computer. |
onComputerMicDeviceChanged
- Description:
- Callback event if the SDK detects that the computer mic devices have been changed.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
newMicList |
Array | The new list of all mic devices plugged into the computer. |
onComputerSpeakerDeviceChanged
- Description:
- Callback event if the SDK detects that the computer speaker devices have been changed.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
newSpeakerList |
Array | The new list of all speaker devices plugged into the computer. |
onComputerSpeakerDeviceChanged
- Description:
- Callback event if the SDK detects that the computer speaker devices have been changed.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
newSpeakerList |
Array | The new list of all speaker devices plugged into the computer. |
onDefaultMicDeviceChanged
- Description:
- Notify the user that a microphone 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. |
onDefaultMicDeviceChanged
- Description:
- Notify the user that a microphone 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. |
onDefaultSpeakerDeviceChanged
- Description:
- Notify the user that a speaker 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. |
onDefaultSpeakerDeviceChanged
- Description:
- Notify the user that a speaker 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. |