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  * Hello World
  18  * Authentication
  19  * Tic Tac Toe
  20  * Audio <em>(2 backends: ALSA/PulseAudio)</em>
  21  * Radio <em>(1 backend: RTLSDR RTL2832U)</em>
  22  * Media <em>(1 backend: Rygel UPnP)</em></p>
  23
  24 <p>All plugins may not be built, depending on the development libraries present on the system at build time.</p>
  25
  26 <h2>Detail of plugins</h2>
  27
  28 <p>### Hello World</p>
  29
  30 <p>A sample Hello World plugin for demonstration and learning purposes.</p>
  31
  32 <p>This plugin provides a few unauthenticated requests, all beginning with "ping" ("<em>pingSample</em>", "<em>pingJson</em>", "<em>pingFail</em>"...) to demonstrate basic binder capabilities.</p>
  33
  34 <p>### Authentication</p>
  35
  36 <p>An sample Authentication plugin for demonstration purposes.</p>
  37
  38 <p>This plugin provides a few requests to demonstrate the binder's token-based security mechanism.</p>
  39
  40 <p>Calling "<em>connect</em>" with a security token will initiate a session, calling "<em>refresh</em>" will issue a new token and invalidate the previous one, calling "<em>logout</em>" will invalidate all tokens and close the session.</p>
  41
  42 <p>### Tic Tac Toe</p>
  43
  44 <p>A sample Tic Tac Toe game plugin.</p>
  45
  46 <p>This plugin provides an interactive Tic Tac Toe game where the binder returns the grid as a JSON response. </p>
  47
  48 <p>### Audio</p>
  49
  50 <p>A sample Audio plugin with 2 backends:
  51  * ALSA (mandatory)
  52  * PulseAudio (optional)</p>
  53
  54 <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>
  55
  56 <p><em>(if PulseAudio development libraries are not found at build time, only ALSA will be available)</em></p>
  57
  58 <p><em>(if a PulseAudio server is not found at runtime, the plugin will dynamically fall back to ALSA)</em></p>
  59
  60 <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>
  61
  62 <p>### Radio</p>
  63
  64 <p>A sample AM/FM Radio plugin with 1 backend:
  65  * RTLSDR - Realtek RTL2832U dongles (mandatory)</p>
  66
  67 <p>This plugin is able to initialize specific RTL2832U dongles, switch between AM/FM modes, define frequency, mute sound, and play sound (if combining with the <strong>audio</strong> plugin).</p>
  68
  69 <p><em>(if rtlsdr development libraries are not found at build time, this plugin will not be built)</em></p>
  70
  71 <p>### Media</p>
  72
  73 <p>A sample Media Server plugin with 1 backend:
  74  * Rygel</p>
  75
  76 <p><em>(if GUPnP/GSSDP development libraries are not found at build time, this plugin will not be built)</em></p>
  77
  78 <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>
  79
  80 <hr />
  81
  82 <p><br /></p>
  83
  84 <p>Sample command-line applications: <em>afb-client-demo</em> (built by default)</p>
  85
  86 <p>Sample HTML5 applications: <strong>test/*.html</strong>, <strong><a href="https://github.com/iotbzh/afb-client">afb-client</a></strong>, <strong><a href="https://github.com/iotbzh/afb-radio">afb-radio</a></strong></p>
  87
  88 <p>Sample Qt/QML applications: <em>test/token-websock.qml</em></p>
  89 </body>
  90 </html>