getPlayerLiveStreamSession

GET

/api/v1/player/live-stream-session

curl --request GET \
  --url 'https://example.com/api/v1/player/live-stream-session?captureProfile=edge-540p10' \
  --header 'Authorization: Bearer <token>'

Read the screen’s current live stream session, if any. Requires an authenticated player credential.

Authorizations

• deviceBearer

Parameters

Query Parameters

captureProfile

string

Allowed values: edge-540p10

Optional Watch Live capture profile supported by this Player. Omit it to retain the legacy 640x360 at 8 FPS profile.

Responses

200

Current live stream session

Media typeapplication/json

object

data

required

object

id

required

string format: uuid

screenId

required

string format: uuid

active

required

boolean

expiresAt

required

string format: date-time

frameIntervalMillis

required

integer

maxWidth

required

integer

maxHeight

required

integer

maxFrameBytes

required

integer

Example^generated

{
  "data": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "screenId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "active": true,
    "expiresAt": "2026-04-15T12:00:00Z",
    "frameIntervalMillis": 1,
    "maxWidth": 1,
    "maxHeight": 1,
    "maxFrameBytes": 1
  }
}

401

Credential invalid or revoked