H Series OpenAPI Instructions
Home
ChineseVersion
Home
ChineseVersion
  1. Layers
  • Instructions
  • Error Codes
  • Change History
  • Devices
    • Read Device Detailed Information
      POST
    • Read Device Card Information
      POST
    • Read Device IP
      POST
  • Homepage
    • Read System Initialization Status
      POST
    • Read Video Server Address
      POST
  • Screen
    • Set Screen Gamma
      POST
    • Display Screen ID
      POST
    • Set Screen Brightness
      POST
    • Save Screen Brightness
      POST
    • Add Screens
      POST
    • Delete Screens
      POST
    • Read Screen Detailed Information
      POST
    • Query Screen List
      POST
    • Screen FTB
      POST
    • Set BKG
      POST
    • Set Freezing
      POST
    • Read Screen Not in Live Mode
      POST
    • Set 3D Effect
      POST
    • Set Screen Layout Information
      POST
    • Set Image OSD
      POST
    • Set Text OSD
      POST
    • Delete Multiple Screens
      POST
    • Rename Screens
      POST
  • Inputs
    • Read Input List
    • Read Detailed Information of Specified Inputs
    • Set Cropping
    • Delete
    • Edit Cropping
    • Set Resolutions
    • Set Timing
    • Create Input Groups
    • Sort Input Groups
    • Edit Groups
    • Delete Groups
    • Delete Input Sources by Groups
    • Import EDID
    • Rename
    • Create Signal Source Playlists
    • Read Signal Source Playlists
    • Edit Signal Source Playlist Information
    • Enable Signal Source Playlists
    • Delete Signal Source Playlists
  • Outputs
    • Set Image Quality
    • Set Gamma
    • Set Output Locating
    • Rename
    • Set Timing for 4K Output Card
    • Read Detailed Information
    • Read Output List
    • Se Output Timing
    • Set Output Resolutions
    • Set Areas Loaded by All-in-One Cards
  • Layers
    • Set Stream Pulling Rules for IPC Sources Only
      POST
    • Add Layers
      POST
    • Delete Layers
      POST
    • Read Layer List
      POST
    • Read Layer Details
      POST
    • Set Layer Basic Information
      POST
    • Read Layer Z-order
      POST
    • Set Layer Information
      POST
    • Clear Layers
      POST
    • Set Layer Z-order
      POST
    • Lock Layers
      POST
    • Change Layer Source Information
      POST
    • Freeze Layers
      POST
    • Open Layer Layouts
      POST
  • Presets
    • Create Presets
    • Delete Presets
    • Set Basic Information of Specified Presets
    • Load Presets
    • Read Detailed Information of Specified Presets
    • Clear Presets
    • Get Preset Group List
    • Create Preset Groups
    • Delete Preset Groups
    • Get Preset Group Enumeration
    • Play Preset Playlist
    • Read All Presets
    • Read Preset Playlist
    • Read Current Played Preset
    • Edit Preset Groups
    • Overwrite Presets
  • BKG
    • Create BKG
    • Delete BKG
    • Get BKG Detailed Information
    • Comprehensive Query
  • IPC
    • IPC Source List
    • Read Specified Data in IPC Source List
    • IP Camera List
    • Obtain IPC Source Channel List
    • Obtain Details of IPC Source Channel List
    • Details of IPC Mosaic Source Channel Data
    • Add IPC Sources
    • Delete IPC Sources
    • Rename IPC Sources
    • Change IPC Source Channels
    • Add IPC Source Channels
    • Delete IPC Source Channels
    • IPC Source Slot List
    • IPC Sources and Channels
    • Check IPC Source Names
    • IPC Source Group List
    • Create IPC Source Groups
    • Delete IPC Source Groups
    • Change IPC Groups
    • Delete IPC Source Group Nodes
    • IPC Mosaic Source List
    • Create IPC Mosaic Source Templates
    • Update IPC Mosaic Source Templates
    • Delete IPC Mosaic Source Templates
    • Apply IPC Mosaic Source Templates
    • Rename IPC Mosaic Sources
  1. Layers

Open Layer Layouts

POST
/open/api/layer/screenLayerLayout
screenId: Screen ID
deviceId: Device ID
name: Layer name
layerId: Custom layer ID
sizeType: The definition is as follows. 
[
0: SL
1: DL，
2: 4K
]；
type: Layer type (The definition is as follows.) 
[
0: mix
1: SL
2: remapping
]；
zorder: Layer z-order
source: Layer source information
window: Layer position information
color: No-source layer color
zorder: Layer z-order
isBackground: Whether the layer is set as the screen background
width, height: Layer width and height
x, y: Layer coordinates
"sourceType: Source type (The definition is as follows.) 
[
0: No source
1: Input type
3: IPC type
4: Pure color layer
5: IPC mosaic type
]；
inputId: Source ID 
cropId: Cropped source ID (When the cropping ID is 255, the original source is used.)
isAvailable: Whether the layer audio is available. (Read only)
isOpen: Whether the layer audio is played. (r/w)
lock: Whether the layer is locked or not.
connectCapacity: Connection capacity

Request

Body Params application/json

