wmix/README

   1                     _        _____  ___
   2 __      ___ __ ___ (_)_  __ |___ / / _ \    timecop@japan.co.jp
   3 \ \ /\ / / '_ ` _ \| \ \/ /   |_ \| | | |   skunk@mit.edu
   4  \ V  V /| | | | | | |>  <   ___) | |_| |
   5   \_/\_/ |_| |_| |_|_/_/\_\ |____(_)___/
   6 ______________________________________________________________________________
   7
   8 * This is a complete dockapp mixer utilizing the OSS mixer API
   9 * Has a nice On-Screen-Display to visualize current volume levels
  10 * Can adjust main volume, balance, recording status, and mute/unmute channels
  11 * Supports mousewheel to adjust the volume settings
  12 * Supports user specified signals to adjust the volume remotely
  13 * User configuration file can be used to set options
  14
  15 How to use it:
  16
  17 .---------------------------.
  18 | Message Area Message Area | <- (1)
  19 | [ Rec ]  [ ST ]  [ Mute ] | <- (2) (3) (4)
  20 | <- ->             xxx     | <- (5) (6) (7)
  21 | L        R        ___     |
  22 | |  |||   |       /the\    |
  23 | |--|||---|      |K NOB|   | <- (8) (9)
  24 |    ||| <- slider \___/    |
  25 `---------------------------'
  26
  27 1) Current channel name is displayed in this area. If scrolling messages are
  28    enabled in config, the text will scroll every 30 seconds or so, using long
  29    sound channel names. If scrolling is disabled, short 5-character channel
  30    names are used instead, and the message constantly stays on the screen. In
  31    scroll mode, clicking in this area will re-scroll current message.
  32
  33 2) Clicking REC will toggle record status for current channel, if the channel
  34    is capable of recording. Some sound cards will allow you to set multiple
  35    record sources. Some don't, so you can only have one selected at any time.
  36    If you click here and nothing happens, the channel is not record-capable.
  37
  38 3) ST indicator is lit if the current channel is stereo.
  39
  40 4) Clicking MUTE will mute the current channel. Old volume settings are
  41    remembered, so clicking it again will un-mute. Also see the knob section
  42    because there is more than one way to do it :)
  43
  44 5) Clicking <- will switch to previous channel
  45
  46 6) Clicking -> will switch to next channel
  47
  48 7) Numeric indicator of current volume from 0 to 100 percent. Doesn't change
  49    when the channel is muted, so you can still adjust the volume and then
  50    unmute.
  51
  52 8) If ST light is on (Stereo channel), you can move this slider left and
  53    right to set balance. Click on the slider, and drag the mouse left or
  54    right to adjust. Double-clicking on the slider will center the balance.
  55    If you are on a mono channel, the slider doesn't move or do anything.
  56
  57 9) Ah, yes, the knob. One of the biggest visual differences since version
  58    2.x of WMix is that the knob now rendered in real-time opposed to switching
  59    pixmaps with various knob angles. Bow down to Daniel Richard G. for coming
  60    up with this awesome routine. Also utilizes new "cursor-hiding-and-moving"
  61    code which first appeared in volume.app by the same guy. Now you don't
  62    have to scroll the mouse off your desk to adjust the volume. Anyway, simply
  63    click on the knob and drag the mouse up or down to adjust the volume.
  64    After you release the button, your mouse cursor is right back where you
  65    started. Very Nifty! You can also double-click on the knob to mute the
  66    current channel. Red LED will turn off... Channel is muted!
  67
  68 Most people have mice with wheels these days, to this support is enabled by
  69 default. Scrolling the mouse wheel up or down will adjust the volume by 3%
  70 up or down. Buttons and step size are configurable from the config file -
  71 see below.
  72
  73 You can also check out ~/.wmix.pid, and use SIGUSR1/2 to adjust the volume
  74 up or down by the configured step size.
  75
  76 The config file:
  77
  78 1 = yes, 0 = no
  79
  80 mousewheel=1                    # use mousewheel?
  81 scrolltext=1                    # scroll the system messages?
  82 osd=1                           # display OSD?
  83 osdcolor=green                  # color of the OSD (from rgb.txt)
  84 wheelbtn1=4                     # which mousewheel button is "up"
  85 wheelbtn2=5                     # which mousewheel button is "down"
  86 wheelstep=3                     # the step for mousewheel adjustment
  87
  88 Most defaults are good for normal use, and if there is no config file,
  89 the settings you see above are used. If you want to hack on a config file,
  90 copy sample.wmixrc to ~/.wmixrc and change it around. Comments are ignored,
  91 but don't put comments at the end of line like I did here.
  92
  93 timecop [timecop@japan.co.jp]