aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/eye_tracking_context/advanced_topics/context_definition.md
diff options
context:
space:
mode:
authorThéo de la Hogue2024-07-18 01:50:40 +0200
committerThéo de la Hogue2024-07-18 01:50:40 +0200
commita8f92d1e670cfa3231e3d1315d6b6cb98ee4c2cc (patch)
treef8ab4ddcf5c5f18bff95e1daa13fd9b7b2e5fd6c /docs/user_guide/eye_tracking_context/advanced_topics/context_definition.md
parent640ef4b08a5fc1d1cbffc2ed1c3244549dfe364c (diff)
downloadargaze-a8f92d1e670cfa3231e3d1315d6b6cb98ee4c2cc.zip
argaze-a8f92d1e670cfa3231e3d1315d6b6cb98ee4c2cc.tar.gz
argaze-a8f92d1e670cfa3231e3d1315d6b6cb98ee4c2cc.tar.bz2
argaze-a8f92d1e670cfa3231e3d1315d6b6cb98ee4c2cc.tar.xz
Removing useless next and previous playback control.
Diffstat (limited to 'docs/user_guide/eye_tracking_context/advanced_topics/context_definition.md')
-rw-r--r--docs/user_guide/eye_tracking_context/advanced_topics/context_definition.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/docs/user_guide/eye_tracking_context/advanced_topics/context_definition.md b/docs/user_guide/eye_tracking_context/advanced_topics/context_definition.md
index 17dfea9..a543bc7 100644
--- a/docs/user_guide/eye_tracking_context/advanced_topics/context_definition.md
+++ b/docs/user_guide/eye_tracking_context/advanced_topics/context_definition.md
@@ -7,7 +7,7 @@ The [ArContext](../../../argaze.md/#argaze.ArFeatures.ArContext) class interface
Besides, there is also a [DataCaptureContext](../../../argaze.md/#argaze.ArFeatures.DataCaptureContext) class that inherits from [ArContext](../../../argaze.md/#argaze.ArFeatures.ArContext) and that defines an abstract *calibrate* method to write specific device calibration process.
-In the same way, there is a [DataPlaybackContext](../../../argaze.md/#argaze.ArFeatures.DataPlaybackContext) class that inherits from [ArContext](../../../argaze.md/#argaze.ArFeatures.ArContext) and that defines abstract *previous* and *next* playback methods to move into record's frames and also defines *duration* and *progression* properties to get information about a record length and playback advancement.
+In the same way, there is a [DataPlaybackContext](../../../argaze.md/#argaze.ArFeatures.DataPlaybackContext) class that inherits from [ArContext](../../../argaze.md/#argaze.ArFeatures.ArContext) and that defines *duration* and *progression* properties to get information about a record length and playback advancement.
Finally, a specific eye tracking context can be defined into a Python file by writing a class that inherits either from [ArContext](../../../argaze.md/#argaze.ArFeatures.ArContext), [DataCaptureContext](../../../argaze.md/#argaze.ArFeatures.DataCaptureContext) or [DataPlaybackContext](../../../argaze.md/#argaze.ArFeatures.DataPlaybackContext) class.
@@ -182,12 +182,14 @@ class DataPlaybackExample(ArFeatures.DataPlaybackContext):
# Stop playback threads
threading.Thread.join(self.__data_thread)
- def previous(self):
- """Go to previous camera image frame."""
+ @property
+ def duration(self) -> int|float:
+ """Get data duration."""
...
- def next(self):
- """Go to next camera image frame."""
+ @property
+ def progression(self) -> float:
+ """Get data playback progression between 0 and 1."""
...
```