Help Center/ Meeting/ Client SDK Reference/ Electron SDK/ APIs/ Common Configuration Management Objects/ Enabling or Disabling Functions
Updated on 2024-07-30 GMT+08:00
View PDF
Share

Enabling or Disabling Functions

Function

This API is used to enable or disable meeting functions. Functions in the enumeration have default values. Call this API when you need to change the function status.

Function Prototype

enableCapability(capabilityInfo: CapabilityInfo, onEnableCapabilityResult?: (ret: SDKERR, reason: string) => void): voidenableCapability(capabilityInfo: CapabilityInfo, onEnableCapabilityResult?: (ret: SDKERR, reason: string) => void): void

Request Parameters

Table 1 Input parameter description
Parameter Mandatory Type Description
capabilityInfo Yes CapabilityInfo Function configuration.
onEnableCapabilityResult Yes (ret: SDKERR, reason: string) => void Callback of configuring function statuses.
Table 2 CapabilityInfo
Parameter Mandatory Type Description
type Yes CapabilityType Function type.
isEnable Yes boolean Function status.
Table 3 Enumerated values of CapabilityType
Enumeration Name Enumerated Value Description
HWM_CAPABILITY_TYPE_SHOW_HANGUP_ATTENDEE 0 Displaying offline participants (valid only for the Windows platform).
HWM_CAPABILITY_TYPE_HIDE_EXTERNAL_LABEL 1 Hiding the External label.
HWM_CAPABILITY_TYPE_RESOLUTION_1080P 2 1080p (valid only for the Windows platform)
HWM_CAPABILITY_TYPE_RESOLUTION_720P 3 720p (valid only for the macOS platform).
HWM_CAPABILITY_TYPE_MULTI_MONITOR 4 Multi-monitor mode (valid only for the Windows platform).
HWM_CAPABILITY_TYPE_HOWLING_DETECTION 5 Feedback detection (valid only for the Windows platform).
HWM_CAPABILITY_AUTO_MIC_VOLUME 6 Automatic microphone volume adjustment (valid only for the Windows platform).
HWM_CAPABILITY_SHARE_AUDIO 7 Audio sharing.
HWM_CAPABILITY_HIDE_NO_CAMERA_VIEW 8 Hiding non-video participants (valid only for the macOS platform).
HWM_CAPABILITY_BREAKOUT_CONF 9 Enabling or disabling the breakout room function.
HWM_CAPABILITY_CONFIRM_RECORD 10 Recording confirmation.
HWM_CAPABILITY_SUPPORT_DISCONNECT_AUDIO 12 Audio disconnection (valid only for the Windows platform).
HWM_CAPABILITY_DISCONNECT_AUDIO_TO_JOIN_CONF 13 Joining the meeting without audio (valid only for the Windows platform).
HWM_CAPABILITY_CPU_REDUCTION_DETECT 14 Detecting CPU frequency reduction (valid only for the Windows platform).
HWM_CAPABILITY_SUPPORT_GUEST_INVITE 16 Participant invitation.

Return Values

void

Callback Method Parameters

(ret: SDKERR, reason: string) => void

Table 4 Input parameter description
Parameter Type Description
ret For details about SDKERR, see Error Code Reference. Error code.
reason string Error description.