[README] Add new seek parameter to JSON API documentation

This commit is contained in:
chme 2019-09-22 10:05:51 +02:00 committed by ejurgensen
parent 6e5d6791ff
commit 779e5b8617

View File

@ -288,6 +288,7 @@ PUT /api/player/seek
| Parameter | Value | | Parameter | Value |
| --------------- | ----------------------------------------------------------- | | --------------- | ----------------------------------------------------------- |
| position_ms | The new position in milliseconds to seek to | | position_ms | The new position in milliseconds to seek to |
| seek_ms | A relative amount of milliseconds to seek to |
**Response** **Response**
@ -296,10 +297,17 @@ On success returns the HTTP `204 No Content` success status response code.
**Example** **Example**
Seek to position:
```shell ```shell
curl -X PUT "http://localhost:3689/api/player/seek?position_ms=2000" curl -X PUT "http://localhost:3689/api/player/seek?position_ms=2000"
``` ```
Relative seeking (skip 30 seconds backwards):
```shell
curl -X PUT "http://localhost:3689/api/player/seek?seek_ms=-30000"
```
## Outputs / Speakers ## Outputs / Speakers