getPlayerPreviewSession

GET

/api/v1/player/preview-session

curl --request GET \
  --url https://example.com/api/v1/player/preview-session \
  --header 'Authorization: Bearer <token>'

Read the screen’s current preview session for uploading frames. Requires an authenticated player credential.

Authorizations

• deviceBearer

Responses

200

Current preview session

Media typeapplication/json

object

data

required

object

active

required

boolean

expiresAt

string format: date-time

captureIntervalSeconds

required

integer

captureNow

required

boolean

Example^generated

{
  "data": {
    "active": true,
    "expiresAt": "2026-04-15T12:00:00Z",
    "captureIntervalSeconds": 1,
    "captureNow": true
  }
}

401

Credential invalid or revoked