PM123's Remote Command Reference

PM123 currently understands the following commands (optional parameters are enclosed in square brackets).

Category playback control

Comand Desription Reply
load [<file>|<url>] Loads a <file> or <url> into the player. Plays it too, if 'auto play on load' is set. Result code, non-zero = error.
play [<file>|<url>] Starts playing.
If <file> or <url> was specified, it will be first loaded and playback will be started. Any currently playing item will be aborted.
Result code, non-zero = error.
stop Stops playback. Result code, non-zero = error.
pause [on|off](1) Pauses or unpauses the playback. Result code, non-zero = error.
next [<count>] Selects the next song in playlist. If <count> is specified, you can skip more than one song at once. Result code, non-zero = error.
previous [<count>] Selects the previous song in playlist. If <count> is specified, you can skip more than one song at once. Result code, non-zero = error.
rewind [on|off](1) Toggles or (re)sets rewind of the currently playing file. If rewind is activated fast forward is implicitely deactivated. Result code, non-zero = error.
forward [on|off](1) Toggles or (re)sets fast forward of the currently playing file. If fast forward is activated rewind is implicitely deactivated. Result code, non-zero = error.
navigate
song <url>
[time <time>[%]]
Navigate within the currently loaded playlist. Examples:
'navigate path ;D:\songs\song1.mp3' navigates to the start of the song within the currently loaded playlist. If the file is referenced twice, the first instance s taken.
'navigate song D:\songs\song1.mp3 time 1:02.7' navigates to location 62.7 seconds within the next occourency of .
Result code, non-zero = error.
navigate
path [;]<item>[;<subitem>[;...]]
[time <time>[%]]
Navigate within the currently loaded playlist. Examples:
'navigate path ;D:\songs\song1.mp3' navigates to the start of the song within the currently loaded playlist. If the file is referenced twice, the first instance s taken.
'navigate song D:\songs\song1.mp3 time 1:02.7' navigates to location 62.7 seconds within the next occourency of .
Result code, non-zero = error.
jump <n> Jump to <n> seconds in the currently playing file. <n> may be a fractional number. Result code, non-zero = error.
volume [[+|-]<n>] Sets volume to <n>% (scale 0-100, of course). If a sign is included, <n> is added to the current volume level. If <n> is ommitted the volume is unchanged. Previous volume setting or empty string on error.
shuffle [on|off](1) Toggles or (re)sets shuffling. Previous setting or empty string on error.
repeat [on|off](1) Toggles or (re)sets repeat. Previous setting or empty string on error.
hide Hides the player window.  
status tag|file|info Returns the information currently displayed in the scroller or returns nothing if "no file loaded". Info string.

Category Playlists

Comand Desription Reply
playlist <file>|<folder> Select a playlist or a folder. This setting only affects the pipe interface. Full qualified URL or empty string on error.
pl_next(3) Navigate to the next item in the current playlist. URL of the item or an empty string at the end of the list.
pl_previous(3) Navigate to the previous item in the current playlist. URL of the item or an empty string at the end of the list.
pl_reset(3) Reset the current item of the playlist. The current location is now before the start or past the end respectively.  
use Use the current playlist. This is equivalent to 'load <filepath to current playlist>'.  
clear Clears the current playlist.  
add <file>|<url>[;...] Adds item(s) to the current playlist. The items are added before the current item. If the current item is past the end the new items are appended.
Multiple items must be separated with ';' characters. The names or urls can be enclosed with double quotes. The operation is atomic.
 
dir <directory>(2) Add <directory> to the playlist (non-recursive).  
rdir <directory>(2) Add <directory> to the playlist (recursive).  
remove Removes currently loaded file from the current playlist. Full qualified URL of the removed item or empty string on error.
save [<file>] Save the current playlist as <file>. If <file> is omitted the playlist is saved in place. This only works on mutable lists.  

Category Configuration

Comand Desription Reply
autouse [on|off|toggle](1) Toggles or (re)sets 'auto use playlist on add'.
Without an argument only the current setting is returned.
Previous setting or empty string on error.
playonload [on|off|toggle](1) Toggles or (re)sets 'auto play on load'.
Without an argument only the current setting is returned.
Previous setting or empty string on error.
playonuse [on|off|toggle](1) Toggles or (re)sets 'auto play on playlist use'.
Without an argument only the current setting is returned.
Previous setting or empty string on error.
float [on|off|toggle](1) Toggles or (re)sets 'float on top'.
Without an argument only the current setting is returned.
Previous setting or empty string on error.
font [1|2|<font>] Selects font 1 or font 2 or a non-skinned OS/2 font. <font> is in the PM syntax like '8.Helvetica'.
Without an argument only the current setting is returned.
Previous setting or empty string on error.
size [0|normal|regular | 1|small | 2|tiny] Selects the player size.
Without an argument only the current setting is returned.
Previous setting [0|1|2] or empty string on error.

Notes

  1. All boolean parameters may use 'on', '1', 'true' or 'yes' for the logical true value and 'off', '0', 'false' or 'no' for false.

  2. The behaviour of the directory commands has significantly changed with PM123 1.40. The content of the directories is no longer expanded inline into the playlist. A reference to the diretory is added to the playlist instead. This has several side effects. Unplayable items appear in the navigation. The directory is rescanned everytime the playlist is loaded.

  3. In PM123 before version 1.40 the playlist manipulation commands always operate on the currently playing item. Now the new commands pl_prev, pl_next and pl_reset are dedicated to playlist operations.