doc/afb-plugins-overview.html

   1 <html>
   2 <head>
   3   <link rel="stylesheet" type="text/css" href="doc.css">
   4   <meta charset="UTF-8">
   5 </head>
   6 <body>
   7 <h1>Overview of plugins shipped with AFB-Daemon</h1>
   8
   9 <pre><code>Version: 1
  10 Date:    30 May 2016
  11 Author:  Manuel Bachmann
  12 </code></pre>
  13
  14 <h2>List of plugins</h2>
  15
  16 <p>Here are the plugins shipped in the source tree:
  17  * Audio <em>(2 backends: ALSA/PulseAudio)</em>
  18  * Radio <em>(1 backend: RTLSDR RTL2832U)</em>
  19  * Media <em>(1 backend: Rygel UPnP)</em></p>
  20
  21 <p>All plugins may not be built, depending on the development libraries present on the system at build time.</p>
  22
  23 <h2>Detail of plugins</h2>
  24
  25 <p>### Audio</p>
  26
  27 <p>A sample Audio plugin with 2 backends:
  28  * ALSA (mandatory)
  29  * PulseAudio (optional)</p>
  30
  31 <p><em>(if PulseAudio development libraries are not found at build time, only ALSA will be available)</em></p>
  32
  33 <p><em>(if a PulseAudio server is not found at runtime, the plugin will dynamically fall back to ALSA)</em></p>
  34
  35 <p><em>(a specifc backend can be forced by using this syntax before running afb-daemon : <strong>$ export AFB</em>AUDIO<em>OUTPUT=Alsa</strong>)</em></p>
  36
  37 <p>This plugin is able to initialize a specific soundcard, define volume levels, channels (mono/stereo...), mute sound, and play a 22,050 Hz PCM stream.</p>
  38
  39 <p>Sample applications: <strong><a href="https://github.com/iotbzh/afb-radio">afb-radio</a></strong></p>
  40
  41 <p>### Radio</p>
  42
  43 <p>A sample AM/FM Radio plugin with 1 backend:
  44  * RTLSDR - Realtek RTL2832U dongles (mandatory)</p>
  45
  46 <p><em>(if rtlsdr development libraries are not found at build time, this plugin will not be built)</em></p>
  47
  48 <p>This plugin is able to initialize specific RTL2832U dongles, switch between AM/FM modes, define frequency, mute sound, and play sound (by using the <strong>audio</strong> plugin).</p>
  49
  50 <p>Sample applications: <strong><a href="https://github.com/iotbzh/afb-radio">afb-radio</a></strong></p>
  51
  52 <p>### Media</p>
  53
  54 <p>A sample Media Server plugin with 1 backend:
  55  * Rygel</p>
  56
  57 <p><em>(if GUPnP/GSSDP development libraries are not fund at build time, this plugin will not be built)</em></p>
  58
  59 <p>This plugin is able to detect a local Rygel UPnP media server, list audio files, select an audio file for playback, play/pause/seek in this file, upload an audio file to the server.</p>
  60
  61 <p>Sample applications: <strong><a href="https://github.com/iotbzh/afb-radio">afb-radio</a></strong></p>
  62 </body>
  63 </html>