# Get Window Information

This interface allows you to get the window information for a specified screen group on a device.

# API Path

{CLTPlatform-ip}:8086/processor/getWindowInfo

  • Replace {CLTPlatform-ip} with the corresponding IP address.
  • The request port is 8086.

# Protocol

HTTP

# Method

POST

# Request Parameter

  • Set the Content-Type of the request body to application/json.
Parameter Name Description Required Type Data Dictionary Limit Example
command Command type Yes string processor/getWindowInfo
data Data Yes object
data >> index Sender index (starting from 0) Yes int
data >> groupIndex Screen group index Yes int

# Request Example

{
    "command": "processor/getWindowInfo",
    "data": {
        "index": 0,
        "groupIndex": 1
    }
}

# Response

Parameter Name Description Required Type Data Dictionary Limit Example
command Command type Yes string
code Status code Yes int
message Message Yes string
data Data Yes object
data >> windowList List of windows Yes array
data >> windowList >> windowIndex Window index Yes int
data >> windowList >> videoMark Signal marker Yes object
data >> windowList >> videoMark >> slotNum Slot number Yes int
data >> windowList >> videoMark >> sourceType Signal type Yes string HDMI2.0
data >> windowList >> videoMark >> sourceIndex Signal index (sequence number starting from 0 for the same signal on the same card) Yes int
data >> windowList >> videoMark >> sourceId Signal ID (signal sequence number on the same card) Yes int
data >> windowList >> position Position Yes object
data >> windowList >> position >> x Horizontal position X of the window Yes int
data >> windowList >> position >> y Vertical position Y of the window Yes int
data >> windowList >> position >> width Width of the window Yes int
data >> windowList >> position >> height Height of the window Yes int

# Response Example

{
    "code": 20000,
    "command": "processor/getWindowInfo",
    "data": {
        "windowList": [{
            "position": {
                "height": 1080,
                "width": 1920,
                "x": 0,
                "y": 0
            },
            "videoMark": {
                "slotNum": 4099,
                "sourceId": 0,
                "sourceIndex": 0,
                "sourceType": "HDMI"
            },
            "windowIndex": 0
        }, {
            "position": {
                "height": 1080,
                "width": 1920,
                "x": 804,
                "y": 1080
            },
            "videoMark": {
                "slotNum": 4099,
                "sourceId": 1,
                "sourceIndex": 1,
                "sourceType": "HDMI"
            },
            "windowIndex": 1
        }, {
            "position": {
                "height": 1080,
                "width": 1920,
                "x": 79,
                "y": 695
            },
            "videoMark": {
                "slotNum": 4099,
                "sourceId": 1,
                "sourceIndex": 1,
                "sourceType": "HDMI"
            },
            "windowIndex": 2
        }]
    },
    "message": "Common_Success"
}

# Detailed Description

* 2023.11.16
    1. Standardized description.