From 53808bee74f78ebc36f6f0ec0152e5929470fd9e Mon Sep 17 00:00:00 2001 From: nuttylmao <76841561+nuttylmao@users.noreply.github.com> Date: Mon, 29 Jun 2026 04:49:55 +1000 Subject: [PATCH] Update README.md --- README.md | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1ba412d..2ca707c 100644 --- a/README.md +++ b/README.md @@ -18,12 +18,12 @@ Simply open run the application, and a local web server will run in the backgrou | `GET` | `/now-playing` | Returns the current media state as JSON. | | `GET` | `/sessions` | Returns a list of all active media sessions. | -### Data Schema +### Schema The `/now-playing` endpoint provides a real-time snapshot of your active media sessions. Developers can integrate this into their own web widgets using the following JSON structure: ```json { - "app_version": "0.0.1", + "app_version": "string", "current_session_id": "string", "sessions": [ { @@ -59,6 +59,33 @@ The `/now-playing` endpoint provides a real-time snapshot of your active media s } ``` +### Enums + +#### Playback Status +| Value | Status | Description | +| :--- | :--- | :--- | +| `0` | `CLOSED` | Engine uninitialized or empty | +| `1` | `OPENED` | Pipeline loaded but idling | +| `2` | `CHANGING` | Buffering, track skipping, or seeking | +| `3` | `STOPPED` | Track queued but fully stopped | +| `4` | `PLAYING` | Audio actively streaming | +| `5` | `PAUSED` | Audio frozen | + +#### Playback Type +| Value | Type | Description | +| :--- | :--- | :--- | +| `0` | `UNKNOWN` | Generic audio wrapper | +| `1` | `MUSIC` | Pure audio pipeline (Spotify, iTunes, etc.) | +| `2` | `VIDEO` | Visual media feed (YouTube, Twitch, etc.) | +| `3` | `IMAGE` | Static slideshow presentation hook | + +#### Auto Repeat Mode +| Value | Mode | Description | +| :--- | :--- | :--- | +| `0` | `NONE` | Plays queue through and terminates | +| `1` | `TRACK` | Single active song looping | +| `2` | `LIST` | Parent playlist/album looping | + ## Credits Built and maintained by **nutty**. [Check out my other stream widgets here!](https://nutty.gg/)