Modify Canvas Size

This API endpoint sets the canvas size for a specified device.

Request Path

{CLTPlatform-ip}:8086/processor/setCanvasSize

• 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/setCanvasSize
data	Data	Yes	object	-	-	-
data >> index	Sender index (starts from 0; -1 for broadcast)	Yes	int	-	-	-
data >> groupIndex	Screen group index	Yes	int	-	-	-
data >> size	Canvas size	Yes	object	-	-	-
data >> size >> width	Canvas width	Yes	int	-	-	-
data >> size >> height	Canvas height	Yes	int	-	-	-

Request Example

{
    "command": "processor/setCanvasSize",
    "data": {
        "index": 0,
        "groupIndex": 1,
        "size": {
            "width": 1920,
            "height": 1080
        }
    }
}

Response

Parameter Name	Description	Required	Type	Data Dictionary	Restriction	Example
command	Command type	Yes	string	-	-	processor/setCanvasSize
code	Status code	Yes	int	-	-	-
message	Message	Yes	string	-	-	-
data	Data	Yes	object	-	-	-

Response Example

{
    "code": 20000,
    "command": "processor/setCanvasSize",
    "data": {},
    "message": "Common_Success"
}

Detailed Description