README

   1 jackwsmeter - jack meter over websockets
   2 ========================================
   3
   4 jackwsmeter get the signal values of the audio signals that flow through
   5 JACK ports and make the peak levels available over a websocket link,
   6 it's a clean and efficient way to get an overview of levels from a serie
   7 of jack servers.
   8
   9
  10 Installation
  11 ------------
  12
  13 JACK <http://jackaudio.org> and libwebsockets <http://libwebsockets.org>
  14 development files are required.
  15
  16 Building and installing is done via the autotools:
  17
  18   ./autogen.sh
  19   make
  20   make install
  21
  22
  23 Usage
  24 -----
  25
  26 Run the following command, then open your browser at http://localhost:7681.
  27
  28   jackwsmeter system:capture_1 system:capture_2
  29
  30 It's also possible to specify invalid ports, in that case the corresponding
  31 number of jack input ports will be created but unconnected; the following
  32 command creates four input ports:
  33
  34   jackwsmeter x x x x
  35
  36 (the limit is set at 20 input ports)
  37
  38
  39 Protocol
  40 --------
  41
  42 jackwsmeter comes with a minimalistic HTML page but can be used in much better
  43 integration when using its WebSocket interface.
  44
  45 The WebSocket protocol string is jack-wsmeter-protocol, it will periodically
  46 emit a message consisting of a string containing a space separated list of
  47 level values.
  48
  49   var ws = new WebSocket('ws://localhost:7681', 'jack-wsmeter-protocol');
  50   ws.onmessage = function(event) {
  51       var peaks = event.data.split(" ");
  52       console.log('got ', peaks.length, ' measures:', event.data);
  53   }
  54
  55
  56 Real world usage
  57 ----------------
  58
  59 jackwsmeter was developed to be used in Radio Panik, a free community radio in
  60 Brussels, Belgium. <http://www.radiopanik.org>
  61
  62
  63 Feedback
  64 --------
  65
  66 You can send bug reports or any kind of comment to the author.
  67
  68   mailto:Frederic Peters <fpeters@0d.be>