chiark - git - mdw - disorder/blob - disobedience/manual/window.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
   2 <!--
   3 This file is part of DisOrder.
   4 Copyright (C) 2009 Richard Kettlewell
   5
   6 This program is free software: you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation, either version 3 of the License, or
   9 (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 -->
  19 <html>
  20  <head>
  21    <title>Disobedience: Window Layout</title>
  22    <link rel=stylesheet
  23          type="text/css"
  24          href="disobedience.css">
  25  </head>
  26  <body>
  27    <h1>2. Window Layout</h1>
  28
  29    <p>This chapter contains a tour of the main Disobedience
  30    window.</p>
  31
  32    <h2><a name=main>2.1 The Disobedience Window</a></h2>
  33
  34    <p>Disobedience should look something like this when you've started
  35    it up and logged in:</p>
  36
  37    <p class=image><img src="queue.png"></p>
  38
  39    <p>At the top is the menu bar, and immediately below it a toolbar
  40    with some buttons and a volume control.  (In some cases the volume
  41    control may be absent.)  Below that is a row of
  42    tabs: <b>Queue</b>, <b>Recent</b> and so on.  The <b>Queue</b> tab
  43    is selected: this displays the currently playing track and the list
  44    of tracks that will play in the near future.</p>
  45
  46    <p>In this example nothing is actually playing.  (Apart from the
  47    fact that you wouldn't hear anything) you can tell this because the
  48    top row only has a single length indicator (&ldquo;3:04&rdquo;).
  49    If it was playing it would show how far through the track it was
  50    too.  Secondly, all the tracks were chosen at random.  You can tell
  51    this because the <b>Who</b> column is empty.
  52
  53    <p>In the screenshot below both of these things have changed.
  54    Use <tt>rjk</tt> has selected some tracks and the first of them is
  55    playing.</p>
  56
  57    <p class=image><img src="queue2.png"></p>
  58
  59    <p>The playing track is highlighted with a green backgroud.  It's 4
  60    minutes and 10 seconds long and so far, the first 21 seconds of it
  61    has played.</p>
  62
  63    <h2><a name=buttons>2.2 Buttons</a></h2>
  64
  65    <p>The meaning of the buttons is as follows:</p>
  66
  67    <table>
  68      <tr>
  69        <td><img src="button-pause.png"></td>
  70        <td>The pause button.  This only effective when a track is
  71        playing.  When it is pressed the playing track is paused.</td>
  72      </tr>
  73
  74      <tr>
  75        <td><img src="button-scratch.png"></td>
  76        <td>The scratch button.  As above this is only effective when
  77        a track is playing.  Pressing it will stop that track playing
  78        and move onto the next one.</td>
  79      </tr>
  80
  81      <tr>
  82          <td><img src="button-random.png"></td>
  83
  84          <td>The random play button.  Random play, which is enabled
  85          when the button is depressed, means that if
  86          nothing is playing the server will automatically pick a track
  87          at random and play that.  Furthermore it will ensure that the
  88          queue always has a minimum number of tracks, so you can see
  89          ahead of time what will play next.</td>
  90      </tr>
  91
  92      <tr>
  93          <td><img src="button-playing.png"></td>
  94          <td>The playing button.  Normally this would always be left
  95          enabled, i.e. with the button depressed.
  96          If it is disabled then nothing will be
  97          played at all, regardless of whether it was randomly chosen
  98          or picked by a human.</td>
  99      </tr>
 100
 101      <tr>
 102          <td><img src="button-rtp.png"></td>
 103          <td>The network play button.  This is only effective if the
 104          server is playing over the network (as opposed to using a
 105          local sound card).  When network play is enabled,
 106          Disobedience runs a client program on your computer to play
 107          sound received over the network using your sound card.</td>
 108      </tr>
 109    </table>
 110
 111    <p>To the right of the buttons are two sliders:</p>
 112
 113    <p class=image><img src="volume-slider.png"></p>
 114
 115    <p>The left hand slider is the volume control.  This ranges from 0
 116    (silent) to 10 (loudest).  The right hand slider is the balance
 117    control, which ranges form -1.0 (left) to +1.0 (right).</p>
 118
 119    <h2><a name=menu>2.3 The Menu Bar</a></h2>
 120
 121    <p class=image><img src="menu-server.png"></p>
 122
 123    <p>The <b>Server</b> menu is loosely analogous to the <b>File</b>
 124    menu in othe applications.  It has no file-related options though,
 125    so the name would not be appropriate!  Instead the three options it
 126    has are <b>Login</b>, which brings back the login window shown the
 127    first time it is run, <b>Manage Users</b> which allows
 128    adminstrators to do user management, and <b>Quit</b>.</p>
 129
 130    <!-- TODO link to user management -->
 131
 132    <p class=image><img src="menu-edit.png"></p>
 133
 134    <p>The <b>Edit</b> menu has options to select or deselect all
 135    tracks.  You can also do this with CTRL-A and CTRL-SHIFT-A, and of
 136    course you can select tracks in the queue (or other tabs) with the
 137    mouse.</p>
 138
 139    <p>The <b>Track Properties</b> option will create a window with
 140    editable <a href="properties.html">properties</a> of each selected
 141    track and the <b>Edit Playlists</b> option will create a window
 142    allowing editing of <a href="playlists.html">playlists</a>.</p>
 143
 144    <p class=image><img src="menu-control.png"></p>
 145
 146    <p>The <b>Control</b> menu options are mostly equivalent to the
 147    buttons described above.  The exceptions are:</p>
 148
 149    <ul>
 150      <li><b>Compact Mode</b> which switches Disobedience's window to a smaller format.</li>
 151      <li><b>Global Preferences</b> which allows global server settings to be modified.</li>
 152      <li><b>Activate Playlist</b> which allows you to play a <A href="playlists.html">playlist</a>.</li>
 153      <li><b>Network Playback API</b> which allows you to select the audio playback API used when playing over the network.</li>
 154    </ul>
 155
 156    <p class=image><img src="menu-help.png"></p>
 157
 158    <p>The <b>Help</b> menu has an option to bring up the Disobedience
 159    manual and an <b>About</b> option which will display a bit of
 160    version information for the server and for Disobedience (which
 161    might not be the same).</p>
 162
 163    <hr>
 164
 165    <a href="index.html">Back to contents</a>
 166
 167  </body>
 168 </html>