# Get Canvas Size

This API endpoint retrieves the canvase size for a specified device.

# Request Path

{CLTPlatform-ip}:8086/processor/getCanvasSize

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

# Protocol

HTTP

# Method

POST

# Request Parameters

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

# Request Example

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

# Response

Parameter Name Description Required Type Data Dictionary Restriction Example
command Command type Yes string - - processor/getCanvasSize
code Status code Yes int - - -
message Message Yes string - - -
data Data Yes object - - -
data >> size Canvas size Yes object - - -
data >> size >> width Canvas width Yes int - - -
data >> size >> height Canvas height Yes int - - -

# Response Example

{
    "command": "processor/getCanvasSize",
    "code": 20000,
    "message": "Common_Success",
    "data": {
        "size": {
            "width": 3840,
            "height": 2160
        }
    }
}

# Detailed Description