- Instructions
- Error Codes
- Change History
- Devices
- Homepage
- Screen
- Set Screen GammaPOST
- Display Screen IDPOST
- Set Screen BrightnessPOST
- Save Screen BrightnessPOST
- Add ScreensPOST
- Delete ScreensPOST
- Read Screen Detailed InformationPOST
- Query Screen ListPOST
- Screen FTBPOST
- Set BKGPOST
- Set FreezingPOST
- Read Screen Not in Live ModePOST
- Set 3D EffectPOST
- Set Screen Layout InformationPOST
- Set Image OSDPOST
- Set Text OSDPOST
- Delete Multiple ScreensPOST
- Rename ScreensPOST
- Set Screen Gamma
- 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
- Layers
- 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
- 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
Add Screens
POST
/open/api/screen/createScreen
| Field | Description |
|---|---|
| mosaic | Output mosaic mode |
| row | Total number of rows |
| column | Total number of columns |
| edgeEnable | Whether to enable edge blending |
| edgeWidth | Edge width |
| edgeHeight | Edge height |
| screenInterfaces | Screen interface list |
| interfaceId | Interface ID |
| outputId | Output ID (When the value of ID is 255, it means no output interface is assigned.) |
| x | X value |
| y | Y value |
| width | Width |
| height | Height |
| slotId | Slot ID |
| cropx | Cropping X |
| cropy | Cropping Y |
| interfaceType | Interface type |
| connectCapacity | Connection capacity |
| isCardOnline | Whether the card is online. |
Request
Body Params application/json
Example
{
"body": {
"deviceId": 0,
"name": "screenNameTest1",
"screenInterfaces": [
{
"connectCapacity": 0,
"slotId": 0,
"outputName": "",
"interfaceType": 2,
"interfaceId": 0,
"outputId": 255,
"width": 1920,
"height": 1080,
"x": 1000,
"y": 1000,
"cropx": 0,
"cropy": 0,
"dotpitch": 2
},
{
"connectCapacity": 0,
"slotId": 0,
"outputName": "",
"interfaceType": 2,
"interfaceId": 1,
"outputId": 255,
"width": 1920,
"height": 1080,
"x": 2920,
"y": 1000,
"cropx": 0,
"cropy": 0,
"dotpitch": 2
},
{
"connectCapacity": 0,
"slotId": 0,
"outputName": "",
"interfaceType": 2,
"interfaceId": 2,
"outputId": 255,
"width": 1920,
"height": 1080,
"x": 1000,
"y": 2080,
"cropx": 0,
"cropy": 0,
"dotpitch": 2
},
{
"connectCapacity": 0,
"slotId": 0,
"outputName": "",
"interfaceType": 2,
"interfaceId": 3,
"outputId": 255,
"width": 1920,
"height": 1080,
"x": 2920,
"y": 2080,
"cropx": 0,
"cropy": 0,
"dotpitch": 2
}
],
"mosaic": {
"row": 2,
"column": 2
}
},
"sign": "MDBmZjQ1NzgxMGFjNGNhZTQ2N2U3ZTc4ODk0YTBiN2M=",
"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/screen/createScreen' \
--header 'Content-Type: application/json' \
--data-raw '{
"body": {
"deviceId": 0,
"name": "screenNameTest1",
"screenInterfaces": [
{
"connectCapacity": 0,
"slotId": 0,
"outputName": "",
"interfaceType": 2,
"interfaceId": 0,
"outputId": 255,
"width": 1920,
"height": 1080,
"x": 1000,
"y": 1000,
"cropx": 0,
"cropy": 0,
"dotpitch": 2
},
{
"connectCapacity": 0,
"slotId": 0,
"outputName": "",
"interfaceType": 2,
"interfaceId": 1,
"outputId": 255,
"width": 1920,
"height": 1080,
"x": 2920,
"y": 1000,
"cropx": 0,
"cropy": 0,
"dotpitch": 2
},
{
"connectCapacity": 0,
"slotId": 0,
"outputName": "",
"interfaceType": 2,
"interfaceId": 2,
"outputId": 255,
"width": 1920,
"height": 1080,
"x": 1000,
"y": 2080,
"cropx": 0,
"cropy": 0,
"dotpitch": 2
},
{
"connectCapacity": 0,
"slotId": 0,
"outputName": "",
"interfaceType": 2,
"interfaceId": 3,
"outputId": 255,
"width": 1920,
"height": 1080,
"x": 2920,
"y": 2080,
"cropx": 0,
"cropy": 0,
"dotpitch": 2
}
],
"mosaic": {
"row": 2,
"column": 2
}
},
"sign": "MDBmZjQ1NzgxMGFjNGNhZTQ2N2U3ZTc4ODk0YTBiN2M=",
"pId": "1",
"timeStamp": "1631949094265"
}'Responses
🟢200Successful
application/json
Body
Example
{
"data": {
"id": 2
},
"msg": "",
"status": 0
}Modified at 2025-10-23 10:08:10