Screen Status

https://open-us.vnnox.com

POST

/v2/player/real-time-control/screen-status

TIP

This interface is used for controlling the screen status (black screen/normal).

Sub-accounts can only manage data within their specific workgroup and its sub-workgroups.

Advanced interface.

Request

Body Params application/json

playerIds

array[string]

required

A collection of player IDs to be handled. At most 100 player IDs can be handled simultaneously.

status

string

required

Status，OPEN-Normal，CLOSE-Black screen.

Example

{
    "playerIds": [
        "553cbfe2ff4ad2e0d6bd89bb2c4e85e2"
    ],
    "status": "OPEN"
}

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/real-time-control/screen-status' \
--header 'Content-Type: application/json' \
--data-raw '{
    "playerIds": [
        "553cbfe2ff4ad2e0d6bd89bb2c4e85e2"
    ],
    "status": "OPEN"
}'

Responses

🟢200OK

application/json

Body

success

array[string]

required

A collection of player IDs that are successfully sent.

fail

array[string]

required

A collection of player IDs that are not sent successfully.

Example

{
    "success": [
        "553cbfe2ff4ad2e0d6bd89bb2c4e85e2"
    ],
    "fail": []
}

Modified at 2024-08-07 01:35:37

Video Source Switching

Restart Players