[Slim-Checkins] r8854 - /trunk/server/HTML/EN/html/docs/cli-api.html
fred at svn.slimdevices.com
fred at svn.slimdevices.com
Mon Aug 7 17:42:16 PDT 2006
Author: fred
Date: Mon Aug 7 17:42:14 2006
New Revision: 8854
URL: http://svn.slimdevices.com?rev=8854&view=rev
Log:
Bug: N/A
Description: CLI docs precisions and improvements
Modified:
trunk/server/HTML/EN/html/docs/cli-api.html
Modified: trunk/server/HTML/EN/html/docs/cli-api.html
URL: http://svn.slimdevices.com/trunk/server/HTML/EN/html/docs/cli-api.html?rev=8854&r1=8853&r2=8854&view=diff
==============================================================================
--- trunk/server/HTML/EN/html/docs/cli-api.html (original)
+++ trunk/server/HTML/EN/html/docs/cli-api.html Mon Aug 7 17:42:14 2006
@@ -79,12 +79,12 @@
playlist information if appropriate.
</li>
<li>
- Command "<a href="#dc_mode">mode <play|pause|stop></a>"
+ Command "<a href="#mode">mode <play|pause|stop></a>"
is deprecated. Please use commands
"<a href="#play">play</a>",
"<a href="#stop">stop</a>" and
"<a href="#pause">pause</a>". The query
- "<a href="#mode">mode ?</a>" is not affected by this change.
+ "<a href="#mode ?">mode ?</a>" is not affected by this change.
</li>
<li>
Query "<a href="#playlisttracks">playlisttracks</a>" is
@@ -1005,10 +1005,31 @@
<li>
<strong><code><a href="#player model ?">player model ?</a></code></strong>
</li>
+ <li>
+ <strong><code><a href="#player displaytype ?">player displaytype ?</a></code></strong>
+ </li>
+ <li>
+ <strong><code><a href="#signalstrength ?">signalstrength ?</a></code></strong>
+ </li>
+ <li>
+ <strong><code><a href="#connected ?">connected ?</a></code></strong>
+ </li>
+ <li>
+ <strong><code><a href="#sleep">sleep</a></code></strong>
+ </li>
+ <li>
+ <strong><code><a href="#sync">sync</a></code></strong>
+ </li>
+ <li>
+ <strong><code><a href="#power">power</a></code></strong>
+ </li>
+ <li>
+ <strong><code><a href="#mixer volume">mixer volume</a></code></strong>
+ </li>
+ <li>
+ <strong><code><a href="#show">show</a></code></strong>
+ </li>
<!-- MISSING COMMANDS HERE ! -->
- <li>
- <strong><code><a href="#connected ?">connected ?</a></code></strong>
- </li>
</ul>
<p id="player count ?">
@@ -1144,47 +1165,156 @@
</p>
</blockquote>
-
-<br><p><strong><code>player displaytype <playerindex|playerid> ?</code></strong></p>
-<p>The "player displaytype" command returns the display model of the player. Graphical
-display types start with "graphic-", non-graphical display type with "noritake-".</p>
-<blockquote>
- <p> Request: "player displaytype 0 ?<LF>"<br>
- Response: "player displaytype 0 noritake-katakana<LF>"</p>
-</blockquote>
-
-<br><p><strong><code><playerid> sleep <number|?></code></strong></p>
-<p>The "sleep" command specifies a number of seconds to continue playing
- before powering off the player. You may query the amount of time until the player
- sleeps by passing in a "?" parameter.</p>
-<p>Examples: </p>
-<blockquote>
- <p>Request: "04:20:00:12:23:45 sleep ?<LF>"<br>Response: "04:20:00:12:23:45 sleep 105.3<LF>"</p>
- <p>Request: "04:20:00:12:23:45 sleep 300<LF>"<br>Response: "04:20:00:12:23:45 sleep 300<LF>"</p>
-</blockquote>
-
-<br><p id="sync">
- <strong>
- <code><playerid> sync <playerindex|playerid|-|?></code>
- </strong>
-</p>
-<p>The "sync" command specifies the player to synchronise with the
- given playerid. You may query which players are already synced with this
- player by passing in a "?" parameter. Multiple playerids are
- separated by a comma. If the player is not synced, "-" is returned.
- To unsync a player, use the "-" parameter.</p>
-<p>Examples: </p>
-<blockquote>
- <p>Request: "04:20:00:12:23:45 sync 1<LF>"
- <br>Response: "04:20:00:12:23:45 sync 1<LF>"</p>
- <p>Request: "04:20:00:12:23:45 sync ?<LF>"
- <br>Response: "04:20:00:12:23:45 sync 04:20:00:12:23:21<LF>"</p>
- <p>Request: "04:20:00:12:23:45 sync -<LF>"
- <br>Response: "04:20:00:12:23:45 sync -<LF>"</p>
-</blockquote>
-
-<br>
-<p>
+<br>
+<p id="player displaytype ?">
+ <strong>
+ <code>
+ player
+ displaytype
+ <playerindex|playerid>
+ ?
+ </code>
+ </strong>
+</p>
+<p>
+ The "player displaytype ?" query returns the display model of the
+ player. Graphical display types start with "graphic-",
+ non-graphical display type with "noritake-".
+</p>
+<p>
+ Example:
+</p>
+<blockquote>
+ <p>
+ Request: "player displaytype 0 ?<LF>"
+ <br>
+ Response: "player displaytype 0 noritake-katakana<LF>"
+ </p>
+</blockquote>
+
+<br>
+<p id="signalstrength ?">
+ <strong>
+ <code>
+ <playerid>
+ signalstrength
+ ?
+ </code>
+ </strong>
+</p>
+<p>
+ Returns the wireless signal strength for the player, range is 1 to 100.
+ Returns 0 if not connected wirelessly.
+</p>
+<p>
+ Example:
+</p>
+<blockquote>
+ <p>
+ Request: "04:20:00:12:23:45 signalstrength ?<LF>"
+ <br>
+ Response: "04:20:00:12:23:45 signalstrength 76<LF>"
+ </p>
+</blockquote>
+
+<br>
+<p id="connected ?">
+ <strong>
+ <code>
+ <playerid>
+ connected
+ ?
+ </code>
+ </strong>
+</p>
+<p>
+ Returns the connected state of the player, 1 or 0 depending on the state of
+ the TCP connection to the player. SLIMP3 players, since they use UDP,
+ always return 1.
+</p>
+<p>
+ Examples:
+</p>
+<blockquote>
+ <p>
+ Request: "04:20:00:12:23:45 connected ?<LF>"
+ <br>
+ Response: "04:20:00:12:23:45 connected 1<LF>"
+ </p>
+</blockquote>
+
+<br>
+<p id="sleep">
+ <strong>
+ <code>
+ <playerid>
+ sleep
+ <number|?>
+ </code>
+ </strong>
+</p>
+<p>
+ The "sleep" command specifies a number of seconds to continue
+ playing before powering off the player. You may query the amount of time
+ until the player sleeps by passing in "?".</p>
+<p>
+ Examples:
+</p>
+<blockquote>
+ <p>
+ Request: "04:20:00:12:23:45 sleep ?<LF>"
+ <br>
+ Response: "04:20:00:12:23:45 sleep 105.3<LF>"
+ </p>
+ <p>
+ Request: "04:20:00:12:23:45 sleep 300<LF>"
+ <br>
+ Response: "04:20:00:12:23:45 sleep 300<LF>"
+ </p>
+</blockquote>
+
+<br>
+<p id="sync">
+ <strong>
+ <code>
+ <playerid>
+ sync
+ <playerindex|playerid|-|?>
+ </code>
+ </strong>
+</p>
+<p>
+ The "sync" command specifies the player to synchronise with the
+ given playerid. The command accepts only one playerindex or playerid.
+ To unsync the player, use the "-" parameter.
+ <br>
+ You may query which players are already synced with this player by passing
+ in a "?" parameter. Multiple playerids are separated by a comma.
+ If the player is not synced, "-" is returned.
+</p>
+<p>
+ Examples:
+</p>
+<blockquote>
+ <p>
+ Request: "04:20:00:12:23:45 sync 1<LF>"
+ <br>
+ Response: "04:20:00:12:23:45 sync 1<LF>"
+ </p>
+ <p>
+ Request: "04:20:00:12:23:45 sync ?<LF>"
+ <br>
+ Response: "04:20:00:12:23:45 sync 04:20:00:12:23:21<LF>"
+ </p>
+ <p>
+ Request: "04:20:00:12:23:45 sync -<LF>"
+ <br>
+ Response: "04:20:00:12:23:45 sync -<LF>"
+ </p>
+</blockquote>
+
+<br>
+<p id="power">
<strong>
<code>
<playerid>
@@ -1197,6 +1327,7 @@
The "power" command turns the player on or off. Use 0 to turn off,
1 to turn on, ? to query and no parameter to toggle the power state of the
player.
+ <br>
For remote streaming connections, the command does nothing and the query
always returns 1.
</p>
@@ -1217,71 +1348,29 @@
</blockquote>
<br>
-<p>
+<p id="mixer volume">
<strong>
<code>
<playerid>
- signalstrength
- ?
- </code>
- </strong>
-</p>
-<p>
- Returns the wireless signal strength for the player, range is 1 to 100.
- Returns 0 if not connected wirelessly.
-</p>
-<p>
- Examples:
-</p>
-<blockquote>
- <p>
- Request: "04:20:00:12:23:45 signalstrength ?<LF>"
- <br>
- Response: "04:20:00:12:23:45 signalstrength 76<LF>"
- </p>
-</blockquote>
-
-<br>
-<p id="connected ?">
- <strong>
- <code>
- <playerid>
- connected
- ?
- </code>
- </strong>
-</p>
-<p>
- Returns the connected state of the player, 1 or 0 depending on the state of
- the TCP connection to the player. SLIMP3 players, since they use UDP,
- always return 1.
-</p>
-<p>
- Examples:
-</p>
-<blockquote>
- <p>
- Request: "04:20:00:12:23:45 connected ?<LF>"
- <br>
- Response: "04:20:00:12:23:45 connected 1<LF>"
- </p>
-</blockquote>
-
-<br>
- <p id="volume">
- <strong>
- <code><playerid> mixer volume <0 .. 100|-100 .. +100|?></code>
- </strong>
- </p>
-<p>The "mixer volume" command returns or sets the current volume
+ mixer
+ volume
+ <0 .. 100|-100 .. +100|?>
+ </code>
+ </strong>
+</p>
+<p>
+ The "mixer volume" command returns or sets the current volume
setting for the player. The scale is 0 to 100, in real numbers (i.e. 34.5
is valid). If the player is muted, the volume is returned as a negative
value. Note that players display a 0 to 40 scale, that is, the 0..100
volume divided by 2,5. Likewise, using the
- "<a href="#button">button</a>"command with "volume_up"
+ "<a href="#button">button</a>" command with "volume_up"
or "volume_down" parameters increases or decreases the volume by
- 2,5.</p>
-<p> Example: </p>
+ 2,5.
+</p>
+<p>
+ Examples:
+</p>
<blockquote>
<p>
Request: "04:20:00:12:23:45 mixer volume ?<LF>"
@@ -1304,7 +1393,7 @@
<strong><code><playerid> mixer muting <0|1|?|></code></strong></p>
<p>The "mixer muting" command mutes or unmutes the player. Use 0 to
unmute, 1 to mute, ? to query and no parameter to toggle the muting state
- of the player. Note also the "<a href="#volume">mixer volume</a>"
+ of the player. Note also the "<a href="#mixer volume">mixer volume</a>"
command returns a negative value if the player is muted.</p>
<p> Example: </p>
<blockquote>
@@ -1326,7 +1415,7 @@
The "mixer bass" command returns or sets the current bass setting
for the player. This is only supported by SliMP3 and SqueezeBox (SB1)
players. For more information on the 0 to 100 scale, please refer to
- the "<a href="#volume">mixer volume</a>" command.
+ the "<a href="#mixer volume">mixer volume</a>" command.
</p>
<p>
Example:
@@ -1355,7 +1444,7 @@
<p>The "mixer treble" command returns or sets the current treble
setting for the player. This is only supported by SliMP3 and SqueezeBox (SB1)
players. For more information on the 0 to 100 scale, please refer to
- the "<a href="#volume">mixer volume</a>" command. </p>
+ the "<a href="#mixer volume">mixer volume</a>" command. </p>
<p> Example: </p><p> Example: </p>
<blockquote>
<p>Request: "04:20:00:12:23:45 mixer treble ?<LF>"
@@ -4124,7 +4213,58 @@
<h2 id="PL">
Playlist commands and queries
</h2>
-
+<ul>
+ <li>
+ <strong><code><a href="#play">play</a></code></strong>
+ </li>
+ <li>
+ <strong><code><a href="#stop">stop</a></code></strong>
+ </li>
+ <li>
+ <strong><code><a href="#pause">pause</a></code></strong>
+ </li>
+ <li>
+ <strong><code><a href="#mode ?">mode ?</a></code></strong>
+ </li>
+ <li>
+ <strong><code><a href="#time">time</a></code></strong>
+ </li>
+ <li>
+ <strong><code><a href="#cursonginfo">genre ?</a></code></strong>
+ </li>
+ <li>
+ <strong><code><a href="#cursonginfo">artist ?</a></code></strong>
+ </li>
+ <li>
+ <strong><code><a href="#cursonginfo">album ?</a></code></strong>
+ </li>
+ <li>
+ <strong><code><a href="#cursonginfo">title ?</a></code></strong>
+ </li>
+ <li>
+ <strong><code><a href="#cursonginfo">duration ?</a></code></strong>
+ </li>
+ <li>
+ <strong><code><a href="#cursonginfo">remote ?</a></code></strong>
+ </li>
+ <li>
+ <strong><code><a href="#cursonginfo">current_title ?</a></code></strong>
+ </li>
+ <li>
+ <strong><code><a href="#cursonginfo">path ?</a></code></strong>
+ </li>
+ <li>
+ <strong><code><a href="#playlist play">playlist play</a></code></strong>
+ </li>
+ <li>
+ <strong><code><a href="#playlist add">playlist add</a></code></strong>
+ </li>
+ <li>
+ <strong><code><a href="#playlist insert">playlist insert</a></code></strong>
+ </li>
+</ul>
+
+<br>
<p id="play">
<strong>
<code>
@@ -4136,6 +4276,9 @@
<p>
The "play" command allows to start playing the current playlist.
</p>
+<p>
+ Example:
+</p>
<blockquote>
<p>
Request: "04:20:00:12:23:45 play<LF>"
@@ -4155,6 +4298,9 @@
</p>
<p>
The "stop" command allows to stop playing the current playlist.
+</p>
+<p>
+ Example:
</p>
<blockquote>
<p>
@@ -4175,6 +4321,9 @@
</strong>
</p>
<p>
+ Example:
+</p>
+<p>
You may use "pause 1" to force the player to pause,
"pause 0" to force the player to unpause and "pause" to
toggle the pause state.
@@ -4188,7 +4337,7 @@
</blockquote>
<br>
-<p id="mode">
+<p id="mode ?">
<strong>
<code>
<playerid>
@@ -4201,6 +4350,9 @@
The "mode" command allows to query the player state and returns
one of "play", "stop" or "pause". If the
player is off, "mode ?" returned value is undefined.
+</p>
+<p>
+ Example:
</p>
<blockquote>
<p>
@@ -4211,7 +4363,7 @@
</blockquote>
<br>
-<p>
+<p id="time">
<strong>
<code>
<playerid>
@@ -4355,7 +4507,7 @@
</p>
</blockquote>
-<br><p><strong><code><playerid> playlist add <item></code></strong></p>
+<br><p id="playlist add"><strong><code><playerid> playlist add <item></code></strong></p>
<p>The "playlist add" command adds the specified song URL, playlist or directory contents to the end of the current playlist.
Songs currently playing or already on the playlist are not affected.</p>
<p>Examples:</p>
@@ -4364,7 +4516,7 @@
<p>Request: "04:20:00:12:23:45 playlist add /playlists/abba.m3u<LF>"<br>Response: "04:20:00:12:23:45 playlist add /playlists/abba.m3u<LF>"</p>
</blockquote>
-<br><p><strong><code><playerid> playlist insert <item></code></strong></p>
+<br><p id="playlist insert"><strong><code><playerid> playlist insert <item></code></strong></p>
<p>The "playlist insert" command inserts the specified song URL, playlist or directory contents to be played immediately after the current song in the current playlist.
Any songs currently playing or already on the playlist are not affected.</p>
<p>Examples:</p>
More information about the checkins
mailing list