Get HDMI input signal status

1. API Description

This API is used to get the status information of the HDMI input signal.

Request mode:

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

Administrator Rights	Logged-in
No	Yes

2. Input Parameters

Name	Required	Type	Description
source-id	Yes	Int	Source ID 0: HDMI 1; 1: HDMI 2

3. Output Parameters

Name	Type	Description
status	Int	Status code
signal-info-types	Array of String	Signal type, including video-info, audio-info, hdmi-info and info-frames
video-info	VideoInfoData	Video signal status
audio-info	AudioInfoData	Audio signal status
hdmi-info	HdmiInfoData	HDMI signal status
info-frames	Array of InfoFrameData	Array of information frame

VideoInfoData

Name	Type	Description
width	Int	Video width, in px
height	Int	Video height, in px
scan	String	Scan mode, including progressive and interlaced
field-rate	Int	Frame rate (fps X 100)
color-depth	Int	Color depth, including 8, 10 and 12
color-format	String	Color space, including rgb, bt.601, bt.709 and bt.2020
aspect-ratio	String	Aspect ratio
sampling	String	Sampling mode, including 4:2:0, 4:2:2, 4:4:4 and 4:4:4:4
quant-range	String	Quantization range, including limited and full
sat-range	String	Saturation range, including limited, extended and full
frame-struct	String	Frame structure, including 2d and 3d

AudioInfoData

Name	Type	Description
codec	String	Audio encoding mode
num-channels	Int	Number of audio channels
sample-rate	Int	Audio sampling rate, in Hz
bit-count	Int	Audio bitrate, in bit

HdmiInfoData

Name	Type	Description
mode	String	Mode, showing input signal type
hdcp	String	Whether HDCP is encrypted, including none and encrypted
vic	Int	Video identification code, displaying values that conform to the definitions specified by the CEA standard
it-content	Boolean	IT content identifier, indicating whether the transport content is content true: Yes; false: No
pixel-rate	Float	Pixel rate, the maximum number of pixels written to local memory per second
timing-h-total	Int	Timing - Horizontal total width, the total number of pixels in the horizontal direction
timing-h-active	Int	Timing - Horizontal active width, the number of active pixels in the horizontal direction
timing-h-front-porch	Int	Timing - Horizontal front porch width, the number of pixels in the horizontal sync front porch
timing-h-sync-width	Int	Timing - Horizontal sync width, the number of pixels in the horizontal sync width
timing-h-back-porch	Int	Timing - Horizontal back porch width, the number of pixels in the horizontal sync back porch
timing-v-total	Int	Timing - Vertical total width, the total number of lines in the vertical direction
timing-v-active	Int	Timing - Vertical active width, the number of active lines in the vertical direction
timing-v-front-porch	Int	Timing - Vertical front porch width, the number of lines in the vertical sync front porch
timing-v-sync-width	Int	Timing - Vertical sync width, the number of lines in the vertical sync width
timing-v-back-porch	Int	Timing - Vertical back porch width, the number of lines in the vertical sync back porch

InfoFrameData

Name	Type	Description
id	Sting	Information frame name, including AVI, Audio, etc.
type	Int	Message type
version	Int	Message version
checksum	Int	Checksum of the message
length	Int	Payload length of the frame information
data	Sting	Payload data of the frame information, base64 encoded data, displayed as hexadecimal

4. Example

Getting the status information of the HDMI 1 input signal.

Input Example

{
    "source-id": 0
}

Output Example

{
    "status": 0,
    "signal-info-types": [
        "video-info",
        "audio-info",
        "hdmi-info",
        "info-frames"
    ],
    "video-info": {
        "width": 1920,
        "height": 1080,
        "scan": "progressive",
        "field-rate": 6000,
        "color-depth": 8,
        "color-format": "bt.709",
        "aspect-ratio": "16:9",
        "sampling": "4:4:4",
        "quant-range": "limited",
        "sat-range": "limited",
        "frame-struct": "2d"
    },
    "audio-info": {
        "codec": "lpcm",
        "num-channels": 2,
        "sample-rate": 48000,
        "bit-count": 16
    },
    "hdmi-info": {
        "mode": "HDMI",
        "hdcp": "none",
        "vic": 16,
        "it-content": false,
        "pixel-rate": 148.00,
        "timing-h-total": 2200,
        "timing-h-active": 1920,
        "timing-h-front-porch": 88,
        "timing-h-sync-width": 44,
        "timing-h-back-porch": 148,
        "timing-v-total": 1125,
        "timing-v-active": 1080,
        "timing-v-front-porch": 4,
        "timing-v-sync-width": 5,
        "timing-v-back-porch": 36
    },
    "info-frames": [
        {
            "id": "AVI",
            "type": 130,
            "version": 2,
            "checksum": 103,
            "length": 13,
            "data": "UKgAEAAAAAAAAAAAAA=="
        },
        {
            "id": "Audio",
            "type": 132,
            "version": 1,
            "checksum": 112,
            "length": 10,
            "data": "AQAAAAAAAAAAAA=="
        }
    ]
}

5. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Status	Definition	Description
7	MW_STATUS_INVALID_ARG	Missing required parameters

USB Fusion