Skip to content

Control a sync device ​

PUT /clip/v2/resource/sync/sync_uuid

Change a sync device's settings, such as its input source, mode, brightness, or color preset. Send only the fields you want to change; omitted fields retain their current values.

Example request

json
{
  "on": 1
}

Parameters ​

FieldLocationTypeRequiredDescription
onbodyintegerYesOn/off state. 0: off; 1: on.
modebodyintegerYesMode. 0: video; 1: music; 2: game.
frequencybodyintegerYesIntensity. 0: low; 1: medium; 2: high; 3: maximum.
sourcebodyintegerYesInput source. 0: HDMI1; 1: HDMI2.
brightnessbodyintegerYesBrightness, from 1 to 100.
color_configbodyintegerYesSelects the active preset: 1 uses color_config_1, 2 uses color_config_2, and so on.
color_config_1bodyColorXY[]YesConfiguration 1. 1-5 colors.
color_config_1[].xbodyintegerYesX coordinate
color_config_1[].ybodyintegerYesY coordinate
color_config_2bodyColorXY[]YesConfiguration 2. 1-5 colors.
color_config_2[].xbodyintegerYesX coordinate
color_config_2[].ybodyintegerYesY coordinate
color_config_3bodyColorXY[]YesConfiguration 3. 1-5 colors.
color_config_3[].xbodyintegerYesX coordinate
color_config_3[].ybodyintegerYesY coordinate
color_config_4bodyColorXY[]YesConfiguration 4. 1-5 colors.
color_config_4[].xbodyintegerYesX coordinate
color_config_4[].ybodyintegerYesY coordinate

Example response

json
{
  "code": 0,
  "data": {
    "arr": [],
    "obj": {}
  },
  "msg": "success"
}

Responses ​

Status codeMeaning
200OK

Response fields ​

HTTP 200 OK

FieldTypeRequiredDescription
codeintegerYesStatus code
msgstringYesMessage