Skip to content

List sync devices ​

GET /clip/v2/resource/sync

List all sync devices and their current settings, including the input source, mode, brightness, and color presets.

Example response

json
{
  "code": 0,
  "data": {
    "arr": [
      {
        "id": "5075D324-2DE0-4C08-AC1B-FB07B1C447A9",
        "type": "sync",
        "name": "",
        "ability": 0,
        "on": 0,
        "brightness": 0,
        "source": 0,
        "mode": 0,
        "frequency": 0,
        "stop_action": 0,
        "color_config": 1,
        "color_config_1": [
          {
            "position_x": 0,
            "position_y": 0,
            "x": 39914,
            "y": 20037
          }
        ],
        "color_config_2": [],
        "color_config_3": [],
        "color_config_4": [],
        "area_id": "",
        "area_name": ""
      }
    ],
    "len": 1,
    "obj": {}
  },
  "msg": "success"
}

Responses ​

Status codeMeaning
200OK

Response fields ​

HTTP 200 OK

FieldTypeRequiredDescription
codeintegerYesStatus code
msgstringYesMessage
dataobjectYesResponse payload.
data.objobjectYesReturned resource.
data.arrobject[]NoReturned resources.
data.arr[].idstringYesSync device ID
data.arr[].typestringYesAlways sync.
data.arr[].namestringYesName
data.arr[].abilityintegerYesCapabilities. Reserved.
data.arr[].onintegerYesOn/off state. 0: off; 1: on.
data.arr[].brightnessintegerYesBrightness, from 1 to 100.
data.arr[].sourceintegerYesInput source. 0: HDMI1; 1: HDMI2.
data.arr[].modeintegerYesMode. 0: video; 1: music; 2: game.
data.arr[].frequencyintegerYesIntensity. 0: low; 1: medium; 2: high; 3: maximum.
data.arr[].stop_actionintegerYesStop action. 0 keeps the current state; 2 turns the lights off.
data.arr[].color_configintegerYesSelects the active preset: 1 uses color_config_1, 2 uses color_config_2, and so on.
data.arr[].color_config_1object[]YesConfiguration 1
data.arr[].color_config_1[].xintegerYesX coordinate
data.arr[].color_config_1[].yintegerYesY coordinate
data.arr[].color_config_2object[]YesConfiguration 2
data.arr[].color_config_2[].xintegerYesX coordinate
data.arr[].color_config_2[].yintegerYesY coordinate
data.arr[].color_config_3object[]YesConfiguration 3
data.arr[].color_config_3[].xintegerYesX coordinate
data.arr[].color_config_3[].yintegerYesY coordinate
data.arr[].color_config_4object[]YesConfiguration 4
data.arr[].color_config_4[].xintegerYesX coordinate
data.arr[].color_config_4[].yintegerYesY coordinate
data.arr[].area_idstringYesID of the associated synchronization area.
data.arr[].area_namestringYesName of the associated synchronization area.