Set Screen Freeze

This interface allows you to freeze a specified screen.

API Path

{CLTPlatform-ip}:8086/processor/setScreenLocked

• 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/setScreenLocked
data	Data	Yes	object
data >> index	Sender index (starting from 0, -1 for all senders)	Yes	int
data >> groupIndex	Screen group index (0~screenGroupCount-1)	Yes	int
data >> bScreenLocked	Whether to freeze the screen	Yes	boolean

Request Example

{
    "command": "processor/setScreenLocked",
    "data": {
        "index": 0,
        "groupIndex": 0,
        "bScreenLocked": true
    }
}

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

Response Example

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

Detailed Description

* 2023.11.16
    1. Standardized description.