定时亮度调节 - NovaCloud-CN

提示

通过此接口对播放器屏亮度进行定时控制

子账号只能操作本工作组以及子工作组的数据

高级接口。

请求参数

Header 参数

AppKey

string

接入键

必需

默认值:

Nonce

string

必需

随机字符串（8~64个字符，仅限数字或英文字母）

CurTime

string

必需

当前 UTC 时间戳

CheckSum

string

请求签名

必需

Body 参数application/json

playerIds

array[string]

播放器ID集合

必需

需要处理的播放器ID集合，最多支持100个播放器同时处理

schedules

array [object {6}]

定时计划

必需

startDate

string

起始日期

必需

定时计划起始日期，格式为YYYY-MM-DD（如：2023-01-01）

endDate

string

截止日期

必需

定时计划截止日期，格式为YYYY-MM-DD（如：2023-12-31），需大于起始日期

weekDays

array[integer]

生效星期配置

可选

定时计划星期配置，有效元素范围0-6：0-周日，1-周一，2-周二，3-周三，4-周四，5-周五，6-周六。存在元素时表示当天计划生效，缺省或空集合表示有效期内每日执行。

execTime

string

执行时间

必需

计划执行时间，采用24小时制HH:MM:SS格式（如：21:00:00）。终端根据系统本地时间来触发执行计划

type

integer

控制类型

必需

1：手动，2：自动

value

integer

手动控制值

可选

手动控制时必填。亮度百分比，有效范围：0-100

autoProfile

object

自动亮度配置表制

可选

控制类型为自动时，该参数必选

failValue

integer

备用亮度值

必需

环境亮度获取失败时，缺省使用的亮度百分比，有效范围：0-100

segments

array [object {3}]

亮度分段

必需

一组环境亮度与屏幕亮度的对应关系

示例

{
  "playerIds": [
    "17",
    "8",
    "7"
  ],
  "schedules": [
    {
      "startDate": "2025-01-01",
      "endDate": "2025-12-31",
      "weekDays": [
        1,
        2,
        3,
        4,
        5
      ],
      "execTime": "07:30:00",
      "type": 2
    },
    {
      "startDate": "2025-01-01",
      "endDate": "2025-12-31",
      "weekDays": [
        1,
        2,
        3,
        4,
        5
      ],
      "execTime": "19:00:00",
      "type": 1,
      "value": 40
    }
  ],
  "autoProfile": {
    "failValue": 50,
    "segments": [
      {
        "environmentBrightness": 0,
        "screenBrightness": 5,
        "id": 0
      },
      {
        "environmentBrightness": 10917,
        "screenBrightness": 18,
        "id": 1
      },
      {
        "environmentBrightness": 21833,
        "screenBrightness": 35,
        "id": 2
      },
      {
        "environmentBrightness": 32750,
        "screenBrightness": 51,
        "id": 3
      },
      {
        "environmentBrightness": 43667,
        "screenBrightness": 67,
        "id": 4
      },
      {
        "environmentBrightness": 54583,
        "screenBrightness": 84,
        "id": 5
      },
      {
        "environmentBrightness": 65500,
        "screenBrightness": 100,
        "id": 6
      }
    ]
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://open-cn.vnnox.com/v2/player/scheduled-control/brightness' \
--header 'AppKey;' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "playerIds": [
        "17",
        "8",
        "7"
    ],
    "schedules": [
        {
            "startDate": "2025-01-01",
            "endDate": "2025-12-31",
            "weekDays": [
                1,
                2,
                3,
                4,
                5
            ],
            "execTime": "07:30:00",
            "type": 2
        },
        {
            "startDate": "2025-01-01",
            "endDate": "2025-12-31",
            "weekDays": [
                1,
                2,
                3,
                4,
                5
            ],
            "execTime": "19:00:00",
            "type": 1,
            "value":40
        }
    ],
    "autoProfile": {
        "failValue": 50,
        "segments": [
            {
                "environmentBrightness": 0,
                "screenBrightness": 5,
                "id": 0
            },
            {
                "environmentBrightness": 10917,
                "screenBrightness": 18,
                "id": 1
            },
            {
                "environmentBrightness": 21833,
                "screenBrightness": 35,
                "id": 2
            },
            {
                "environmentBrightness": 32750,
                "screenBrightness": 51,
                "id": 3
            },
            {
                "environmentBrightness": 43667,
                "screenBrightness": 67,
                "id": 4
            },
            {
                "environmentBrightness": 54583,
                "screenBrightness": 84,
                "id": 5
            },
            {
                "environmentBrightness": 65500,
                "screenBrightness": 100,
                "id": 6
            }
        ]
    }
}'

返回响应

🟢200成功

application/json

Body

success

array[string]

成功播放器ID集合

必需

fail

array[string]

失败播放器ID集合

必需

示例

{
  "success": [
    "8f29699ae6db7c584b60fa345c984a0e",
    "f14cb76a01320c2c4fba81bc0cb4b3af",
    "85dacf69cb2c57bb508a6d126d189383",
    "8921b722dc7f6b1b1e20dafcf553a554",
    "6c09ee7576f9ec298be5e20e21569adb",
    "f4db107e317e841585bbd7a67573885e",
    "9b9ce094e2b9d70576460bd4c475748d"
  ],
  "fail": []
}