PM123's Remote command reference - Playlist commands

See also playlist manipulation commands.

Command Description Reply
playlist <url> (1.) Select a playlist or a folder as navigation root. This setting only affects the pipe interface. To play a playlist use the load command. URL or empty line on error.
pl next [<count> [<type>]]
pl prev [<count> [<type>]]
Navigate to the next or previous song in the current root. If <count> is specified, you can skip more than one song at once. next will enter nested playlists.(2.) The navigation will also return sons in nested playlists.
<type> can be song, playlist, invalid or a comma separated list of them. The navigation will only return matching items. By default only songs are returned. If you chose to return songs and playlists the playlist is always returned before its songs, regardless whether you navigate forward or backwards.
URL of the item or an empty line at the end of the playlist.
pl nextitem [<count> [<type>]]
pl previtem [<count> [<type>]]
Navigate to the next or previous item within the current lowermost playlist in the call stack. If <count> is specified, you can skip more than one item at once.
<type> can be song, playlist, invalid or a comma separated list of them. The navigation will only return matching items. By default all items are returned.
URL of the item or an empty line at the end of the playlist.
pl enter Enter the current playlist and continue in a nested playlist. This will not advance to the first item of the entered playlist.
You cannot enter recursive playlists.
URL of the playlist or an empty line on error.
pl leave [<count>] Leave the current innermost playlist and return to the  parent playlist.. If <count> is specified, you can leave more than one nested playlist at once. URL of the new current playlist or an empty line on error.
pl navigate [<location>] Return the current location and optionally navigate within the playlist. The command uses the location string syntax. Current location or empty on error.
pl reset Reset the current item of the playlist. The current location is now before the start or past the end respectively. URL of the previous current item or an empty line if none.
pl current Query the current root playlist. This is not necessarily the parent of the current item. URL of the item or an empty line if none.
pl parent Query the parent of the current item. This is  always the lowermost call stack entry. URL of the playlist or an empty line if none.
pl item Query the current item in the current playlist. This is initially the current playlist. URL of the current item or an empty line on error.
pl index Query the song index of the current item within the current (nested) playlist. Index starting from 1 or empty in case of no current item.
If the item is detached from the playlist the return value is 0.
pl itemindex Query the index of the current item within its parent playlist. Index starting from 1 or empty in case of no current item.
pl depth Get the current call stack depth. 0 = we are at the root,
1 = we are at a playlist item,  2 = we are at a nested item ...
empty on error
pl callstack Query the current call stack when navigating in recursive playlists. The command uses location string syntax.
This is similar to pl navigate, but does not include the location within the current song.
URLs of parent playlists. Semicolon delimited and from top to bottom, empty on error.
use Use the current playlist. This is equivalent to 'load <URL to current playlist>'. Result code, non-zero = error.
pl load Use the current playlist item as new root to play. Result code, non-zero = error.
pl enqueue Plays the current playlist item after the current playback has completed. This command will always append to the default playlist. If the default playlist is not yet in use it is cleared and the currently loaded object is placed as first element if any. This will never intercept any active playback. Result code, non-zero = error.
pl navto Navigate to the current playlist item. If the current playlist item is just playing, playback of this item starts from the beginning. If the currently loaded playlist is in the call stack of the current playlist item or the other way around, then the command causes only a navigation. In all other cases  the command will also load the current root as playlist. Result code, non-zero = error.

Notes

  1. If you pass relative URLs the path set with the cd command is used as root. Note that this does not apply to location strings.

  2. Note that the navigation will never enter recursive playlists. But the recursive list itself is reported if the playlist type is specified.