H Series OpenAPI Instructions
Home
ChineseVersion
Home
ChineseVersion
  1. Presets
  • 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
    • Add Layers
    • Delete Layers
    • Read Layer List
    • Read Layer Details
    • Set Layer Basic Information
    • Read Layer Z-order
    • Set Layer Information
    • Clear Layers
    • Set Layer Z-order
    • Lock Layers
    • Change Layer Source Information
    • Freeze Layers
    • Open Layer Layouts
  • Presets
    • Create Presets
      POST
    • Delete Presets
      POST
    • Set Basic Information of Specified Presets
      POST
    • Load Presets
      POST
    • Read Detailed Information of Specified Presets
      POST
    • Clear Presets
      POST
    • Get Preset Group List
      POST
    • Create Preset Groups
      POST
    • Delete Preset Groups
      POST
    • Get Preset Group Enumeration
      POST
    • Play Preset Playlist
      POST
    • Read All Presets
      POST
    • Read Preset Playlist
      POST
    • Read Current Played Preset
      POST
    • Edit Preset Groups
      POST
    • Overwrite Presets
      POST
  • 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. Presets

Create Presets

POST
/open/api/preset/createPreset

Request

Body Params application/json

Example
{
    "body": {
        "deviceId": 0,
        "name": "preset1",
        "screenId": 3,
        "overWrite": 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/preset/createPreset' \
--header 'Content-Type: application/json' \
--data-raw '{
    "body": {
        "deviceId": 0,
        "name": "preset1",
        "screenId": 3,
        "overWrite": 0
    },
    "sign": "MjI0OGYzMGQwMjhlMmI4YTNmMjM2MjE3MjYzYTFkODg=",
    "pId": "1",
    "timeStamp": "1631949094265"
}'

Responses

🟢200Successful
application/json
Body

Example
{
    "body": {
        "OSD": {
            "picEnable": 0,
            "wordEnable": 0
        },
        "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
        },
        "bkg": {
            "bkgEn": 0
        },
        "createTime": "0",
        "deviceId": 0,
        "layers": [
            {
                "audioStatus": {
                    "isAvailable": 1,
                    "isOpen": 0
                },
                "general": {
                    "flipType": 0,
                    "isBackground": false,
                    "isFreeze": false,
                    "layerId": 0,
                    "lock": 0,
                    "name": "图层 1",
                    "sizeType": 0,
                    "type": 1,
                    "zorder": 0
                },
                "isExceedingLimit": false,
                "source": {
                    "channelId": 65535,
                    "connectCapacity": 2,
                    "cropId": 255,
                    "decodeId": 255,
                    "decodeMode": 255,
                    "functionType": 0,
                    "hardwareType": 0,
                    "inputId": 4,
                    "interfaceType": 8,
                    "intfCapacity": 255,
                    "modelId": 31503,
                    "montageId": 0,
                    "name": "input 2-1",
                    "originalCropId": 0,
                    "originalInputId": 0,
                    "pullId": 65535,
                    "slotId": 1,
                    "sourceId": 0,
                    "sourceType": 1,
                    "streamId": 65535,
                    "streamIndex": 0,
                    "templateId": 65535,
                    "videoMode": 255
                },
                "window": {
                    "height": 1080,
                    "lockRatio": 0,
                    "width": 1920,
                    "x": 2825,
                    "y": 795
                }
            }
        ],
        "layoutTemplateId": 1,
        "name": "场景1-3",
        "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
        },
        "presetId": 3,
        "screen3D": {
            "Emitter": 0,
            "LeftFirstThenRight": 0,
            "delayTimeMs": 7,
            "delayTimeUs": 0,
            "enable": 0,
            "startPointLeftright": 960,
            "startPointUpdown": 540,
            "type": 0
        },
        "screenId": 0,
        "startTime": ""
    },
    "msg": "",
    "sign": "",
    "status": 0
}
Modified at 2026-02-02 08:00:29
Previous
Open Layer Layouts
Next
Delete Presets
Built with