diff options
| author |   José Bollo <jose.bollo@iot.bzh> | 2016-05-31 10:03:13 +0200 |
|---|---|---|
| committer |   Stephane Desneux <stephane.desneux@iot.bzh> | 2016-06-02 19:37:04 +0200 |
| commit | 7a2b3e3f930db0445a2b778576314fe525d97ff7 (patch) | |
| tree | 530cd41b1acedb215de51a8451f6b5412b442ae0 | |
| parent | 8a5e5c8e036b9166c6419d4b3243a34b4a1af336 (diff) | |
update html pages
Change-Id: I69014a4fe61ddc290be7abcc09065db60f1a4c5e
Signed-off-by: José Bollo <jose.bollo@iot.bzh>
| -rw-r--r-- | doc/afb-plugins-overview.html | 34 |
1 files changed, 25 insertions, 9 deletions
diff --git a/doc/afb-plugins-overview.html b/doc/afb-plugins-overview.html index 4370dc29..216a80ac 100644 --- a/doc/afb-plugins-overview.html +++ b/doc/afb-plugins-overview.html @@ -4,13 +4,15 @@ <meta charset="UTF-8"> </head> <body> +<a name="Overview.of.plugins.shipped.with.AFB-Daemon"></a> <h1>Overview of plugins shipped with AFB-Daemon</h1> <pre><code>Version: 1 -Date: 30 May 2016 +Date: 30 mai 2016 Author: Manuel Bachmann </code></pre> +<a name="List.of.plugins"></a> <h2>List of plugins</h2> <p>Here are the plugins shipped in the source tree:</p> @@ -23,15 +25,18 @@ Author: Manuel Bachmann <li>Media <em>(1 backend: Rygel UPnP)</em></li> </ul> + <p>All plugins may not be built, depending on the development libraries present on the system at build time.</p> +<a name="Detail.of.plugins"></a> <h2>Detail of plugins</h2> +<a name="Hello.World"></a> <h3>Hello World</h3> <p>A sample Hello World plugin for demonstration and learning purposes.</p> -<p>This plugin provides a few unauthenticated requests, all beginning with "ping", to demonstrate basic binder capabilities.</p> +<p>This plugin provides a few unauthenticated requests, all beginning with “ping”, to demonstrate basic binder capabilities.</p> <p><strong>Verbs</strong>:</p> @@ -44,15 +49,17 @@ Author: Manuel Bachmann <li><em>pingevent:</em> broadcasts a global event</li> </ul> + <p><br /></p> +<a name="Authentication"></a> <h3>Authentication</h3> <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>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>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><strong>Verbs</strong>:</p> @@ -64,13 +71,15 @@ Author: Manuel Bachmann <li><em>logout:</em> closes the session</li> </ul> + <p><br /></p> +<a name="Tic.Tac.Toe"></a> <h3>Tic Tac Toe</h3> <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>This plugin provides an interactive Tic Tac Toe game where the binder returns the grid as a JSON response.</p> <p><strong>Verbs</strong>:</p> @@ -85,8 +94,10 @@ Author: Manuel Bachmann <li><em>wait</em>: wait for a move</li> </ul> + <p><br /></p> +<a name="Audio"></a> <h3>Audio</h3> <p>A sample Audio plugin with 2 backends:</p> @@ -96,27 +107,30 @@ Author: Manuel Bachmann <li>PulseAudio (optional)</li> </ul> -<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>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><strong>Verbs</strong>:</p> <ul> <li><em>ping:</em> returns a success response</li> -<li><em>init:</em> initializes backend, on the "default" sound card</li> +<li><em>init:</em> initializes backend, on the “default” sound card</li> <li><em>volume:</em> gets or sets volume, in % (0-100)</li> <li><em>channels:</em> gets or sets channels count (1-8)</li> <li><em>mute:</em> gets or sets the mute status (on-off)</li> <li><em>play</em>: gets or sets the playing status (on-off)</li> </ul> + <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><em>(a specifc backend can be forced by using this syntax before running afb-daemon : <strong>$ export AFB_AUDIO_OUTPUT=Alsa</strong>)</em></p> <p><br /></p> +<a name="Media"></a> <h3>Media</h3> <p>A sample Media Server plugin with 1 backend:</p> @@ -125,6 +139,7 @@ Author: Manuel Bachmann <li>Rygel</li> </ul> + <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> <p><strong>Verbs</strong>:</p> @@ -133,7 +148,7 @@ Author: Manuel Bachmann <li><em>ping:</em> returns a success response</li> <li><em>init:</em> initializes backend, looking for an active local UPnP server</li> <li><em>list:</em> returns list of audio files, as a JSON structure</li> -<li><em>select:</em> select an audio files, by index number (001-...)</li> +<li><em>select:</em> select an audio files, by index number (001-…)</li> <li><em>play:</em> plays the currently selected audio file</li> <li><em>stop:</em> stops the currently selected audio file</li> <li><em>pause:</em> pauses the currently selected audio file</li> @@ -141,6 +156,7 @@ Author: Manuel Bachmann <li><em>upload:</em> uploads an audio file, with a POST request</li> </ul> + <p><em>(if GUPnP/GSSDP development libraries are not fund at build time, this plugin will not be built)</em></p> <p><br /></p> |