Revamping interface definition. Not happy with the output of the last attempt.

This commit is contained in:
Jonathan Bernard 2016-03-14 03:47:28 -05:00
parent cf8aad8775
commit ecf83e8589

View File

@ -1,95 +1,73 @@
* Selection
# Selection
select (current)
artist <id | name>
album <id | name>
playlist <id | name>
file <id | name>
bookmark <id | name>
tag(s) <tag-names>
A selection can be a set of Artists, Albums, or songs. It is only ever one of
these things. So you can select multiple artists, or multiple albums, or
multiple songs.
* List
select {album, artist, file, playlist, tag} <id | name>
select {albums, artists, files, playlists, tags} where <criteria>
select files tagged as <tag>... and not as <tag>..
select playing {album, artist, file, playlist}
list (all)
artists <id | name>
albums <id | name>
playlists <id | name>
bookmarks <id | name>
files <id | name>
tag(s) <id | name>
selection
# Play Queue Management
* Playlist Addition
enqueue selection
enqueue <selection-criteria>
add selection to playlist <id | name>
create playlist <name>
add playlist <id | name> to playlist <id | name>
add album <id | name> to playlist <id | name>
add artist <id | name> to playlist <id | name>
add file <id | name> to playlist <id | name>
* Tagging
tag selection as <tags>
tag album <id | name> as <tags>
tag artist <id | name> as <tags>
tag file <id | name> as <tags>
tag playlist <id | name> as <tags>
tag current
album <tags>
artist <tags>
file <tags>
playlist <tags>
* Play Queue Modification
enque selection
enque album <id | name>
enque artist <id | name>
enque file <id | name>
enque playlist <id | name>
remove selection from queue
remove <selection-criteria> from queue
play selection
play album <id | name>
play artist <id | name>
play file <id | name>
play playlist <id | name>
play bookmark <id | name>
play <selection-criteria>
clear
queue
playlist < id | name >
selected playlist
selection
clear queue
set bookmark
# Tagging
* Transport operations
tag <tag>...
tag selection as <tag>...
tag <selection-criteria> as <tag>...
# List
list <selection-criteria>
list selected {albums, artists, files, playlists, tags}
list playing {albums, artists, files, playlists, tags}
# Playlist management
create playlist
create playlist from {selection, queue}
copy playlist <id | name> as <new name>
rename playlist <old name> to <new name>
add selection to playlist <id | name>
add <selection-criteria> to playlist <id | name>
remove selection from playlist <id | name>
remove <selection-criteria> from playlist <id | name>
clear playlist <id | name>
# Bookmarking
create bookmark
create bookmark on <playlist id | name> at <media file id | name>
rename bookmark <old name> to <new name>
# Transport Functions
play
pause
stop
rwd | rewind [<amount>]
ff | fastforward [<amount>]
prev [<count>]
next [<count>]
next <count>
prev <count>
ff <amount> <unit>
rw <amount> <unit>
jump <media file id | name>
# Misc
----
top-level commands:
select
list
add
create
enque
tag
play
pause
stop
next
prev
ff
rwd
clear
scan
clear