From f6a2679cc5572f9bf6c65091d275a4118dde16e6 Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Fri, 19 Jul 2024 11:15:54 +0200
Subject: Documenting OpenCV camera context.

---
 .../eye_tracking_context/context_modules/opencv.md     | 18 +++++++++++++++++-
 docs/user_guide/utils/demonstrations_scripts.md        | 10 ++++++----
 src/argaze/utils/demo/opencv_camera_context.json       |  2 +-
 src/argaze/utils/demo/opencv_movie_context.json        |  2 +-
 4 files changed, 25 insertions(+), 7 deletions(-)

diff --git a/docs/user_guide/eye_tracking_context/context_modules/opencv.md b/docs/user_guide/eye_tracking_context/context_modules/opencv.md
index 7244cd4..7d73a03 100644
--- a/docs/user_guide/eye_tracking_context/context_modules/opencv.md
+++ b/docs/user_guide/eye_tracking_context/context_modules/opencv.md
@@ -39,9 +39,25 @@ Read more about [ArContext base class in code reference](../../../argaze.md/#arg
 ```json
 {
     "argaze.utils.contexts.OpenCV.Movie": {
-        "name": "Open CV cursor",
+        "name": "Open CV movie",
         "path": "./src/argaze/utils/demo/tobii_record/segments/1/fullstream.mp4",
         "pipeline": ...
     }
 }
 ```
+
+## Camera
+
+::: argaze.utils.contexts.OpenCV.Camera
+
+### JSON sample
+
+```json
+{
+    "argaze.utils.contexts.OpenCV.Camera": {
+        "name": "Open CV camera",
+        "identifier": 0,
+        "pipeline": ...
+    }
+}
+```
\ No newline at end of file
diff --git a/docs/user_guide/utils/demonstrations_scripts.md b/docs/user_guide/utils/demonstrations_scripts.md
index 1d136f2..59df85b 100644
--- a/docs/user_guide/utils/demonstrations_scripts.md
+++ b/docs/user_guide/utils/demonstrations_scripts.md
@@ -20,7 +20,9 @@ Load **random_context.json** file to generate random gaze positions:
 python -m argaze load ./src/argaze/utils/demo/random_context.json
 ```
 
-## OpenCV cursor context
+## OpenCV
+
+### Cursor context
 
 Load **opencv_cursor_context.json** file to capture cursor pointer positions over OpenCV window:
 
@@ -28,15 +30,15 @@ Load **opencv_cursor_context.json** file to capture cursor pointer positions ove
 python -m argaze load ./src/argaze/utils/demo/opencv_cursor_context.json
 ```
 
-## OpenCV movie context
+### Movie context
 
-Load **opencv_movie_context.json** file to playback movie pictures and also capture cursor pointer positions over OpenCV window:
+Load **opencv_movie_context.json** file to playback a movie and also capture cursor pointer positions over OpenCV window:
 
 ```shell
 python -m argaze load ./src/argaze/utils/demo/opencv_movie_context.json
 ```
 
-## OpenCV camera context
+### Camera context
 
 Edit **aruco_markers_pipeline.json** file as to adapt the *size* to the camera resolution and to reduce the value of the *sides_mask*.
 
diff --git a/src/argaze/utils/demo/opencv_camera_context.json b/src/argaze/utils/demo/opencv_camera_context.json
index 85884f2..b280c73 100644
--- a/src/argaze/utils/demo/opencv_camera_context.json
+++ b/src/argaze/utils/demo/opencv_camera_context.json
@@ -1,6 +1,6 @@
 {
     "argaze.utils.contexts.OpenCV.Camera" : {
-        "name": "OpenCV Window",
+        "name": "OpenCV camera",
         "identifier": 0,
         "pipeline": "aruco_markers_pipeline.json"
     }
diff --git a/src/argaze/utils/demo/opencv_movie_context.json b/src/argaze/utils/demo/opencv_movie_context.json
index 4f3a9f9..930a0fc 100644
--- a/src/argaze/utils/demo/opencv_movie_context.json
+++ b/src/argaze/utils/demo/opencv_movie_context.json
@@ -1,6 +1,6 @@
 {
     "argaze.utils.contexts.OpenCV.Movie" : {
-        "name": "OpenCV Movie",
+        "name": "OpenCV movie",
         "path": "./src/argaze/utils/demo/tobii_record/segments/1/fullstream.mp4",
         "pipeline": "aruco_markers_pipeline.json"
     }
-- 
cgit v1.1