Get device status

1. API Description

This API is used to get the device status information, including basic information, input signal and output signal.

Request mode:

V2.6.0 and above: POST [ip]/mwapi/V2.0/dashboard/get-summary-info
V2.5.0 and below: POST [ip]/mwapi/get-summary-info

Administrator Rights	Logged-in
No	Yes

2. Input Parameters

None

3. Output Parameters

Name	Type	Description
status	Int	Status code
device	DeviceInfo	Basic device status, input signal status of HDMI and Web Camera ports, and output signal status of HDMI OUT port
out	USBOutData	Output signal status of USB OUT port

DeviceInfo

Name	Type	Description
input-hdmi-1-state	SignalData	Input signal status of HDMI 1 port
input-hdmi-2-state	SignalData	Input signal status of HDMI 2 port
input-web-camera-state	SignalData	Input signal status of Web Camera port
hdmi-out-mode	Int	Output image of HDMI OUT port 0: HDMI 1; 1: HDMI 2; 3: PROGRAM
hdmi-out-state	SignalData	Output signal status of HDMI OUT port
core-temp	Float	The current temperature (℃) of the device's processor
storage-size	Int	The storage capacity in MB
storage-free-size	Int	The free storage capacity in MB
fan-rpm	Int	The fan speed per minute

SignalData

Name	Type	Description
status	Int	Signal status 0: No signal. 1: Unsupported. The device has detected the signal but failed to lock. 2: Locking. 3: Signal can be captured.
width	Int	The signal width
height	Int	The signal height
field-rate	Int	Frame rate (fps X 100)
interlaced	Boolean	Whether it is an interlaced scanning signal true: Yes; false: No

USBOutData

Name	Type	Description
video-format	String	UVC video output format E.g. NV12, YUYV, MJPEG
speed	String	Connection status of USB OUT port disconnected; full-speed: USB 1.1, 12 Mbps; high-speed: USB 2.0, 480 Mbps; super-speed-5g: USB 3.0, 5 Gbps
video-drop-frames	Int	Number of dropped video frames in the previous second
audio-drop-frames	Int	Number of dropped audio frames in the previous second
video-width	Int	Video width, total number of pixels
video-height	Int	Video height, total number of pixels
video-scan	String	Video scanning method progressive: Progressive scanning; interlaced: Interlaced scanning
video-field-rate	Int	Video frame rate (fps X 100)
audio-num-channels	Int	Total number of audio channels
audio-sample-rate	Int	Audio sampling rate, in Hz
audio-bit-count	Int	Audio bit rate, in bit
uvc-running	Boolean	Whether UVC video capture is in progress true: Yes; false: No
uac-running	Boolean	Whether UAC audio capture is in progress true: Yes; false: No

4. Example

Getting the device status.

Input Example

None

Output Example

{
    "status": 0,
    "device": {
        "input-hdmi-1-state": {
            "status": 0,
            "width": 1920,
            "height": 1080,
            "field-rate": 6000,
            "interlaced": 0
        },
        "input-hdmi-2-state": {
            "status": 3,
            "width": 1920,
            "height": 1080,
            "field-rate": 6000,
            "interlaced": 0
        },
        "input-web-camera-state": {
            "status": 3,
            "width": 1920,
            "height": 1080,
            "field-rate": 6000,
            "interlaced": 0
        },
        "hdmi-out-mode": 2,
        "hdmi-out-state": {
            "status": 0,
            "width": -1,
            "height": -1,
            "field-rate": -1,
            "interlaced": 0
        },
        "core-temp": 59.8,
        "storage-size": 114544,
        "storage-free-size": 21,
        "fan-rpm": 3248
    },
    "out": {
        "video-format": "NV12",
        "speed": "disconnected",
        "video-drop-frames": 0,
        "audio-drop-frames": 0,
        "video-width": 1920,
        "video-height": 1080,
        "video-scan": "interlaced",
        "video-field-rate": 6000.00,
        "audio-num-channels": 2,
        "audio-sample-rate": 48000,
        "audio-bit-count": 16,
        "uvc-running": false,
        "uac-running": false
    }
}

5. Error Code

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

USB Fusion