MyFavMirrors/owntone-server
1
0
Fork 0
mirror of https://github.com/owntone/owntone-server.git synced 2024-12-28 08:05:56 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1045 from whatdoineed2do/README-smart-json-upd

Browse Source 
[README] smart pl and  json update
This commit is contained in:
ejurgensen 2020-07-04 13:29:52 +02:00 committed by GitHub
commit e393d4a59d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README_JSON_API.md
View File

@ -640,6 +640,7 @@ POST /api/queue/items/add
| playback_from_position | *(Optional)* If the `playback` parameter is set to `start`, playback will be started with the queue item at the position given in `playback_from_position`. | | playback_from_position | *(Optional)* If the `playback` parameter is set to `start`, playback will be started with the queue item at the position given in `playback_from_position`. |
| clear | *(Optional)* If the `clear` parameter is set to `true`, the queue will be cleared before adding the new items. | | clear | *(Optional)* If the `clear` parameter is set to `true`, the queue will be cleared before adding the new items. |
| shuffle | *(Optional)* If the `shuffle` parameter is set to `true`, the shuffle mode is activated. If it is set to something else, the shuffle mode is deactivated. To leave the shuffle mode untouched the parameter should be ommited. | | shuffle | *(Optional)* If the `shuffle` parameter is set to `true`, the shuffle mode is activated. If it is set to something else, the shuffle mode is deactivated. To leave the shuffle mode untouched the parameter should be ommited. |
| limit | *(Optional)* Maximum number of tracks to add |
Either the `uris` or the `expression` parameter must be set. If both are set the `uris` parameter takes presedence and the `expression` parameter will be ignored. Either the `uris` or the `expression` parameter must be set. If both are set the `uris` parameter takes presedence and the `expression` parameter will be ignored.
@ -678,6 +679,16 @@ curl -X POST "http://localhost:3689/api/queue/items/add?expression=media_kind+is
} }
``` ```
Clear current queue, add 10 new random tracks of `genre` _Pop_ and start playback
```
curl -X POST "http://localhost:3689/api/queue/items/add?limit=10&clear=true&playback=start&expression=genre+is+%22Pop%22+order+by+random+desc"
```
```json
{
"count": 10
}
```
### Moving a queue item ### Moving a queue item

13
README_SMARTPL.md
View File

@ -46,6 +46,7 @@ Where valid field-names (with their types) are:
* `time_modified` (date) * `time_modified` (date)
* `time_played` (date) * `time_played` (date)
* `time_skipped` (date) * `time_skipped` (date)
* `random` (special)
Valid operators include: Valid operators include:
* `is`, `includes`, `starts with` (string) * `is`, `includes`, `starts with` (string)
@ -86,6 +87,8 @@ It is possible to define the sort order and limit the number of items by adding
"sort-direction" is either `ASC` (ascending) or `DESC` (descending). "limit" is the maximum number of items. "sort-direction" is either `ASC` (ascending) or `DESC` (descending). "limit" is the maximum number of items.
There is additionally a special `random` _field-name_ that can be used in conjunction with `limit` to select a random number of items based on current expression.
## Examples ## Examples
@ -136,6 +139,16 @@ This would match any podcast and audiobook file that was never played with forke
``` ```
This would match the last 10 music files added to the library. This would match the last 10 music files added to the library.
```
"Random 10 Rated Pop songs" {
rating > 0 and
genre is "Pop" and
media_kind is music
order by random desc
limit 10
}
```
This generates a random set of, maximum of 10, rated Pop music tracks every time the playlist is queried.
## Date operand syntax ## Date operand syntax