Scheduled Brightness Adjustment

TIP

This interface provides scheduled brightness control for media players, with batch support for up to 100 players.

Sub-accounts have permission to manage only players within their assigned workgroup and any nested sub-workgroups.

Advanced interface.

Request

Body Params application/json

playerIds

array[string]

required

Array of player IDs to process. Maximum batch size: 100 players.

schedules

array [object {6}]

required

A collection of time scheduling plans. If an empty array is passed, all set time schedules will be cleared.

startDate

string

required

The start date of the scheduled plan, in the format of YYYY-MM-DD (e.g. 2023-01-01)

endDate

string

required

The end date of the scheduled plan, in the format of YYYY-MM-DD (e.g. 2023-01-01)

weekDays

array[integer]

optional

Scheduled week configuration, effective elements range 0-6: 0-Sunday, 1-Monday, 2-Tuesday, 3-Wednesday, 4-Thursday, 5-Friday, 6-Saturday. If any element exists, the schedule takes effect on the day, and the default or empty collection indicates that it is executed every day within the validity period. And if the parameter is not provided, it indicates that the plan will executed daily.

execTime

string

required

The scheduled execution time is in 24-hour HH:MM:SS format (for example, 21:00:00). Note: The player triggers the execution plan based on the player local time.

type

integer

required

Control type, 0 for fix control, 1 for auto smart contorl.

value

integer

optional

Player brightness percentage, valid range: 0-100, If the control type is set to 0, then this parameter is required.

autoProfile

object

optional

Auto brightness configuration profile, This parameter is required unless all scheduled plans are fixed (type=0).

failValue

integer

required

The default fallback brightness pecentage value, the valid range is: 0-100. When the environmental brightness failes to be obtained, the fallback value is used.

segments

array [object {3}]

required

An array of auto-brightness segments that maps environmental brightness to screen target brightness (X-Y relationship).

Example

{
    "playerIds": [
        "8f29699ae6db7c584b60fa345c984a0e",
        "f14cb76a01320c2c4fba81bc0cb4b3af",
        "85dacf69cb2c57bb508a6d126d189383",
        "8921b722dc7f6b1b1e20dafcf553a554",
        "6c09ee7576f9ec298be5e20e21569adb",
        "f4db107e317e841585bbd7a67573885e",
        "9b9ce094e2b9d70576460bd4c475748d"
    ],
    "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": 500,
                "screenBrightness": 20,
                "id": 0
            },
            {
                "environmentBrightness": 1200,
                "screenBrightness": 30,
                "id": 1
            },
            {
                "environmentBrightness": 2000,
                "screenBrightness": 40,
                "id": 2
            },
            {
                "environmentBrightness": 5000,
                "screenBrightness": 60,
                "id": 3
            },
            {
                "environmentBrightness": 8000,
                "screenBrightness": 80,
                "id": 4
            },
            {
                "environmentBrightness": 12000,
                "screenBrightness": 90,
                "id": 5
            },
            {
                "environmentBrightness": 30000,
                "screenBrightness": 100,
                "id": 6
            }
        ]
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://open-us.vnnox.com/v2/player/scheduled-control/brightness' \
--header 'Content-Type: application/json' \
--data-raw '{
    "playerIds": [
        "8f29699ae6db7c584b60fa345c984a0e",
        "f14cb76a01320c2c4fba81bc0cb4b3af",
        "85dacf69cb2c57bb508a6d126d189383",
        "8921b722dc7f6b1b1e20dafcf553a554",
        "6c09ee7576f9ec298be5e20e21569adb",
        "f4db107e317e841585bbd7a67573885e",
        "9b9ce094e2b9d70576460bd4c475748d"
    ],
    "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": 500,
                "screenBrightness": 20,
                "id": 0
            },
            {
                "environmentBrightness": 1200,
                "screenBrightness": 30,
                "id": 1
            },
            {
                "environmentBrightness": 2000,
                "screenBrightness": 40,
                "id": 2
            },
            {
                "environmentBrightness": 5000,
                "screenBrightness": 60,
                "id": 3
            },
            {
                "environmentBrightness": 8000,
                "screenBrightness": 80,
                "id": 4
            },
            {
                "environmentBrightness": 12000,
                "screenBrightness": 90,
                "id": 5
            },
            {
                "environmentBrightness": 30000,
                "screenBrightness": 100,
                "id": 6
            }
        ]
    }
}'

Responses

🟢200Success

application/json

Body

success

array[string]

required

fail

array[string]

required

Example

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