UsbSound

UsbSound 1.0 10/17/2015 Copyright 2015 by xenic

NAME:
  UsbSound - Add audio notification for insertion/removal of USB devices

SHELL FORMAT:
  UsbSound [INS|INSERTSOUND] <file> [REM|REMOVESOUND <file>]
           [HOT|HOTKEY <text>] [VOL|VOLUME <n>] [NOREM] [NOINS]
           [LOG] [QUIT]

SHELL TEMPLATE:
  INS=INSERTSOUND,REM=REMOVESOUND/K,VOL=VOLUME/N/K,
      NOREM/S,NOINS/S,LOG/S,QUIT/S

WORBENCH TOOLTYPES:
  INSERTSOUND=<filename>, REMOVESOUND=<filename>, VOLUME=<number>,
  HOTKEY=<text>, NOREM=<TRUE|FALSE>, NOINS=<TRUE|FALSE>, LOG=<TRUE|FALSE>

FUNCTION:
  UsbSound is a commodity that performs audio notification when a USB
  device is inserted into or removed from a USB port. There is a default
  internal notification sound which can be replaced using icon tooltypes
  or shell command line options. UsbSound uses datatypes for sound play.

  When UsbSound is executed in a shell it is synchronous and will not
  return to the command line until:
    1. The user enters Ctrl-C in the shell where UsbSound  was executed.
    2. UsbSound is removed using the "Exchange" commodity.
    3. The user enters "UsbSound quit" in another shell.
	4. The user enters the keyboard shortcut to open a quit requester and
        selects the "Remove" button.

  When UsbSound is executed by Workbench (usually WBStartup), actions 2
  through 4 listed above will remove and quit the UsbSound commodity.
  The QUIT switch is only available as a command line argument.

OPTIONS:
  INSERTSOUND - Name of a sound file (complete path) to be played when a
                USB device is inserted or removed.

  REMOVESOUND - Name of a sound file (complete path) to be played when a
                USB device is removed.

  VOLUME - A number that sets the volume of USB notification sounds. Valid
           values are between 1 and 64. Defaults to 64.

  HOTKEY - Sets a keyboard shortcut to open a quit (Remove) requester.
           Default hotkey is "ctrl alt z".

  NOINS - Switch that prevents audio notification when a USB device is
          inserted. Default is FALSE.

  NOREM - Switch that prevents audio notification when a USB device is
          removed. Default is FALSE.

  LOG - Switch that enables logging of events and errors to "T:usbsound.log".
        Default is FALSE.

  QUIT - Command line switch that cancels all currently activated USB audio
         notification and quits a currently running UsbSound commodity.

NOTES:
  If you want to run UsbSound from your user-startup you must run it in the
  background using: "run <NIL: >NIL: *>NIL: UsbSound" or "wbrun UsbSound".
  The recommended method for running UsbSound is WBStartup.


THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES SUCH AS
LOSS OF USE OR DATA.

THIS IS FREE SOFTWARE; USE IT AT YOUR OWN RISK.