Help Center/ Meeting/ Client SDK Reference/ Electron SDK/ APIs/ UI Configuration Management Objects/ Displaying the Settings Window
Updated on 2023-03-23 GMT+08:00
View PDF

Displaying the Settings Window

Function

This API is used to display the settings window.

Function Prototype

showSettingWindow(showInfo: ShowSettingWindowInfo, onShowSettingWindowResult?: (ret: SDKERR, reason: string) => void): voidshowSettingWindow(showInfo: ShowSettingWindowInfo, onShowSettingWindowResult?: (ret: SDKERR, reason: string) => void): void

Request Parameters

Table 1 Input parameter description
Parameter Mandatory Type Description
showInfo Y ShowSettingWindowInfo Information about displaying the settings window.
onShowSettingWindowResult Y (ret: SDKERR, reason: string) => void Callback of displaying the settings window.
Table 2 ShowSettingWindowInfo
Parameter Mandatory Type Description
isShow Y boolean Whether the settings window is displayed.
defaultPage Y SettingPage Tab displayed by default.
Table 3 Enumerated values of SettingPage
Enumeration Name Enumerated Value Description
SETTING_PAGE_NORMAL 0 General
SETTING_PAGE_VIDEO 1 Video
SETTING_PAGE_AUDIO 2 Audio
SETTING_PAGE_RECORD 3 Recording
SETTING_PAGE_HOTKEY 4 Shortcut keys
SETTING_PAGE_SCREEN 5 Screen
SETTING_PAGE_COUNT 6 Number of setting screens

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.