Skip to content

Improve /docs page #534

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 22, 2017
Merged

Improve /docs page #534

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 63 additions & 27 deletions static/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,14 @@
.logo { display: block; margin: auto }
.content { margin: 20px 25%; }
.docs { background-color: #f4f4f4; border-radius: 4px; padding: 10px; margin-bottom: 20px;}
.docs p { padding: 0; margin: 0; line-height: 28px; font-size: 14px; font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace; }
.docs p, .docs li { padding: 0; margin: 0; line-height: 28px; font-size: 14px; font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace; }
.docs .method { background-color: #dbdbdb; padding: 4px; border-radius: 2px; margin-right: 4px;}
.docs h2 { margin-bottom: 8px;}
.docs h2:first-child { margin-top: 0;}
.docs h4 { margin-left: 10px; }
.docs ul { list-style-type: none; padding-left: 20px; }
.docs .explanation { margin-left: 20px; font-family: 'Helvetica Neue', Helvetica, 'Segoe UI', Arial, freesans, sans-serif; font-size: 14px; }
.docs .experimental { background-color: red; border-radius: 3px; color: white; font-size: 10px; line-height: 12px; padding: 2px 6px; font-weight: bold; }
.footer { text-align: center; font-size: 12px; margin: 10px 0 50px 0;}
</style>
</head>
Expand All @@ -34,8 +38,8 @@ <h2>Info</h2>
<h2>Global Control</h2>
<p><span class="method">GET</span> /lockvolumes</p>
<p><span class="method">GET</span> /unlockvolumes</p>
<p><span class="method">GET</span> /pauseall</p>
<p><span class="method">GET</span> /resumeall</p>
<p><span class="method">GET</span> /pauseall/{timeout in minutes (optional)}</p>
<p><span class="method">GET</span> /resumeall/{timeout in minutes (optional)}</p>
<p><span class="method">GET</span> /reindex</p>
<p><span class="method">GET</span> /sleep/{timeout in seconds or timestamp HH:MM:SS or off}</p>
<p><span class="method">GET</span> /preset/{JSON preset}</p>
Expand All @@ -47,31 +51,63 @@ <h2>Zone Control</h2>
<p><span class="method">GET</span> /{zone name}/{action}[/{parameter}]</p>

<h3>Actions</h3>

<h4>Playback</h4>
<ul>
<li>play</li>
<li>pause</li>
<li>playpause <span class="explanation">toggles playing state</span></li>
<li>trackseek/{seconds into song, i.e. 60 for 1:00, 120 for 2:00 etc.}</li>
<li>next</li>
<li>previous</li>
</ul>

<h4>Volume</h4>
<ul>
<li>volume/{absolute volume}</li>
<li>volume/{+ or -}{relative volume}</li>
<li>groupVolume/{absolute volume}</li>
<li>groupVolume/{+ or -}{relative volume}</li>
<li>mute</li>
<li>unmute</li>
<li>groupMute</li>
<li>groupUnmute</li>
<li>togglemute</li>
<li>lockvolumes</li>
<li>unlockvolumes <span class="explanation"><span class="experimental">experimental</span> enforce the volume that was selected when locking!</span></li>
</ul>

<h4>Playback Settings</h4>
<ul>
<li>favorite</li>
<li>playlist</li>
<li>repeat/{on | off}</li>
<li>shuffle/{on | off}</li>
<li>crossfade/{on | off}</li>
</ul>

<h4>Queue</h4>
<ul>
<li>queue</li>
<li>clearqueue</li>
<li>seek/{queue index}</li>
</ul>

<h4>Room Grouping</h4>
<ul>
<li>add/{other zone name}</li>
<li>remove/{other zone name}</li>
<li>isolate</li>
</ul>

<h4>Other</h4>
<ul>
<li>say</li>
</ul>

<h4>Internals</h4>
<ul>
<li><strong>play</strong></li>
<li><strong>pause</strong></li>
<li><strong>playpause</strong> (toggles playing state)</li>
<li><strong>volume</strong> (parameter is absolute or relative volume. Prefix +/- indicates relative volume)</li>
<li><strong>groupVolume</strong> (parameter is absolute or relative volume. Prefix +/- indicates relative volume)</li>
<li><strong>mute</strong> / <strong>unmute</strong></li>
<li><strong>groupMute</strong> / <strong>groupUnmute</strong></li>
<li><strong>togglemute</strong> (toggles mute state)</li>
<li><strong>seek</strong> (parameter is queue index)</li>
<li><strong>trackseek</strong> (parameter is in seconds, 60 for 1:00, 120 for 2:00 etc)</li>
<li><strong>next</strong></li>
<li><strong>previous</strong></li>
<li><strong>state</strong> (will return a json-representation of the current state of player)</li>
<li><strong>favorite</strong></li>
<li><strong>playlist</strong></li>
<li><strong>lockvolumes</strong> / <strong>unlockvolumes</strong> (experimental, will enforce the volume that was selected when locking!)</li>
<li><strong>repeat</strong> (on/off)</li>
<li><strong>shuffle</strong> (on/off)</li>
<li><strong>crossfade</strong> (on/off)</li>
<li><strong>pauseall</strong> (with optional timeout in minutes)</li>
<li><strong>resumeall</strong> (will resume the ones that was pause on the pauseall call. Useful for doorbell, phone calls, etc. Optional timeout)</li>
<li><strong>say</strong></li>
<li><strong>queue</strong></li>
<li><strong>clearqueue</strong></li>
<li>state <span class="explanation">returns a json-representation of the current state of player</span></li>
</ul>
</div>

Expand Down