From 7a2b3e3f930db0445a2b778576314fe525d97ff7 Mon Sep 17 00:00:00 2001 From: José Bollo Date: Tue, 31 May 2016 10:03:13 +0200 Subject: update html pages MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I69014a4fe61ddc290be7abcc09065db60f1a4c5e Signed-off-by: José Bollo --- doc/afb-plugins-overview.html | 34 +++++++++++++++++++++++++--------- 1 file 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 @@ +

Overview of plugins shipped with AFB-Daemon

Version: 1
-Date:    30 May 2016
+Date:    30 mai 2016
 Author:  Manuel Bachmann

List of plugins

Here are the plugins shipped in the source tree:

@@ -23,15 +25,18 @@ Author: Manuel Bachmann

Media (1 backend: Rygel UPnP)

All plugins may not be built, depending on the development libraries present on the system at build time.

Detail of plugins

Hello World

A sample Hello World plugin for demonstration and learning purposes.

This plugin provides a few unauthenticated requests, all beginning with "ping", to demonstrate basic binder capabilities.

This plugin provides a few unauthenticated requests, all beginning with “ping”, to demonstrate basic binder capabilities.

Verbs:

@@ -44,15 +49,17 @@ Author: Manuel Bachmann

pingevent: broadcasts a global event

Authentication

An sample Authentication plugin for demonstration purposes.

This plugin provides a few requests to demonstrate the binder's token-based security mechanism.

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.

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.

Verbs:

@@ -64,13 +71,15 @@ Author: Manuel Bachmann

logout: closes 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.

Verbs:

@@ -85,8 +94,10 @@ Author: Manuel Bachmann

wait: wait for a move

Audio

A sample Audio plugin with 2 backends:

@@ -96,27 +107,30 @@ Author: Manuel Bachmann

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.

+ +

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.

Verbs:

ping: returns a success response
init: initializes backend, on the "default" sound card
init: initializes backend, on the “default” sound card
volume: gets or sets volume, in % (0-100)
channels: gets or sets channels count (1-8)
mute: gets or sets the mute status (on-off)
play: gets or sets the playing status (on-off)

(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)

(a specifc backend can be forced by using this syntax before running afb-daemon : $ export AFB_AUDIO_OUTPUT=Alsa)

Media

A sample Media Server plugin with 1 backend:

@@ -125,6 +139,7 @@ Author: Manuel Bachmann

Rygel

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.

Verbs:

@@ -133,7 +148,7 @@ Author: Manuel Bachmann

ping: returns a success response

init: initializes backend, looking for an active local UPnP server

list: returns list of audio files, as a JSON structure

select: select an audio files, by index number (001-...)

select: select an audio files, by index number (001-…)

play: plays the currently selected audio file

stop: stops the currently selected audio file

pause: pauses the currently selected audio file

@@ -141,6 +156,7 @@ Author: Manuel Bachmann

upload: uploads an audio file, with a POST request

(if GUPnP/GSSDP development libraries are not fund at build time, this plugin will not be built)

-- cgit 1.2.3-korg