Commit acc18f2c authored by David Trattnig's avatar David Trattnig
Browse files

Documentation for track service API.

parent 872e9799
......@@ -29,6 +29,8 @@ specifically build for the requirements of community radios.
- Multichannel Line-out
- Blank Detenction / Silence Detecter
- Auto Pilot a.k.a. Fallback Handling
- API to query Track-Service
- API to query programme
Read more on the [Engine Features](docs/ page.
......@@ -49,3 +49,14 @@ fallback handling scenarios. The available fallbacks are evaluated in following
3.2 Station Fallback via local music folder
Note: All filenames in the music folder should be ASCII encoded, otherwise this may cause engine failures.
# Track-Service API
The Track Service API provides following endpoints:
* `/api/v1/` ............. Returns all Track Service entries for the last three hours
* `/api/v1/$ID` .......... Returns a Track Service entry by ID
* `/api/v1/current` ...... Returns the currently playing track
* `/api/v1/day/$DAY` ..... Returns the tracks for a given day formated as `YYYY-MM-DD`
# Programme API
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment