Skip to content

Commit 768804c

Browse files
pariserjishi
pariser
authored and
jishi
committed
Improve docs page (#534)
1 parent 148bc51 commit 768804c

File tree

1 file changed

+63
-27
lines changed

1 file changed

+63
-27
lines changed

‎static/index.html‎

Lines changed: 63 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,14 @@
1111
.logo { display: block; margin: auto }
1212
.content { margin: 20px 25%; }
1313
.docs { background-color: #f4f4f4; border-radius: 4px; padding: 10px; margin-bottom: 20px;}
14-
.docs p { padding: 0; margin: 0; line-height: 28px; font-size: 14px; font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace; }
14+
.docs p, .docs li { padding: 0; margin: 0; line-height: 28px; font-size: 14px; font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace; }
1515
.docs .method { background-color: #dbdbdb; padding: 4px; border-radius: 2px; margin-right: 4px;}
1616
.docs h2 { margin-bottom: 8px;}
1717
.docs h2:first-child { margin-top: 0;}
18+
.docs h4 { margin-left: 10px; }
19+
.docs ul { list-style-type: none; padding-left: 20px; }
20+
.docs .explanation { margin-left: 20px; font-family: 'Helvetica Neue', Helvetica, 'Segoe UI', Arial, freesans, sans-serif; font-size: 14px; }
21+
.docs .experimental { background-color: red; border-radius: 3px; color: white; font-size: 10px; line-height: 12px; padding: 2px 6px; font-weight: bold; }
1822
.footer { text-align: center; font-size: 12px; margin: 10px 0 50px 0;}
1923
</style>
2024
</head>
@@ -34,8 +38,8 @@ <h2>Info</h2>
3438
<h2>Global Control</h2>
3539
<p><span class="method">GET</span> /lockvolumes</p>
3640
<p><span class="method">GET</span> /unlockvolumes</p>
37-
<p><span class="method">GET</span> /pauseall</p>
38-
<p><span class="method">GET</span> /resumeall</p>
41+
<p><span class="method">GET</span> /pauseall/{timeout in minutes (optional)}</p>
42+
<p><span class="method">GET</span> /resumeall/{timeout in minutes (optional)}</p>
3943
<p><span class="method">GET</span> /reindex</p>
4044
<p><span class="method">GET</span> /sleep/{timeout in seconds or timestamp HH:MM:SS or off}</p>
4145
<p><span class="method">GET</span> /preset/{JSON preset}</p>
@@ -47,31 +51,63 @@ <h2>Zone Control</h2>
4751
<p><span class="method">GET</span> /{zone name}/{action}[/{parameter}]</p>
4852

4953
<h3>Actions</h3>
54+
55+
<h4>Playback</h4>
56+
<ul>
57+
<li>play</li>
58+
<li>pause</li>
59+
<li>playpause <span class="explanation">toggles playing state</span></li>
60+
<li>trackseek/{seconds into song, i.e. 60 for 1:00, 120 for 2:00 etc.}</li>
61+
<li>next</li>
62+
<li>previous</li>
63+
</ul>
64+
65+
<h4>Volume</h4>
66+
<ul>
67+
<li>volume/{absolute volume}</li>
68+
<li>volume/{+ or -}{relative volume}</li>
69+
<li>groupVolume/{absolute volume}</li>
70+
<li>groupVolume/{+ or -}{relative volume}</li>
71+
<li>mute</li>
72+
<li>unmute</li>
73+
<li>groupMute</li>
74+
<li>groupUnmute</li>
75+
<li>togglemute</li>
76+
<li>lockvolumes</li>
77+
<li>unlockvolumes <span class="explanation"><span class="experimental">experimental</span> enforce the volume that was selected when locking!</span></li>
78+
</ul>
79+
80+
<h4>Playback Settings</h4>
81+
<ul>
82+
<li>favorite</li>
83+
<li>playlist</li>
84+
<li>repeat/{on | off}</li>
85+
<li>shuffle/{on | off}</li>
86+
<li>crossfade/{on | off}</li>
87+
</ul>
88+
89+
<h4>Queue</h4>
90+
<ul>
91+
<li>queue</li>
92+
<li>clearqueue</li>
93+
<li>seek/{queue index}</li>
94+
</ul>
95+
96+
<h4>Room Grouping</h4>
97+
<ul>
98+
<li>add/{other zone name}</li>
99+
<li>remove/{other zone name}</li>
100+
<li>isolate</li>
101+
</ul>
102+
103+
<h4>Other</h4>
104+
<ul>
105+
<li>say</li>
106+
</ul>
107+
108+
<h4>Internals</h4>
50109
<ul>
51-
<li><strong>play</strong></li>
52-
<li><strong>pause</strong></li>
53-
<li><strong>playpause</strong> (toggles playing state)</li>
54-
<li><strong>volume</strong> (parameter is absolute or relative volume. Prefix +/- indicates relative volume)</li>
55-
<li><strong>groupVolume</strong> (parameter is absolute or relative volume. Prefix +/- indicates relative volume)</li>
56-
<li><strong>mute</strong> / <strong>unmute</strong></li>
57-
<li><strong>groupMute</strong> / <strong>groupUnmute</strong></li>
58-
<li><strong>togglemute</strong> (toggles mute state)</li>
59-
<li><strong>seek</strong> (parameter is queue index)</li>
60-
<li><strong>trackseek</strong> (parameter is in seconds, 60 for 1:00, 120 for 2:00 etc)</li>
61-
<li><strong>next</strong></li>
62-
<li><strong>previous</strong></li>
63-
<li><strong>state</strong> (will return a json-representation of the current state of player)</li>
64-
<li><strong>favorite</strong></li>
65-
<li><strong>playlist</strong></li>
66-
<li><strong>lockvolumes</strong> / <strong>unlockvolumes</strong> (experimental, will enforce the volume that was selected when locking!)</li>
67-
<li><strong>repeat</strong> (on/off)</li>
68-
<li><strong>shuffle</strong> (on/off)</li>
69-
<li><strong>crossfade</strong> (on/off)</li>
70-
<li><strong>pauseall</strong> (with optional timeout in minutes)</li>
71-
<li><strong>resumeall</strong> (will resume the ones that was pause on the pauseall call. Useful for doorbell, phone calls, etc. Optional timeout)</li>
72-
<li><strong>say</strong></li>
73-
<li><strong>queue</strong></li>
74-
<li><strong>clearqueue</strong></li>
110+
<li>state <span class="explanation">returns a json-representation of the current state of player</span></li>
75111
</ul>
76112
</div>
77113

0 commit comments

Comments
 (0)