summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMatthias Vogelgesang <matthias.vogelgesang@kit.edu>2015-03-31 12:02:11 +0200
committerMatthias Vogelgesang <matthias.vogelgesang@kit.edu>2015-03-31 12:02:11 +0200
commit1217923dbc0b907410642f611fdb5b13236cf850 (patch)
tree351ed1f7305b77a479e87c6f214416a81937aaea /docs
parent67f433437efdfd7fa7a087603f38663574ea9146 (diff)
downloadlibuca-1217923dbc0b907410642f611fdb5b13236cf850.tar.gz
libuca-1217923dbc0b907410642f611fdb5b13236cf850.tar.bz2
libuca-1217923dbc0b907410642f611fdb5b13236cf850.tar.xz
libuca-1217923dbc0b907410642f611fdb5b13236cf850.zip
Switch to trigger source/type semantics
This change makes the naming more consistent but will break client and plugin code. The main idea is to specify a trigger source (AUTO being a virtual source) which denotes how causes a trigger and a trigger type which denotes when triggering happens (edge or level).
Diffstat (limited to 'docs')
-rw-r--r--docs/api.rst15
1 files changed, 9 insertions, 6 deletions
diff --git a/docs/api.rst b/docs/api.rst
index 8d55b6a..cf0dd4b 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -58,21 +58,21 @@ automatically.
Triggering
----------
-``libuca`` supports three trigger modes through the "trigger-mode"
+``libuca`` supports three trigger sources through the "trigger-source"
property:
-1. ``UCA_CAMERA_TRIGGER_AUTO``: Exposure is triggered by the camera
+1. ``UCA_CAMERA_TRIGGER_SOURCE_AUTO``: Exposure is triggered by the camera
itself.
-2. ``UCA_CAMERA_TRIGGER_SOFTWARE``: Exposure is triggered via software.
-3. ``UCA_CAMERA_TRIGGER_EXTERNAL``: Exposure is triggered by an external
+2. ``UCA_CAMERA_TRIGGER_SOURCE_SOFTWARE``: Exposure is triggered via software.
+3. ``UCA_CAMERA_TRIGGER_SOURCE_EXTERNAL``: Exposure is triggered by an external
hardware mechanism.
-With ``UCA_CAMERA_TRIGGER_SOFTWARE`` you have to trigger with
+With ``UCA_CAMERA_TRIGGER_SOURCE_SOFTWARE`` you have to trigger with
``uca_camera_trigger``::
/* thread A */
g_object_set (G_OBJECT (camera),
- "trigger-mode", UCA_CAMERA_TRIGGER_SOFTWARE,
+ "trigger-source", UCA_CAMERA_TRIGGER_SOURCE_SOFTWARE,
NULL);
uca_camera_start_recording (camera, NULL);
@@ -82,6 +82,9 @@ With ``UCA_CAMERA_TRIGGER_SOFTWARE`` you have to trigger with
/* thread B */
uca_camera_trigger (camera, NULL);
+Moreover, the "trigger-type" property specifies if the exposure should be
+triggered at the rising edge or during the level signal.
+
Grabbing frames asynchronously
------------------------------