Example
{
    "body": {
        "deviceId": 0,
        "screenId": 3,
        "layers": [
            {
                "layerId": 0,
                "general": {
                    "layerId": 0,
                    "zorder": 0,
                    "name": "Layer 1",
                    "isBackground": false,
                    "isFreeze": false,
                    "flipType": 0
                },
                "lock": 0,
                "source": {
                    "sourceType": 1,
                    "inputId": 4,
                    "cropId": 255,
                    "interfaceType": 10,
                    "connectCapacity": 0,
                    "name": "input 2-1"
                },
                "window": {
                    "width": 960,
                    "height": 540,
                    "x": 1000,
                    "y": 1000
                }
            },
            {
                "layerId": 1,
                "general": {
                    "layerId": 1,
                    "zorder": 1,
                    "name": "Layer 2",
                    "isBackground": false,
                    "isFreeze": false,
                    "flipType": 0
                },
                "lock": 0,
                "source": {
                    "sourceType": 1,
                    "inputId": 5,
                    "cropId": 255,
                    "interfaceType": 10,
                    "connectCapacity": 0,
                    "name": "input 2-2"
                },
                "window": {
                    "width": 960,
                    "height": 540,
                    "x": 1960,
                    "y": 1000
                }
            },
            {
                "layerId": 2,
                "general": {
                    "layerId": 2,
                    "zorder": 2,
                    "name": "Layer 3",
                    "isBackground": false,
                    "isFreeze": false,
                    "flipType": 0
                },
                "lock": 0,
                "source": {
                    "sourceType": 1,
                    "inputId": 6,
                    "cropId": 255,
                    "interfaceType": 10,
                    "connectCapacity": 0,
                    "name": "input 2-3"
                },
                "window": {
                    "width": 960,
                    "height": 540,
                    "x": 1000,
                    "y": 1540
                }
            },
            {
                "layerId": 3,
                "general": {
                    "layerId": 3,
                    "zorder": 3,
                    "name": "Layer 4",
                    "isBackground": false,
                    "isFreeze": false,
                    "flipType": 0
                },
                "lock": 0,
                "source": {
                    "sourceType": 1,
                    "inputId": 7,
                    "cropId": 255,
                    "interfaceType": 10,
                    "connectCapacity": 0,
                    "name": "input 2-4"
                },
                "window": {
                    "width": 960,
                    "height": 540,
                    "x": 1960,
                    "y": 1540
                }
            }
        ]
    },
    "sign": "MjI0OGYzMGQwMjhlMmI4YTNmMjM2MjE3MjYzYTFkODg=",
    "pId": "1",
    "timeStamp": "1631949094265"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/open/api/layer/screenLayerLayout' \
--header 'Content-Type: application/json' \
--data-raw '{
    "body": {
        "deviceId": 0,
        "screenId": 3,
        "layers": [
            {
                "layerId": 0,
                "general": {
                    "layerId": 0,
                    "zorder": 0,
                    "name": "Layer 1",
                    "isBackground": false,
                    "isFreeze": false,
                    "flipType": 0
                },
                "lock": 0,
                "source": {
                    "sourceType": 1,
                    "inputId": 4,
                    "cropId": 255,
                    "interfaceType": 10,
                    "connectCapacity": 0,
                    "name": "input 2-1"
                },
                "window": {
                    "width": 960,
                    "height": 540,
                    "x": 1000,
                    "y": 1000
                }
            },
            {
                "layerId": 1,
                "general": {
                    "layerId": 1,
                    "zorder": 1,
                    "name": "Layer 2",
                    "isBackground": false,
                    "isFreeze": false,
                    "flipType": 0
                },
                "lock": 0,
                "source": {
                    "sourceType": 1,
                    "inputId": 5,
                    "cropId": 255,
                    "interfaceType": 10,
                    "connectCapacity": 0,
                    "name": "input 2-2"
                },
                "window": {
                    "width": 960,
                    "height": 540,
                    "x": 1960,
                    "y": 1000
                }
            },
            {
                "layerId": 2,
                "general": {
                    "layerId": 2,
                    "zorder": 2,
                    "name": "Layer 3",
                    "isBackground": false,
                    "isFreeze": false,
                    "flipType": 0
                },
                "lock": 0,
                "source": {
                    "sourceType": 1,
                    "inputId": 6,
                    "cropId": 255,
                    "interfaceType": 10,
                    "connectCapacity": 0,
                    "name": "input 2-3"
                },
                "window": {
                    "width": 960,
                    "height": 540,
                    "x": 1000,
                    "y": 1540
                }
            },
            {
                "layerId": 3,
                "general": {
                    "layerId": 3,
                    "zorder": 3,
                    "name": "Layer 4",
                    "isBackground": false,
                    "isFreeze": false,
                    "flipType": 0
                },
                "lock": 0,
                "source": {
                    "sourceType": 1,
                    "inputId": 7,
                    "cropId": 255,
                    "interfaceType": 10,
                    "connectCapacity": 0,
                    "name": "input 2-4"
                },
                "window": {
                    "width": 960,
                    "height": 540,
                    "x": 1960,
                    "y": 1540
                }
            }
        ]
    },
    "sign": "MjI0OGYzMGQwMjhlMmI4YTNmMjM2MjE3MjYzYTFkODg=",
    "pId": "1",
    "timeStamp": "1631949094265"
}'

Responses

🟢200Successful
application/json
Body

Example
{
    "data": {},
    "msg": "",
    "status": 0
}
Modified at 2025-10-23 10:22:26
Previous
Freeze Layers
Next
Create Presets
Built with