# Get Receiver Control Areas

This API can be used to get information of the areas controlled by all receivers connected to a specified screen.

# Request Path

{CLTPlatform-ip}:8086/advancedSeam/getReceiverAreaInfo

  • 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] advancedSeam/getReceiverAreaInfo
data Data Yes [object]
data>>processorIndex Sender index (starts from 0) Yes [int] 0
data>>screenGroupID Screen group index (starts from 0) Yes [int] 0

# Request Example

{
    "command": "advancedSeam/getReceiverAreaInfo",
    "data": {
        "processorIndex": 0,
        "screenGroupID": 0
    }
}

# Response

Parameter Name Description Required Type Data Dictionary Restriction Example
command Command type Yes [string] advancedSeam/getReceiverAreaInfo
code Status code Yes [int] 20000
message Message Yes [string] Common_Success
data Data Yes [object]
data>>processorArray Sender array Yes [array]
data>>processorArray>>processorIndex Sender index (starts from 0) Yes [int] 0
data>>processorArray>>screennGroupArray Screen group array Yes [array]
data>>processorArray>>screennGroupArray>>screenGroupID Screen group index (starts from 0) Yes [int] 0
data>>processorArray>>screennGroupArray>>receiverArray Yes [array]
data>>processorArray>>screennGroupArray>>receiverArray>>portIndex Network port index Yes [int] 0
data>>processorArray>>screennGroupArray>>receiverArray>>receiverIndex Receiver card index Yes [int] 0
data>>processorArray>>screennGroupArray>>receiverArray>>x x Yes [int] 0
data>>processorArray>>screennGroupArray>>receiverArray>>y y Yes [int] 0
data>>processorArray>>screennGroupArray>>receiverArray>>width Width Yes [int] 256
data>>processorArray>>screennGroupArray>>receiverArray>>height Height Yes [int] 256

# Response Example

{
    "command": "advancedSeam/getReceiverAreaInfo",
    "code": 20000,
    "message": "Common_Success",
    "data": {
        "processorArray": [{
            "processorIndex": 0,
            "screennGroupArray": [{
                "screenGroupID": 0,
                "receiverArray": [{
                    "portIndex": 0,
                    "receiverIndex": 0,
                    "x": 0,
                    "y": 0,
                    "width": 256,
                    "height": 256
                }]
            }]
        }]
    }
}

# Detailed Description