diff --git a/docs/docs/configuration/index.md b/docs/docs/configuration/index.md index cc16e9067..b0433241d 100644 --- a/docs/docs/configuration/index.md +++ b/docs/docs/configuration/index.md @@ -225,11 +225,19 @@ detect: # Optional: Object specific values objects: person: 1000 - # Optional: Milliseconds to offset detect annotations by. + # Optional: Milliseconds to offset detect annotations by (default: shown below). # There can often be latency between a recording and the detect process, # especially when using separate streams for detect and record. # Use this setting to make the timeline bounding boxes more closely align - # with the recording. + # with the recording. The value can be positive or negative. + # TIP: Imagine there is an event clip with a person walking from left to right. + # If the event timeline bounding box is consistently to the left of the person + # then the value should be increased. Similarly, if a person is walking from + # left to right and the bounding box is consistently ahead of the person + # then the value should be decreased. + # TIP: This offset is dynamic so you can change the value and it will update existing + # events, this makes it easy to tune. + # WARNING: Fast moving objects will likely not have the bounding box align. annotation_offset: 0 # Optional: Object configuration