# Get Screen Freeze
This API can be used to get the freeze state of a specified screen.
# API Path
{CLTPlatform-ip}:8086/processor/getScreenLocked
- Replace
{CLTPlatform-ip}with the corresponding IP address. - The request port is
8086.
# Protocol
HTTP
# Method
POST
# Request Parameters
- Set the
Content-Typeof the request body toapplication/json.
| Parameter Name | Description | Required | Type | Data Dictionary | Restriction | Example |
|---|---|---|---|---|---|---|
| command | Command type | Yes | [string] | processor/getScreenLocked | ||
| data | Data | Yes | [object] | |||
| data>>index | Sender index (starts from 0) | Yes | [int] | 0 | ||
| data>>groupIndex | Screen group index (0~screenGroupCount-1) | Yes | [int] | 0 |
# Request Example
{
"command": "processor/getScreenLocked",
"data": {
"index": 0,
"groupIndex": 0
}
}
# Response
| Parameter Name | Description | Required | Type | Data Dictionary | Restriction | Example |
|---|---|---|---|---|---|---|
| command | Command type | Yes | [string] | processor/getScreenLocked | ||
| code | Status code | Yes | [int] | 20000 | ||
| message | Message | Yes | [string] | Common_Success | ||
| data | Data | Yes | [object] | |||
| data>>bScreenLocked | Whether the screen is frozen | Yes | [boolean] | true |
# Response Example
{
"command": "processor/getScreenLocked",
"code": 20000,
"message": "Common_Success",
"data": {
"bScreenLocked": true
}
}