diff options
Diffstat (limited to 'doc/afb-bindings-overview.md')
| -rw-r--r-- | doc/afb-bindings-overview.md | 45 |
1 files changed, 30 insertions, 15 deletions
diff --git a/doc/afb-bindings-overview.md b/doc/afb-bindings-overview.md index 1d3632ee..c79e17f4 100644 --- a/doc/afb-bindings-overview.md +++ b/doc/afb-bindings-overview.md @@ -14,7 +14,8 @@ Here are the bindings shipped in the source tree: * Radio _(1 backend: RTLSDR RTL2832U)_ * Media _(1 backend: Rygel UPnP)_ -All bindings may not be built, depending on the development libraries present on the system at build time. +All bindings may not be built, depending on the development libraries present on +the system at build time. Detail of bindings @@ -24,7 +25,8 @@ Detail of bindings A sample Hello World binding for demonstration and learning purposes. -This binding provides a few unauthenticated requests, all beginning with "ping", to demonstrate basic binder capabilities. +This binding provides a few unauthenticated requests, all beginning with +"ping", to demonstrate basic binder capabilities. **Verbs**: @@ -40,11 +42,14 @@ This binding provides a few unauthenticated requests, all beginning with "ping", ### Authentication -An sample Authentication binding for demonstration purposes. +A sample Authentication binding for demonstration purposes. -This binding provides a few requests to demonstrate the binder's token-based security mechanism. +This binding 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**: @@ -61,7 +66,8 @@ Calling "_connect_" with a security token will initiate a session, calling "_ref A sample Tic Tac Toe game binding. -This binding provides an interactive Tic Tac Toe game where the binder returns the grid as a JSON response. +This binding provides an interactive Tic Tac Toe game where the binder returns +the grid as a JSON response. **Verbs**: @@ -84,7 +90,8 @@ A sample Audio binding with 2 backends: * ALSA (mandatory) * PulseAudio (optional) -This binding is able to initialize a specific soundcard, define volume levels, channels (mono/stereo...), mute sound, and play a 22,050 Hz PCM stream. +This binding is able to initialize a specific soundcard, define volume levels, +channels (mono/stereo...), mute sound, and play a 22,050 Hz PCM stream. **Verbs**: @@ -95,11 +102,14 @@ This binding is able to initialize a specific soundcard, define volume levels, c * _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 PulseAudio development libraries are not found at build time, only ALSA +will be available)_ -_(if a PulseAudio server is not found at runtime, the binding will dynamically fall back to ALSA)_ +_(if a PulseAudio server is not found at runtime, the binding will dynamically +fall back to ALSA)_ -_(a specifc backend can be forced by using this syntax before running afb-daemon : **$ export AFB_AUDIO_OUTPUT=Alsa**)_ +_(a specifc backend can be forced by using this syntax before running afb-daemon +: **$ export AFB_AUDIO_OUTPUT=Alsa**)_ <br /> @@ -110,7 +120,9 @@ A sample AM/FM Radio binding with 1 backend: * RTLSDR - Realtek RTL2832U dongles (mandatory) -This binding is able to initialize specific RTL2832U dongles, switch between AM/FM modes, define frequency, mute sound, and play sound (if combining with the **audio** binding). +This binding is able to initialize specific RTL2832U dongles, switch between +AM/FM modes, define frequency, mute sound, and play sound (if combining with +the **audio** binding). **Verbs**: @@ -122,18 +134,20 @@ This binding is able to initialize specific RTL2832U dongles, switch between AM/ * _mute_: sets device mute status (on-off) * _play_: sets device playing status (on-off) -_(if rtlsdr development libraries are not found at build time, this binding will not be built)_ +_(if rtlsdr development libraries are not found at build time, this binding will +not be built)_ <br /> - ### Media A sample Media Server binding with 1 backend: * Rygel -This binding 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. +This binding 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**: @@ -147,7 +161,8 @@ This binding is able to detect a local Rygel UPnP media server, list audio files * _seek:_ seeks in the currently selected audio file, in seconds * _upload:_ uploads an audio file, with a POST request -_(if GUPnP/GSSDP development libraries are not fund at build time, this binding will not be built)_ +_(if GUPnP/GSSDP development libraries are not found at build time, this binding +will not be built)_ <br /> |