NovaCloud-EN

Screenshots

POST

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

TIP

This interface is used for obtaining the real-time screenshots of the playback window.

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

Advanced interface.

Request

Header Params

AppKey

string

required

Access key

Default:

Nonce

string

required

Random string (8-64 characters, only numbers or letters)

CurTime

string

required

The current UTC timestamp

CheckSum

string

required

Request signature

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.

noticeUrl

string

required

After a screenshot is captured successfully, this interface will send the address of the screenshot to the customer in the way of [POST-JSON]. The corresponding time of the interface cannot exceed 3s.

Example

{
  "playerIds": [
    "df6c02352e4fd3cd5bc664fcdaef29c9"
  ],
  "noticeUrl": "http://sit-api.vnnox.com/test/noticeScreenShotUrl"
}

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-capture' \
--header 'AppKey;' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
     "playerIds": [
        "df6c02352e4fd3cd5bc664fcdaef29c9"
    ],
    "noticeUrl":"http://sit-api.vnnox.com/test/noticeScreenShotUrl"
}'

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": [
    "df6c02352e4fd3cd5bc664fcdaef29c9"
  ],
  "fail": []
}

🟢200Call-back Request Parameters for Notifying Users of Screenshot Information

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

Brightness Adjustment

Volume Adjustment