Get general settings of device

1. API Description

This API is used to get the general settings of the device.

Request mode:

V2.6.0 and above: POST [ip]/mwapi/V2.0/general/get-server-settings
V2.5.0 and below: POST [ip]/mwapi/get-server-settings

Administrator Rights	Logged-in
No	Yes

2. Input Parameters

None

3. Output Parameters

Name	Type	Description
status	Int	Status code
launchScene	Int	Landing scene ID
autoSwitch	Int	Whether 'Auto Switch' is enabled 0: No; 1: Yes
autoSwitchType	Int	Auto switch policy 0: Disable 2: Auto switch to a higher priority signal 3: Auto switch to new signal
autoSwitchSequence	Int	Signal priority order, only valid when autoSwitchType is set to 2 1: HDMI 1; 2: HDMI 2; 3: WEBCAM; 31: Screencast
usbMirror	Int	Whether mirror USB-C output is enabled 0: No; 1: Yes
mirroringVerificationMode	Int	Screencast security authentication mode 0: None; 1: Password; 2: Onscreen Code
mirroringPasscode	String	Password for screencast security authentication, 4 digits, only valid when mirroringVerificationMode is set to 1
participantsLayout	Int	Screencast layout mode 0: Single-view; 1: Multi-view
screencastBGColor	Int	Screencast scene background color, in type of uint32 (RGBA)
screencastNameEnable	Int	Overlay screencast device name on screen. 1: Overlay; 0: Not overlay
screencastFormatEnable	Int	Overlay screencast image size and frame rate on screen. 1: Overlay, 0: Not overlay
screencastOverlayFadeOut	Int	FTB mode of screencast overlay 0: Never, 1: FTB in 5 seconds, 2: FTB in 10 seconds, 3: FTB in 20 seconds, 4: FTB in 30 seconds, 5: FTB in 1 minute
utilityEnable	Int	Reserved parameter
airPlayEnable	Int	Allow Apple or other devices supporting AirPlay to cast. 1: Allow; 0: Not allow
miracastEnable	Int	Allow Windows or Android devices supporting Miracast to cast. 1: Allow; 0: Not allow
googleCastEnable	Int	Allow software or devices supporting Google Cast to cast, such as Chrome Book or Chrome browser. 1: Allow; 0: Not allow
cropBlackArea	Int	Whether to crop out the black bars, only valid for Miracast. 1: Yes; 0: No
gotoSleep	Int	The sleep mode of the device. 0: Never 1: Go to sleep after 30 minutes 2: Go to sleep after 1 hour 3: Go to sleep after 2 hours 4: Go to sleep after 4 hours 5: Go to sleep after 8 hours 6:Go to sleep after 12 hours
wakeOnClient	Int	Reserved parameter
rebootWhenWakeUp	Int	Reboot the device immediately on wake-up. true: Reboot; false: Not reboot
autoBackup	Int	Whether to enable auto backup. 0: No; 1: Yes
backupSchedule	Int	Backup schedule 0: Upload always 1: Upload only during the specified time period
backupStartTime	Int	The start time of the specified time period everyday, in ms
backupEndTime	Int	The end time of the specified time period everyday, in ms

4. Example

Get the general settings of the device.

Input Example

None

Output Example

{
    "status": 0,
    "launchScene": 28,
    "autoSwitch": 0,
    "autoSwitchType": 0,
    "autoSwitchSequence": [1,2,3,31],
    "usbMirror": 0,
    "mirroringVerificationMode": 0,
    "mirroringPasscode": "",
    "participantsLayout": 1,
    "screencastBGColor": 255,
    "screencastNameEnable": 1,
    "screencastFormatEnable": 1,
    "screencastOverlayFadeOut": 0,
    "utilityEnable": 1,
    "airPlayEnable": 1,
    "miracastEnable": 1,
    "googleCastEnable": 1,
    "cropBlackArea": 1,
    "gotoSleep": 0,
    "wakeOnClient": 1,
    "rebootWhenWakeUp": 0,
    "autoBackup": 0,
    "backupSchedule": 1,
    "backupStartTime": 0,
    "backupEndTime": 0
}

5. Error Code

No error code related to the API business logic. For other error codes, see Common Error Codes.

USB Fusion