# H Series OpenAPI Instructions ## Docs - [Instructions](https://openapi.novastar.tech/en/h/doc-7540897.md): - [Error Codes](https://openapi.novastar.tech/en/h/doc-7540898.md): - [Change History](https://openapi.novastar.tech/en/h/doc-8172172.md): ## API Docs - Devices [Read Device Detailed Information](https://openapi.novastar.tech/en/h/api-365455717.md): - Devices [Read Device Card Information](https://openapi.novastar.tech/en/h/api-365455718.md): - Devices [Read Device IP](https://openapi.novastar.tech/en/h/api-365455719.md): Return Value Description - Homepage [Read System Initialization Status](https://openapi.novastar.tech/en/h/api-365455720.md): - Homepage [Read Video Server Address](https://openapi.novastar.tech/en/h/api-365455721.md): This protocol will be abolished after V1.9.9.0. For details on the specific protocol for pulling monitoring streams, please refer to the following descriptions: - Screen [Set Screen Gamma](https://openapi.novastar.tech/en/h/api-365455722.md): - Screen [Display Screen ID](https://openapi.novastar.tech/en/h/api-414018586.md): Set whether to display screen ID on the Programming page. - Screen [Set Screen Brightness](https://openapi.novastar.tech/en/h/api-413981964.md): Set the screen brightness. Only the H_16xRJ45+2xfiber sending card, H_20xRJ45 sending card, H_4xfiber sending card and H_4xfiber sending card (enhanced) support this function. - Screen [Save Screen Brightness](https://openapi.novastar.tech/en/h/api-413982099.md): Save the screen brightness. Only the H_16xRJ45+2xfiber sending card, H_20xRJ45 sending card, H_4xfiber sending card and H_4xfiber sending card (enhanced) support this function. - Screen [Add Screens](https://openapi.novastar.tech/en/h/api-365455723.md): - Screen [Delete Screens](https://openapi.novastar.tech/en/h/api-365455724.md): - Screen [Read Screen Detailed Information](https://openapi.novastar.tech/en/h/api-365455725.md): - Screen [Query Screen List](https://openapi.novastar.tech/en/h/api-365455726.md): - Screen [Screen FTB](https://openapi.novastar.tech/en/h/api-365455727.md): - Screen [Set BKG](https://openapi.novastar.tech/en/h/api-365455728.md): - Screen [Set Freezing](https://openapi.novastar.tech/en/h/api-365455729.md): - Screen [Read Screen Not in Live Mode](https://openapi.novastar.tech/en/h/api-365455730.md): ``` - Screen [Set 3D Effect](https://openapi.novastar.tech/en/h/api-365455731.md): |Description| - Screen [Set Screen Layout Information](https://openapi.novastar.tech/en/h/api-365455732.md): |Description - Screen [Set Image OSD](https://openapi.novastar.tech/en/h/api-365455733.md): - Screen [Set Text OSD](https://openapi.novastar.tech/en/h/api-365455734.md): - Screen [Delete Multiple Screens](https://openapi.novastar.tech/en/h/api-365455735.md): - Screen [Rename Screens](https://openapi.novastar.tech/en/h/api-365455736.md): - Inputs [Read Input List](https://openapi.novastar.tech/en/h/api-365455737.md): |Description| - Inputs [Read Detailed Information of Specified Inputs](https://openapi.novastar.tech/en/h/api-365455738.md): crops: Cropping-related information - Inputs [Set Cropping](https://openapi.novastar.tech/en/h/api-365455739.md): - Inputs [Delete](https://openapi.novastar.tech/en/h/api-365455740.md): - Inputs [Edit Cropping](https://openapi.novastar.tech/en/h/api-365455741.md): - Inputs [Set Resolutions](https://openapi.novastar.tech/en/h/api-365455742.md): - Inputs [Set Timing](https://openapi.novastar.tech/en/h/api-365455743.md): - Inputs [Create Input Groups](https://openapi.novastar.tech/en/h/api-365455744.md): - Inputs [Sort Input Groups](https://openapi.novastar.tech/en/h/api-365455745.md): - Inputs [Edit Groups](https://openapi.novastar.tech/en/h/api-365455746.md): - Inputs [Delete Groups](https://openapi.novastar.tech/en/h/api-365455747.md): - Inputs [Delete Input Sources by Groups](https://openapi.novastar.tech/en/h/api-365455748.md): - Inputs [Import EDID](https://openapi.novastar.tech/en/h/api-365455749.md): - Inputs [Rename](https://openapi.novastar.tech/en/h/api-365455750.md): - Inputs [Create Signal Source Playlists](https://openapi.novastar.tech/en/h/api-365455751.md): Create the signal source playlist. - Inputs [Read Signal Source Playlists](https://openapi.novastar.tech/en/h/api-365455752.md): Returned Data Field Description - Inputs [Edit Signal Source Playlist Information](https://openapi.novastar.tech/en/h/api-365455753.md): - Inputs [Enable Signal Source Playlists](https://openapi.novastar.tech/en/h/api-365455754.md): deviceId: Device ID - Inputs [Delete Signal Source Playlists](https://openapi.novastar.tech/en/h/api-365455755.md): deviceId: Device ID - Outputs [Set Image Quality](https://openapi.novastar.tech/en/h/api-365455756.md): - Outputs [Set Gamma](https://openapi.novastar.tech/en/h/api-365455757.md): - Outputs [Set Output Locating](https://openapi.novastar.tech/en/h/api-365455758.md): - Outputs [Rename](https://openapi.novastar.tech/en/h/api-365455759.md): - Outputs [Set Timing for 4K Output Card](https://openapi.novastar.tech/en/h/api-365455760.md): - Outputs [Read Detailed Information](https://openapi.novastar.tech/en/h/api-365455761.md): - Outputs [Read Output List](https://openapi.novastar.tech/en/h/api-365455762.md): - Outputs [Se Output Timing](https://openapi.novastar.tech/en/h/api-365455763.md): - Outputs [Set Output Resolutions](https://openapi.novastar.tech/en/h/api-365455764.md): - Outputs [Set Areas Loaded by All-in-One Cards](https://openapi.novastar.tech/en/h/api-365455765.md): - Layers [Set Stream Pulling Rules for IPC Sources Only](https://openapi.novastar.tech/en/h/api-365455766.md): |Description| - Layers [Add Layers](https://openapi.novastar.tech/en/h/api-365455767.md): ``` - Layers [Delete Layers](https://openapi.novastar.tech/en/h/api-365455768.md): - Layers [Read Layer List](https://openapi.novastar.tech/en/h/api-365455769.md): Returned Data Field Description - Layers [Read Layer Details](https://openapi.novastar.tech/en/h/api-365455770.md): - Layers [Set Layer Basic Information](https://openapi.novastar.tech/en/h/api-365455771.md): |Description| - Layers [Read Layer Z-order](https://openapi.novastar.tech/en/h/api-365455772.md): ``` - Layers [Set Layer Information](https://openapi.novastar.tech/en/h/api-365455773.md): |Description| - Layers [Clear Layers](https://openapi.novastar.tech/en/h/api-365455774.md): - Layers [Set Layer Z-order](https://openapi.novastar.tech/en/h/api-365455775.md): layersZOrderAct: Operation type - Layers [Lock Layers](https://openapi.novastar.tech/en/h/api-365455776.md): Lock the layer. 0: disable (unlock), 1: enable (lock) - Layers [Change Layer Source Information](https://openapi.novastar.tech/en/h/api-365455777.md): ``` - Layers [Freeze Layers](https://openapi.novastar.tech/en/h/api-365455778.md): - Layers [Open Layer Layouts](https://openapi.novastar.tech/en/h/api-365455779.md): ``` - Presets [Create Presets](https://openapi.novastar.tech/en/h/api-365455780.md): - Presets [Delete Presets](https://openapi.novastar.tech/en/h/api-365455781.md): - Presets [Set Basic Information of Specified Presets](https://openapi.novastar.tech/en/h/api-365455782.md): - Presets [Load Presets](https://openapi.novastar.tech/en/h/api-365455783.md): - Presets [Read Detailed Information of Specified Presets](https://openapi.novastar.tech/en/h/api-365455784.md): - Presets [Clear Presets](https://openapi.novastar.tech/en/h/api-365455785.md): - Presets [Get Preset Group List](https://openapi.novastar.tech/en/h/api-365455786.md): |Description| - Presets [Create Preset Groups](https://openapi.novastar.tech/en/h/api-365455787.md): |Description| - Presets [Delete Preset Groups](https://openapi.novastar.tech/en/h/api-365455788.md): - Presets [Get Preset Group Enumeration](https://openapi.novastar.tech/en/h/api-365455789.md): - Presets [Play Preset Playlist](https://openapi.novastar.tech/en/h/api-365455790.md): deviceId: Device ID - Presets [Read All Presets](https://openapi.novastar.tech/en/h/api-365455791.md): - Presets [Read Preset Playlist](https://openapi.novastar.tech/en/h/api-365455792.md): - Presets [Read Current Played Preset](https://openapi.novastar.tech/en/h/api-365455793.md): deviceId: Device ID - Presets [Edit Preset Groups](https://openapi.novastar.tech/en/h/api-365455794.md): |Description - Presets [Overwrite Presets](https://openapi.novastar.tech/en/h/api-365455795.md): - BKG [Create BKG](https://openapi.novastar.tech/en/h/api-365455796.md): |Description - BKG [Delete BKG](https://openapi.novastar.tech/en/h/api-365455797.md): - BKG [Get BKG Detailed Information](https://openapi.novastar.tech/en/h/api-365455798.md): |Description - BKG [Comprehensive Query](https://openapi.novastar.tech/en/h/api-365455799.md): - IPC [IPC Source List](https://openapi.novastar.tech/en/h/api-365455800.md): - IPC [Read Specified Data in IPC Source List](https://openapi.novastar.tech/en/h/api-365455801.md): - IPC [IP Camera List](https://openapi.novastar.tech/en/h/api-365455802.md): |Description| - IPC [Obtain IPC Source Channel List](https://openapi.novastar.tech/en/h/api-365455803.md): - IPC [Obtain Details of IPC Source Channel List](https://openapi.novastar.tech/en/h/api-365455804.md): - IPC [Details of IPC Mosaic Source Channel Data](https://openapi.novastar.tech/en/h/api-365455805.md): - IPC [Add IPC Sources](https://openapi.novastar.tech/en/h/api-365455806.md): - IPC [Delete IPC Sources](https://openapi.novastar.tech/en/h/api-365455807.md): - IPC [Rename IPC Sources](https://openapi.novastar.tech/en/h/api-365455808.md): - IPC [Change IPC Source Channels](https://openapi.novastar.tech/en/h/api-365455809.md): - IPC [Add IPC Source Channels](https://openapi.novastar.tech/en/h/api-365455810.md): - IPC [Delete IPC Source Channels](https://openapi.novastar.tech/en/h/api-365455811.md): - IPC [IPC Source Slot List](https://openapi.novastar.tech/en/h/api-365455812.md): - IPC [IPC Sources and Channels](https://openapi.novastar.tech/en/h/api-365455813.md): - IPC [Check IPC Source Names](https://openapi.novastar.tech/en/h/api-365455814.md): - IPC [IPC Source Group List](https://openapi.novastar.tech/en/h/api-365455815.md): - IPC [Create IPC Source Groups](https://openapi.novastar.tech/en/h/api-365455816.md): - IPC [Delete IPC Source Groups](https://openapi.novastar.tech/en/h/api-365455817.md): - IPC [Change IPC Groups](https://openapi.novastar.tech/en/h/api-365455818.md): - IPC [Delete IPC Source Group Nodes](https://openapi.novastar.tech/en/h/api-365455819.md): - IPC [IPC Mosaic Source List](https://openapi.novastar.tech/en/h/api-365455820.md): |Description| - IPC [Create IPC Mosaic Source Templates](https://openapi.novastar.tech/en/h/api-365455821.md): |Description| - IPC [Update IPC Mosaic Source Templates](https://openapi.novastar.tech/en/h/api-365455822.md): |Description| - IPC [Delete IPC Mosaic Source Templates](https://openapi.novastar.tech/en/h/api-365455823.md): - IPC [Apply IPC Mosaic Source Templates](https://openapi.novastar.tech/en/h/api-365455824.md): - IPC [Rename IPC Mosaic Sources](https://openapi.novastar.tech/en/h/api-365455825.md):