Nearglass
Control API

A driver's turn (interactive streams)

The viewer's rights plus publish on `control/<namespace>/<turn_id>`. Token id `turn:<turn_id>`, subject `driver:<driver_ref>`. Your backend runs the queue of drivers; the device's Gate ends the turn at its own deadline.

POST
/v1/streams/{id}/controller-tokens

The viewer's rights plus publish on control/<namespace>/<turn_id>. Token id turn:<turn_id>, subject driver:<driver_ref>. Your backend runs the queue of drivers; the device's Gate ends the turn at its own deadline.

Authorization

secretKey
headerAuthorizationBearer <token>

sk_...

Path Parameters

id*string

Request Body

application/json
  1. body
turn_id*string

printable, no '/' or spaces

Lengthlength <= 59
driver_ref?string

default driver

ttl?integer

the turn plus a few seconds

Range1 <= value <= 3600
Default65

Response Body

minted

application/json
  1. response

A token and where to use it; the player and the SDK publisher take it whole.

token?string

the CAT, base64url without padding; CLIENT_SETUP AUTHORIZATION TOKEN type 1

token_id?|

the CWT cti: s-... (viewer), pub-... (SDK publisher asked with token_id), ing-... (gateway), turn: (controller); null for a device publisher token

expires_at?string
Formatdate-time
exp?integer

Unix seconds

relays?array<>
namespace?string
catalog?string
relay_cert_sha256?string

only for a relay with a self-signed certificate

hls?string

the LL-HLS playlist for the player fallback; with the API edge, /v1/play/{id}/hls/index.m3u8 and only for streams with encoder ingest

turn_id?string
control_namespace?string
Example Request
curl -X POST 'https://api.nearglass.com/v1/streams/st_8f2c41d09a7be3105c6e2d77/controller-tokens' \  -H 'Content-Type: application/json' \  -d '{  "turn_id": "t1",  "driver_ref": "user-4821",  "ttl": 65}'
Example Response
{  "token": "string",  "token_id": "string",  "expires_at": "2019-08-24T14:15:22Z",  "exp": 0,  "relays": [    {      "url": "string"    }  ],  "namespace": "string",  "catalog": "string",  "relay_cert_sha256": "string",  "hls": "string",  "turn_id": "string",  "control_namespace": "string"}

A seat and its viewer token (server admission), or a place in line POST

Call it from your backend after your own login. Without `seat`, a new seat id is made; while the viewer waits, call again with the `seat` from the last answer every `retry_after_ms`. A seat is kept by the player's heartbeat (`/v1/play/{id}/hb`): 20 s without one (60 s for a hidden tab) and the seat is lost and its relay sessions closed.

End a turn DELETE

Closes the turn's control session at the relay (admin close of turn:<turn_id>).