start_recording
Start capturing the full macOS desktop to an MP4 video file. Configure quality, frame rate, and audio, then get a session ID and output path to manage the recording.
Instructions
Start recording the full macOS desktop to a video file. Records all connected screens (by default the primary display) using FFmpeg avfoundation. Only one recording can be active at a time. Returns a session ID and output path. Requires Screen Recording permission granted to this terminal app in System Settings.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fps | No | Frames per second. Range 1–60. Default: 30. Use 15 for smaller files, 60 for smooth demos. | |
| preset | No | FFmpeg encoding speed preset. Faster = lower CPU but larger file. Default: ultrafast (minimal system impact during recording). | |
| quality | No | Video quality. low=small file, medium=balanced (default), high=crisp. Maps to H.264 CRF 35/28/18. | |
| audio_index | No | avfoundation audio device index. Use list_screen_devices to find audio device indices. Omit for no audio. Use -1 to explicitly disable audio. | |
| output_path | No | Output file path. Must end in .mp4. Relative paths resolve to ~/Movies/screen-recordings/. If omitted, auto-generates a timestamped filename. | |
| screen_index | No | avfoundation screen device index. Use list_screen_devices to find available indices. Defaults to primary display (usually index 1). |