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:</p>
  17
  18 <ul>
  19 <li>Hello World</li>
  20 <li>Authentication</li>
  21 <li>Tic Tac Toe</li>
  22 <li>Audio <em>(2 backends: ALSA/PulseAudio)</em></li>
  23 <li>Media <em>(1 backend: Rygel UPnP)</em></li>
  24 </ul>
  25
  26 <p>All plugins may not be built, depending on the development libraries present on the system at build time.</p>
  27
  28 <h2>Detail of plugins</h2>
  29
  30 <h3>Hello World</h3>
  31
  32 <p>A sample Hello World plugin for demonstration and learning purposes.</p>
  33
  34 <p>This plugin provides a few unauthenticated requests, all beginning with "ping", to demonstrate basic binder capabilities.</p>
  35
  36 <p><strong>Verbs</strong>:</p>
  37
  38 <ul>
  39 <li><em>ping:</em> returns a success response</li>
  40 <li><em>pingfail:</em> returns a failure response</li>
  41 <li><em>pingnull:</em> returns a success response, with an empty JSON response field</li>
  42 <li><em>pingbug:</em> does a memory violation (intercepted by the binder)</li>
  43 <li><em>pingJson:</em> returns a success response, with a complex JSON response field</li>
  44 <li><em>pingevent:</em> broadcasts a global event</li>
  45 </ul>
  46
  47 <p><br /></p>
  48
  49 <h3>Authentication</h3>
  50
  51 <p>An sample Authentication plugin for demonstration purposes.</p>
  52
  53 <p>This plugin provides a few requests to demonstrate the binder's token-based security mechanism.</p>
  54
  55 <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>
  56
  57 <p><strong>Verbs</strong>:</p>
  58
  59 <ul>
  60 <li><em>ping:</em> returns a success response</li>
  61 <li><em>connect:</em> creates a session and returns a new token</li>
  62 <li><em>refresh:</em> returns a new token</li>
  63 <li><em>check:</em> verifies the passed token is valid</li>
  64 <li><em>logout:</em> closes the session</li>
  65 </ul>
  66
  67 <p><br /></p>
  68
  69 <h3>Tic Tac Toe</h3>
  70
  71 <p>A sample Tic Tac Toe game plugin.</p>
  72
  73 <p>This plugin provides an interactive Tic Tac Toe game where the binder returns the grid as a JSON response. </p>
  74
  75 <p><strong>Verbs</strong>:</p>
  76
  77 <ul>
  78 <li><em>new:</em> starts a new game</li>
  79 <li><em>play:</em> asks the server to play</li>
  80 <li><em>move:</em> gives a client move</li>
  81 <li><em>board:</em> gets the current board state, as a JSON structure</li>
  82 <li><em>level</em>: sets the server level</li>
  83 <li><em>join</em>: joins an existing board</li>
  84 <li><em>undo</em>: undo the last move</li>
  85 <li><em>wait</em>: wait for a move</li>
  86 </ul>
  87
  88 <p><br /></p>
  89
  90 <h3>Audio</h3>
  91
  92 <p>A sample Audio plugin with 2 backends:</p>
  93
  94 <ul>
  95 <li>ALSA (mandatory)</li>
  96 <li>PulseAudio (optional)</li>
  97 </ul>
  98
  99 <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>
 100
 101 <p><strong>Verbs</strong>:</p>
 102
 103 <ul>
 104 <li><em>ping:</em> returns a success response</li>
 105 <li><em>init:</em> initializes backend, on the "default" sound card</li>
 106 <li><em>volume:</em> gets or sets volume, in % (0-100)</li>
 107 <li><em>channels:</em> gets or sets channels count (1-8)</li>
 108 <li><em>mute:</em> gets or sets the mute status (on-off)</li>
 109 <li><em>play</em>: gets or sets the playing status (on-off)</li>
 110 </ul>
 111
 112 <p><em>(if PulseAudio development libraries are not found at build time, only ALSA will be available)</em></p>
 113
 114 <p><em>(if a PulseAudio server is not found at runtime, the plugin will dynamically fall back to ALSA)</em></p>
 115
 116 <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>
 117
 118 <p><br /></p>
 119
 120 <h3>Media</h3>
 121
 122 <p>A sample Media Server plugin with 1 backend:</p>
 123
 124 <ul>
 125 <li>Rygel</li>
 126 </ul>
 127
 128 <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>
 129
 130 <p><strong>Verbs</strong>:</p>
 131
 132 <ul>
 133 <li><em>ping:</em> returns a success response</li>
 134 <li><em>init:</em> initializes backend, looking for an active local UPnP server</li>
 135 <li><em>list:</em> returns list of audio files, as a JSON structure</li>
 136 <li><em>select:</em> select an audio files, by index number (001-...)</li>
 137 <li><em>play:</em> plays the currently selected audio file</li>
 138 <li><em>stop:</em> stops the currently selected audio file</li>
 139 <li><em>pause:</em> pauses the currently selected audio file</li>
 140 <li><em>seek:</em> seeks in the currently selected audio file, in seconds</li>
 141 <li><em>upload:</em> uploads an audio file, with a POST request</li>
 142 </ul>
 143
 144 <p><em>(if GUPnP/GSSDP development libraries are not fund at build time, this plugin will not be built)</em></p>
 145
 146 <p><br /></p>
 147
 148 <hr />
 149
 150 <p><br /></p>
 151
 152 <p>Sample command-line applications: <em>afb-client-demo</em> (built by default)</p>
 153
 154 <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>
 155
 156 <p>Sample Qt/QML applications: <em>test/token-websock.qml</em></p>
 157 </body>
 158 </html>