Keystroke Overlay

keystroke_overlay

Burn keycast-style badges for shortcuts, clicks, and typing from the recording's input event log (start_recording events: true). Never shows typed text: the log has none.

producewritesdestructivesince v0.45.0

00:00PARAMETERS

Name	Type	Description
`input` required	`string`	Path to the recording.
`events`	`string`	Event log (default: the input's .events.jsonl).
`clicks`	`boolean`	Show clicks (default true).
`typing`	`boolean`	Show typing as "Typing…" (default true).
`keys`	`"shortcuts" \| "masked"`	shortcuts (default): the chord (Ctrl + S); masked: modifiers only (Ctrl + …).
`lingerSec`	`number`	Seconds a badge stays up (default 1.2). > 0, ≤ 10
`position`	`"bottom" \| "bottom-left" \| "bottom-right" \| "top" \| "top-left" \| "top-right"`	Default bottom (centred).
`size`	`number`	Font px (default 4.5% of the frame height). ≥ 8, ≤ 400
`color`	`string`	Text color (default white).
`fontFile`	`string`	Font: a .ttf/.otf/.ttc path or a C:\Windows\Fonts file name. Default: bundled Inter, with a covering system font for scripts it lacks (CJK, emoji, Arabic, ...).
`dryRun`	`boolean`	Return the planned badges; write nothing.
`output`	`string`	Optional output path. Defaults under SCREENCAST_HOME/edits.
`overwrite`	`boolean`	Allow replacing an existing file at the output path (default false).

00:05A MINIMAL CALL

keystroke_overlay { "input": "recording.mp4" }

The required arguments only, with placeholder values. Everything else takes its default.

00:10WHAT COMES BACK

Structured content (structuredContent), alongside a text summary:

Field	Type	Description
`badges` always	`integer`	≥ -9007199254740991, ≤ 9007199254740991