Update README.md

This commit is contained in:
nuttylmao
2026-06-29 04:44:51 +10:00
committed by GitHub
parent 758a63a6a2
commit cd17f85f81
+45 -4
View File
@@ -6,6 +6,11 @@ This lightweight system tray application allows evelopers can easily create thei
Simply open run the application, and a local web server will run in the background, accessible via `http://127.0.0.1:5000/now-playing/` Simply open run the application, and a local web server will run in the background, accessible via `http://127.0.0.1:5000/now-playing/`
## Quick Start
1. Download the latest `.exe` from the [Releases page](releases).
2. Run the application — a tray icon will appear.
3. Right-click the icon to view the API.
### Endpoints ### Endpoints
| Method | Endpoint | Description | | Method | Endpoint | Description |
@@ -13,10 +18,46 @@ 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` | `/now-playing` | Returns the current media state as JSON. |
| `GET` | `/sessions` | Returns a list of all active media sessions. | | `GET` | `/sessions` | Returns a list of all active media sessions. |
## Quick Start ### Data Schema
1. Download the latest `.exe` from the [Releases page](releases). 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:
2. Run the application — a tray icon will appear.
3. Right-click the icon to view the API. ```json
{
"app_version": "0.0.1",
"current_session_id": "string",
"sessions": [
{
"source_app_id": "string",
"media_properties": {
"Title": "string",
"Artist": "string",
"AlbumTitle": "string",
"AlbumArtist": "string",
"Thumbnail": "string (base64)",
"AlbumTrackCount": "integer",
"TrackNumber": "integer",
"Genres": "array of strings",
"Subtitle": "string"
},
"playback_info": {
"PlaybackStatus": "integer",
"PlaybackType": "integer",
"PlaybackRate": "number or null",
"IsShuffleActive": "boolean",
"AutoRepeatMode": "integer"
},
"timeline_properties": {
"Position": "integer (ms)",
"StartTime": "integer (ms)",
"EndTime": "integer (ms)",
"MinSeekTime": "integer (ms)",
"MaxSeekTime": "integer (ms)",
"LastUpdatedTime": "string (ISO 8601)"
}
}
]
}
```
## Credits ## Credits
Built and maintained by **nutty**. Built and maintained by **nutty**.