Prepare v2.0.0 release
This commit is contained in:
+12
-39
@@ -2,7 +2,7 @@
|
||||
|
||||
## Overview
|
||||
|
||||
Player service websocket base URL: `ws://localhost:3001`
|
||||
Player service websocket base URL: `ws://localhost:8081`
|
||||
|
||||
This document uses OpenAPI-style sections, but stays in plain markdown.
|
||||
|
||||
@@ -28,29 +28,7 @@ Access: internal-only. The web backend subscribes with signed request headers; b
|
||||
|
||||
### Messages from player to server
|
||||
|
||||
The player sends two message types:
|
||||
|
||||
- `hello`
|
||||
- `state`
|
||||
|
||||
#### `hello`
|
||||
|
||||
Example payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "hello",
|
||||
"clientId": "client-id",
|
||||
"clientName": "friendly label",
|
||||
"deviceId": "device-id",
|
||||
"userAgent": "browser ua",
|
||||
"page": "http://.../screen/demo",
|
||||
"viewport": { "width": 1920, "height": 1080 },
|
||||
"paused": false,
|
||||
"blackout": false,
|
||||
"currentSlide": null
|
||||
}
|
||||
```
|
||||
The player sends a state snapshot message.
|
||||
|
||||
#### `state`
|
||||
|
||||
@@ -67,16 +45,13 @@ Example payload:
|
||||
"viewport": { "width": 1920, "height": 1080 },
|
||||
"paused": false,
|
||||
"blackout": false,
|
||||
"currentSlide": {
|
||||
"id": 12,
|
||||
"title": "Main Slide",
|
||||
"kind": "image",
|
||||
"playlistSignature": "..."
|
||||
}
|
||||
"currentSlide": null
|
||||
}
|
||||
```
|
||||
|
||||
The server recognizes `clientId`, `clientName`, `deviceId`, `userAgent`, `page`, `viewport`, `paused`, `blackout`, and `currentSlide` from player messages. When `currentSlide` is present, the player includes the active slide id, title, kind, and playlist signature.
|
||||
When `currentSlide` is present, the player includes the active slide id, title, kind, and playlist signature.
|
||||
|
||||
The server recognizes `clientId`, `clientName`, `deviceId`, `userAgent`, `page`, `viewport`, `paused`, `blackout`, and `currentSlide` from state messages.
|
||||
|
||||
### Messages from server to player
|
||||
|
||||
@@ -92,15 +67,13 @@ The server sends command messages with:
|
||||
|
||||
Supported commands:
|
||||
|
||||
- `blackout`
|
||||
- `next`
|
||||
- `pause`
|
||||
- `previous`
|
||||
- `refresh`
|
||||
- `reload`
|
||||
- `redirect`
|
||||
- `pause`
|
||||
- `blackout`
|
||||
- `previous`
|
||||
- `next`
|
||||
- `left`
|
||||
- `right`
|
||||
- `setclientname`
|
||||
|
||||
#### `refresh`
|
||||
@@ -130,10 +103,10 @@ Use `false` to restore and `true` to blackout.
|
||||
#### `redirect`
|
||||
Requests the player page to navigate to a new location. The destination is supplied as `url` by the caller that forwarded the command.
|
||||
|
||||
#### `previous` / `left`
|
||||
#### `previous`
|
||||
Moves to the previous slide.
|
||||
|
||||
#### `next` / `right`
|
||||
#### `next`
|
||||
Moves to the next slide.
|
||||
|
||||
#### `setclientname`
|
||||
|
||||
Reference in New Issue
Block a user