1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
<html>
<head>
<link rel="stylesheet" type="text/css" href="doc.css">
<meta charset="UTF-8">
</head>
<body>
<h1>Overview of plugins shipped with AFB-Daemon</h1>
<pre><code>Version: 1
Date: 30 May 2016
Author: Manuel Bachmann
</code></pre>
<h2>List of plugins</h2>
<p>Here are the plugins shipped in the source tree:
* Hello World
* Authentication
* Tic Tac Toe
* Audio <em>(2 backends: ALSA/PulseAudio)</em>
* Radio <em>(1 backend: RTLSDR RTL2832U)</em>
* Media <em>(1 backend: Rygel UPnP)</em></p>
<p>All plugins may not be built, depending on the development libraries present on the system at build time.</p>
<h2>Detail of plugins</h2>
<p>### Hello World</p>
<p>A sample Hello World plugin for demonstration and learning purposes.</p>
<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>
<p>### Authentication</p>
<p>An sample Authentication plugin for demonstration purposes.</p>
<p>This plugin provides a few requests to demonstrate the binder's token-based security mechanism.</p>
<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>
<p>### Tic Tac Toe</p>
<p>A sample Tic Tac Toe game plugin.</p>
<p>This plugin provides an interactive Tic Tac Toe game where the binder returns the grid as a JSON response. </p>
<p>### Audio</p>
<p>A sample Audio plugin with 2 backends:
* ALSA (mandatory)
* PulseAudio (optional)</p>
<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>
<p><em>(if PulseAudio development libraries are not found at build time, only ALSA will be available)</em></p>
<p><em>(if a PulseAudio server is not found at runtime, the plugin will dynamically fall back to ALSA)</em></p>
<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>
<p>### Radio</p>
<p>A sample AM/FM Radio plugin with 1 backend:
* RTLSDR - Realtek RTL2832U dongles (mandatory)</p>
<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>
<p><em>(if rtlsdr development libraries are not found at build time, this plugin will not be built)</em></p>
<p>### Media</p>
<p>A sample Media Server plugin with 1 backend:
* Rygel</p>
<p><em>(if GUPnP/GSSDP development libraries are not found at build time, this plugin will not be built)</em></p>
<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>
<hr />
<p><br /></p>
<p>Sample command-line applications: <em>afb-client-demo</em> (built by default)</p>
<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>
<p>Sample Qt/QML applications: <em>test/token-websock.qml</em></p>
</body>
</html>
|
