Get a sync device

GET /clip/v2/resource/sync/sync_uuid

Get a sync device by UUID to read its current settings and associated synchronization area.

Example response

{
  "code": 0,
  "data": {
    "arr": [],
    "obj": {
      "ability": 0,
      "area_id": "",
      "area_name": "",
      "brightness": 0,
      "color_config": 1,
      "color_config_1": [
        {
          "position_x": 0,
          "position_y": 0,
          "x": 39914,
          "y": 20037
        },
        {
          "position_x": 0,
          "position_y": 0,
          "x": 35106,
          "y": 23392
        },
        {
          "position_x": 0,
          "position_y": 0,
          "x": 30699,
          "y": 25918
        },
        {
          "position_x": 0,
          "position_y": 0,
          "x": 26911,
          "y": 28294
        },
        {
          "position_x": 0,
          "position_y": 0,
          "x": 21508,
          "y": 33694
        }
      ],
      "color_config_2": [
        {
          "position_x": 0,
          "position_y": 0,
          "x": 22549,
          "y": 20601
        },
        {
          "position_x": 0,
          "position_y": 0,
          "x": 26568,
          "y": 23298
        },
        {
          "position_x": 0,
          "position_y": 0,
          "x": 18270,
          "y": 21550
        },
        {
          "position_x": 0,
          "position_y": 0,
          "x": 9864,
          "y": 16510
        }
      ],
      "color_config_3": [
        {
          "position_x": 0,
          "position_y": 0,
          "x": 14023,
          "y": 17723
        },
        {
          "position_x": 0,
          "position_y": 0,
          "x": 17431,
          "y": 21480
        },
        {
          "position_x": 0,
          "position_y": 0,
          "x": 20999,
          "y": 26121
        }
      ],
      "color_config_4": [
        {
          "position_x": 0,
          "position_y": 0,
          "x": 9672,
          "y": 6607
        },
        {
          "position_x": 0,
          "position_y": 0,
          "x": 37190,
          "y": 23165
        }
      ],
      "frequency": 0,
      "id": "5075D324-2DE0-4C08-AC1B-FB07B1C447A9",
      "mode": 0,
      "name": "",
      "on": 0,
      "source": 0,
      "stop_action": 0,
      "type": "sync"
    }
  },
  "msg": "success"
}

Responses

Status code	Meaning
200	OK

Response fields

HTTP 200 OK

Field	Type	Required	Description
code	integer	Yes	Status code
msg	string	Yes	Message
data	object	Yes	Response payload.
data.obj	object	Yes	Returned resource.
data.obj.id	string	Yes	Sync device ID
data.obj.type	string	Yes	Always sync.
data.obj.name	string	Yes	Name
data.obj.ability	integer	Yes	Capabilities. Reserved.
data.obj.on	integer	Yes	On/off state. 0: off; 1: on.
data.obj.brightness	integer	Yes	Brightness, from 1 to 100.
data.obj.source	integer	Yes	Input source. 0: HDMI1; 1: HDMI2.
data.obj.mode	integer	Yes	Mode. 0: video; 1: music; 2: game.
data.obj.frequency	integer	Yes	Intensity. 0: low; 1: medium; 2: high; 3: maximum.
data.obj.stop_action	integer	Yes	Stop action. 0 keeps the current state; 2 turns the lights off.
data.obj.color_config	integer	Yes	Selects the active preset: 1 uses color_config_1, 2 uses color_config_2, and so on.
data.obj.color_config_1	object[]	Yes	Configuration 1
data.obj.color_config_1[].x	integer	Yes	X coordinate
data.obj.color_config_1[].y	integer	Yes	Y coordinate
data.obj.color_config_2	object[]	Yes	Configuration 2
data.obj.color_config_2[].x	integer	Yes	X coordinate
data.obj.color_config_2[].y	integer	Yes	Y coordinate
data.obj.color_config_3	object[]	Yes	Configuration 3
data.obj.color_config_3[].x	integer	Yes	X coordinate
data.obj.color_config_3[].y	integer	Yes	Y coordinate
data.obj.color_config_4	object[]	Yes	Configuration 4
data.obj.color_config_4[].x	integer	Yes	X coordinate
data.obj.color_config_4[].y	integer	Yes	Y coordinate
data.obj.area_id	string	Yes	ID of the associated synchronization area.
data.obj.area_name	string	Yes	Name of the associated synchronization area.