From 2b75355f9846e3eff7432962f1b367db43af9164 Mon Sep 17 00:00:00 2001 From: Hayodea Hakol Date: Tue, 7 Jan 2025 12:15:52 -0400 Subject: [PATCH] docs:devspec: Update grammar notes --- docs/deviceSpec.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/deviceSpec.md b/docs/deviceSpec.md index 2e51e9c..6e7400c 100644 --- a/docs/deviceSpec.md +++ b/docs/deviceSpec.md @@ -35,6 +35,15 @@ sensor-type|implexor|api(api-params)|server(server-params)|deviceselector * `device selector` is the idiosyncratic label/name used by the `server` to identify the specific device you want to access via that `server`. +## `API-params` and `Server-params` : + +If there's more than one parameter item in a list of `api-params` or +`server-params`, then the individual items in a list of `api-param` or +`server-params` should be separated by the h-bar character (`|`). E.g: +``` +e|audio-implexor|alsa(shmem|param2|param3)|alsa()|cardname +``` + Some examples follow: ### To attach a particular window from a window manager: @@ -71,6 +80,10 @@ gfx framebuffer data. In most cases, this is basically the same as attempting to attach all of the WM's output. +* Implementation note: + https://stackoverflow.com/questions/33845447/how-do-i-talk-to-an-x-server-in-c-without-a-graphics-library + Seems relevant. + ### To attach all of an Xorg server's gfx output to a particular screen: ``` e|visual-implexor|x11()|xorg(listen-socket)|:0 @@ -80,6 +93,10 @@ api. Ask that Xorg server to let Harikoff read out all of the frames written out to display `:0`. Use harikoff's `visual-implexor` to implex from display `:0`'s framebuffer data. +* Implementation note: + https://stackoverflow.com/questions/33845447/how-do-i-talk-to-an-x-server-in-c-without-a-graphics-library + Seems relevant. + ### To attach a camera device by connecting directly to its Linux driver: ``` e|visual-implexor|v4l()|linux()|/dev/video0