- 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
Read Screen Detailed Information
POST
/open/api/screen/readDetail
| Field | Description |
|---|---|
| deviceId | Device ID |
| screenId | Screen ID |
| Osd | For the node data, please refer to https://openapi.novastar.tech/en/h/api-365455734. |
| OsdImage | For the node data, please refer to https://openapi.novastar.tech/en/h/api-365455733. |
| Bkg | For BKG, please refer to https://openapi.novastar.tech/en/h/api-365455798. |
| Screen3D | For Screen3D, please refer to https://openapi.novastar.tech/en/h/api-365455731. |
| audioOuputMode | Audio output mode (0: Output embedded audio, 1: Output fixed audio) |
| followId | Audio source input ID in embedded audio mode |
| layerId | Audio source layer ID in embedded audio mode |
| inputId | Audio source input ID in fixed output mode |
| isMute | Mute or not (1: Mute, 0: Unmute) |
| volume | Volume (Range: 0 to 100) |
| imageQuality | Image quality data, "all": Overall value of brightness/contrast, R, G and B represent the component values of brightness/contrast respectively. |
| colorTemperature | Color temperature (Range: 2000 to 10000) |
| hue | Hue |
| saturation | Saturation |
| interfaceId | Interface number |
| interfaceType | Interface type |
| resolution | Resolution |
| height | Height |
| isInterlace | |
| refresh | Refresh ratex100 |
| width | Width |
| usedEyeCare | Eye saver mode switch |
| eyeCare | Enable/disable the eye saver mode. (0: Disable, 1: Enable) |
| 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 |
| brightness | Screen brightness, value ranges from 0 to 100. |
Request
Body Params application/json
Example
{
"body": {
"screenId": 2,
"deviceId": 0
},
"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/screen/readDetail' \
--header 'Content-Type: application/json' \
--data-raw '{
"body": {
"screenId": 2,
"deviceId": 0
},
"sign": "MjI0OGYzMGQwMjhlMmI4YTNmMjM2MjE3MjYzYTFkODg=",
"pId": "1",
"timeStamp": "1631949094265"
}'Responses
🟢200Successful
application/json
Body
Example
{
"body": {
"Bkg": {
"bkgId": 0,
"enable": 0,
"imgUrl": "/data/BKGImage/17590451345451.jpg"
},
"Freeze": {
"enable": 0
},
"Ftb": {
"enable": 1
},
"Osd": {
"deviceId": 0,
"enable": 0,
"global": {
"backgroundColor": {
"A": 0,
"B": 0,
"G": 0,
"R": 0
},
"backgroundEnable": 1,
"fontColor": {
"A": 100,
"B": 0,
"G": 0,
"R": 255
}
},
"isJudge": 0,
"position": {
"height": 540,
"width": 1920,
"x": 2285,
"y": 1115
},
"text": []
},
"OsdImage": {
"enable": 0,
"height": 300,
"image": {
"file": {
"fileLength": 4096,
"fileName": "",
"hashSum": 0,
"height": 0,
"width": 0
},
"opacity": 100
},
"isJudge": 0,
"type": 1,
"width": 1920,
"x": 1005,
"y": 1005
},
"audio": {
"audioOutputMode": 0,
"channelMode": 0,
"inputId": 255,
"inputType": 0,
"interfaceId": 255,
"isMute": 0,
"layerId": 255,
"outputChannelMode": 0,
"outputInterfaceId": 255,
"outputSlotId": 255,
"slotId": 255,
"volume": 0
},
"brightness": 100,
"deviceId": 0,
"gamma": 1,
"general": {
"createTime": "1757509392.7567859",
"name": "Screen 1"
},
"genlock": {
"enable": 0,
"status": 0
},
"genlockPhase": {
"phaseEn": 0,
"phaseOffset": 0
},
"imageQuality": [
{
"brightness": {
"B": 50,
"G": 50,
"R": 50,
"all": 50
},
"colorTemperature": 6500,
"contrast": {
"B": 50,
"G": 50,
"R": 50,
"all": 50
},
"eyeCare": 0,
"hue": 0,
"imageQualityMode": 0,
"saturation": 50
},
{
"brightness": {
"B": 50,
"G": 50,
"R": 50,
"all": 50
},
"colorTemperature": 5000,
"contrast": {
"B": 50,
"G": 50,
"R": 50,
"all": 50
},
"eyeCare": 1,
"hue": 0,
"imageQualityMode": 0,
"saturation": 50
},
{
"brightness": {
"B": 50,
"G": 50,
"R": 50,
"all": 50
},
"colorTemperature": 6500,
"contrast": {
"B": 50,
"G": 50,
"R": 50,
"all": 50
},
"eyeCare": 0,
"hue": 0,
"imageQualityMode": 1,
"saturation": 50
},
{
"brightness": {
"B": 35,
"G": 35,
"R": 35,
"all": 35
},
"colorTemperature": 5000,
"contrast": {
"B": 50,
"G": 50,
"R": 50,
"all": 50
},
"eyeCare": 1,
"hue": 0,
"imageQualityMode": 1,
"saturation": 50
},
{
"brightness": {
"B": 50,
"G": 50,
"R": 50,
"all": 50
},
"colorTemperature": 8700,
"contrast": {
"B": 55,
"G": 55,
"R": 55,
"all": 55
},
"eyeCare": 0,
"hue": 0,
"imageQualityMode": 2,
"saturation": 50
},
{
"brightness": {
"B": 50,
"G": 50,
"R": 50,
"all": 50
},
"colorTemperature": 5000,
"contrast": {
"B": 55,
"G": 55,
"R": 55,
"all": 55
},
"eyeCare": 1,
"hue": 0,
"imageQualityMode": 2,
"saturation": 50
},
{
"brightness": {
"B": 50,
"G": 50,
"R": 50,
"all": 50
},
"colorTemperature": 8700,
"contrast": {
"B": 55,
"G": 55,
"R": 55,
"all": 55
},
"eyeCare": 0,
"hue": 0,
"imageQualityMode": 3,
"saturation": 50
},
{
"brightness": {
"B": 50,
"G": 50,
"R": 50,
"all": 50
},
"colorTemperature": 5000,
"contrast": {
"B": 55,
"G": 55,
"R": 55,
"all": 55
},
"eyeCare": 1,
"hue": 0,
"imageQualityMode": 3,
"saturation": 50
}
],
"noTimeAudio": {
"audioOutputMode": 0,
"channelMode": 0,
"inputId": 255,
"inputType": 0,
"interfaceId": 255,
"isMute": 0,
"layerId": 255,
"outputChannelMode": 0,
"outputInterfaceId": 0,
"outputSlotId": 0,
"slotId": 255,
"volume": 100
},
"nonTime": 0,
"outputMode": {
"mosaic": {
"column": 1,
"edgeEnable": 0,
"edgeHeight": 0,
"edgeWidth": 0,
"row": 1
},
"offset": {
"x": 2285,
"y": 1115
},
"screenInterfaces": [
{
"connectCapacity": 0,
"cropx": 0,
"cropy": 0,
"dlId": 0,
"dotpitch": 2,
"funcCode": 0,
"height": 1080,
"interfaceId": 0,
"interfaceType": 2,
"isCardOnline": 1,
"isDL": 0,
"mirror": 0,
"modelId": 31552,
"outputId": 0,
"outputName": "output 5-1",
"resolution": {
"height": 1080,
"isInterlace": 0,
"refresh": 60,
"width": 1920
},
"rotate": 0,
"slotId": 4,
"width": 1920,
"x": 2285,
"y": 1115
}
],
"size": {
"height": 1080,
"width": 1920,
"x": 2285,
"y": 1115
}
},
"presetPoll": {
"enable": 0,
"presetGroupId": 0
},
"screen3D": {
"Emitter": 0,
"LeftFirstThenRight": 0,
"delayTimeMs": 7,
"delayTimeUs": 0,
"enable": 0,
"startPointLeftright": 960,
"startPointUpdown": 540,
"type": 0
},
"screenBrightness": -1,
"screenHDR": {
"ambientLight": 30,
"hdrEn": 0,
"hdrMode": 1,
"lowGray": 15,
"modeFlag": 4,
"peakLight": 1000
},
"screenId": 0,
"screenLayers": {
"deviceId": 0,
"screenId": 0,
"screenLayers": [
{
"audioStatus": {
"isAvailable": 0,
"isOpen": 0
},
"deviceId": 0,
"general": {
"flipType": 0,
"isBackground": false,
"isFreeze": false,
"layerId": 2,
"lock": 0,
"name": "Layer 3",
"sizeType": 0,
"type": 1,
"zorder": 1
},
"isExceedingLimit": false,
"layerId": 2,
"reverseControl": {
"ip": "",
"port": 18986
},
"screenId": 0,
"source": {
"channelId": 65535,
"channelNum": 1,
"connectCapacity": 0,
"cropId": 255,
"decodeId": 255,
"decodeMode": 255,
"functionType": 0,
"hardwareType": 0,
"inputId": 10,
"interfaceType": 27,
"intfCapacity": 255,
"modelId": 31504,
"montageId": 0,
"name": "input 3-4-1",
"originalCropId": 0,
"originalInputId": 0,
"pullId": 65535,
"slotId": 2,
"sourceId": 0,
"sourceType": 1,
"streamId": 65535,
"streamIndex": 0,
"templateId": 65535,
"videoMode": 255
},
"window": {
"height": 1080,
"lockRatio": 0,
"width": 960,
"x": 3245,
"y": 1115
}
},
{
"audioStatus": {
"isAvailable": 0,
"isOpen": 0
},
"deviceId": 0,
"general": {
"flipType": 0,
"isBackground": false,
"isFreeze": false,
"layerId": 0,
"lock": 0,
"name": "Layer 1",
"sizeType": 0,
"type": 1,
"zorder": 0
},
"isExceedingLimit": false,
"layerId": 0,
"reverseControl": {
"ip": "",
"port": 18986
},
"screenId": 0,
"source": {
"channelId": 65535,
"channelNum": 1,
"connectCapacity": 0,
"cropId": 255,
"decodeId": 255,
"decodeMode": 255,
"functionType": 0,
"hardwareType": 0,
"inputId": 8,
"interfaceType": 27,
"intfCapacity": 255,
"modelId": 31504,
"montageId": 0,
"name": "input 3-3-1",
"originalCropId": 0,
"originalInputId": 0,
"pullId": 65535,
"slotId": 2,
"sourceId": 0,
"sourceType": 1,
"streamId": 65535,
"streamIndex": 0,
"templateId": 65535,
"videoMode": 255
},
"window": {
"height": 1080,
"lockRatio": 0,
"width": 960,
"x": 2285,
"y": 1115
}
}
]
},
"screenType": 1,
"switchEffect": {
"PlayPGMIndex": 0,
"effectType": 0,
"switchEffect": 0,
"timeline": 4
},
"usedEyeCare": 0,
"usedImageQualityMode": 0
},
"msg": "",
"sign": "",
"status": 0
}Modified at 2026-02-03 03:27:47