docs: add screen recording pipeline guide and integration tests#16
Merged
Conversation
Documents the FFmpeg screen capture → CutAgent post-processing workflow with cross-platform recording commands, a Python API example, and an EDL template. Adds a module-scoped integration test that validates the full pipeline (probe → detect_silence → trim → normalize) against a synthetic 1280×720 recording. Co-authored-by: Cursor <cursoragent@cursor.com>
The _ffmpeg_has_drawtext() helper in test_cli.py only checked the system ffmpeg and CUTAGENT_FFMPEG_DIR, skipping 5 tests when the Homebrew build lacked libfreetype. Replaced it with the same _find_drawtext_ffmpeg() pattern used in test_text_ops.py and test_animation.py, which also probes static-ffmpeg. Added an autouse fixture to propagate CUTAGENT_FFMPEG to CLI subprocesses. Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a Screen Recording Pipeline section to the README documenting how to capture the screen with FFmpeg and hand the result to CutAgent for post-production. Includes an integration test module that validates the full pipeline against a synthetic recording.
Why
CutAgent is often used by AI agents that want to record and auto-edit screen sessions. Until now there was no guidance on how to wire the capture step to CutAgent's editing API. This closes the documentation gap and gives agents a tested reference workflow.
How
README.md — new
## Screen Recording Pipelinesection inserted between the EDL Format and Architecture sections. Covers:avfoundation, Linuxx11grab, Windowsgdigrab)detect_silence+execute_edlto auto-detect and remove dead airtests/test_screen_recording_pipeline.py — new integration test module with a module-scoped
screen_recordingfixture (synthetic 1280×720 video with 2s intro silence → 6s content → 2s outro silence). Tests:probereturns expected 1280×720 metadatadetect_silencefinds the intro and outro segmentstrimto the content window produces a shorter clipnormalize_audiostandalone produces a valid outputChecklist
pytest— 236 passed, 28 skipped)Made with Cursor