X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=doc%2Fafb-plugins-overview.html;fp=doc%2Fafb-plugins-overview.html;h=f67826b98dd439d545f93ba118b19851d5aad247;hb=89db34aa9ee65a42ce242e95f342a7323c1e0e1b;hp=e156bd3ccc44d8515961f3bd4209f14b7a09d284;hpb=37c131d4c124632d32f24dc6bfb2f6926a204341;p=src%2Fapp-framework-binder.git diff --git a/doc/afb-plugins-overview.html b/doc/afb-plugins-overview.html index e156bd3c..f67826b9 100644 --- a/doc/afb-plugins-overview.html +++ b/doc/afb-plugins-overview.html @@ -14,6 +14,9 @@ Author: Manuel Bachmann
Here are the plugins shipped in the source tree: + * Hello World + * Authentication + * Tic Tac Toe * Audio (2 backends: ALSA/PulseAudio) * Radio (1 backend: RTLSDR RTL2832U) * Media (1 backend: Rygel UPnP)
@@ -22,42 +25,66 @@ Author: Manuel Bachmann### Hello World
+ +A sample Hello World plugin for demonstration and learning purposes.
+ +This plugin provides a few unauthenticated requests, all beginning with "ping" ("pingSample", "pingJson", "pingFail"...) to demonstrate basic binder capabilities.
+ +### Authentication
+ +An sample Authentication plugin for demonstration purposes.
+ +This plugin provides a few requests to demonstrate the binder's token-based security mechanism.
+ +Calling "connect" with a security token will initiate a session, calling "refresh" will issue a new token and invalidate the previous one, calling "logout" will invalidate all tokens and close the session.
+ +### Tic Tac Toe
+ +A sample Tic Tac Toe game plugin.
+ +This plugin provides an interactive Tic Tac Toe game where the binder returns the grid as a JSON response.
+### Audio
A sample Audio plugin with 2 backends: * ALSA (mandatory) * PulseAudio (optional)
+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.
+(if PulseAudio development libraries are not found at build time, only ALSA will be available)
(if a PulseAudio server is not found at runtime, the plugin will dynamically fall back to ALSA)
(a specifc backend can be forced by using this syntax before running afb-daemon : $ export AFBAUDIOOUTPUT=Alsa)
-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.
- -Sample applications: afb-radio
-### Radio
A sample AM/FM Radio plugin with 1 backend: * RTLSDR - Realtek RTL2832U dongles (mandatory)
-(if rtlsdr development libraries are not found at build time, this plugin will not be built)
- -This plugin is able to initialize specific RTL2832U dongles, switch between AM/FM modes, define frequency, mute sound, and play sound (by using the audio plugin).
+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 audio plugin).
-Sample applications: afb-radio
+(if rtlsdr development libraries are not found at build time, this plugin will not be built)
### Media
A sample Media Server plugin with 1 backend: * Rygel
-(if GUPnP/GSSDP development libraries are not fund at build time, this plugin will not be built)
+(if GUPnP/GSSDP development libraries are not found at build time, this plugin will not be built)
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.
-Sample applications: afb-radio
+Sample command-line applications: afb-client-demo (built by default)
+ +Sample HTML5 applications: test/*.html, afb-client, afb-radio
+ +Sample Qt/QML applications: test/token-websock.qml