Skip to content

Commit eb0839b

Browse files
authored
Enhance fps correction documentation for clarity
Clarified the explanation of the fps correction process and how Cinemate suggests a correction factor based on frame count analysis.
1 parent 1724245 commit eb0839b

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/fps-correction.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,12 @@ To validate or tune the correction factor, you can record a clip with a fixed fr
1717
rec f 1000
1818
```
1919

20-
This records exactly 1000 frames (based on the current FPS) and stops automatically. It is ideal for calibration because Cinemate knows exactly how many frames *should* have landed over the elapsed duration.
20+
This records exactly 1000 frames (based on the current FPS) and stops automatically.
21+
Cinemate knows exactly how many frames *should* have landed over the elapsed duration and when recording stops it performs an analysis and proposes an fps correction factor
2122

2223
### How Cinemate analyzes the results
2324

24-
After the recording finishes, Cinemate compares the expected frame count with the actual frames captured. When there is a mismatch, it derives a suggested correction factor and stores it for you to review (for example by reading the `fps_correction_suggestion` Redis key or checking the logs). If the frames are already in sync, it keeps the existing correction factor. This makes it easy to iteratively tune the correction for a specific sensor mode and FPS without guesswork.
25+
After the recording finishes, Cinemate compares the expected frame count with the actual frames captured. When there is a mismatch, it derives a suggested correction factor and suggests it to the user. If the frame count lands on the expected number of frames (with the tolerance of +/- 1 frame), it suggests to keep the existing correction factor.
2526

2627
!!! note ""
27-
See [here](cli-commands.md) how to run Cinemate manually.
28+
See [here](cli-commands.md) how to run Cinemate manually.

0 commit comments

Comments
 (0)