--navigator-video-shows-captions

CLI: --navigator-video-shows-captions
REST: navigator_video_shows_captions

LicensePro

Tells the navigator that you asked for captions in the --navigator-captures-video recording. When the navigator judges that the reason for an action helps explain how it is reaching your goal, it writes a caption, which is drawn onto the video under the action as the page names it, such as Click “Sign in”, and held before the action runs. The caption is in the language of your goal, as is the action line in English, German, Spanish, French, Italian, Portuguese, Japanese, Korean, Chinese and Arabic; other languages get an English action line. Filled values stay out of both. Routine steps carry no caption and no hold.

Each caption is held for one second to notice it plus the time an adult takes to read it silently, from 2 to 15 seconds: English at 238 words a minute, with longer words and numbers taking longer, and Japanese, Chinese, Korean and Arabic at their own measured rates. A caption too long for its place scrolls through its hold.

Captions are drawn with the Noto fonts that ship with zshot, so they read the same on every host, in Latin, Cyrillic, Greek, Arabic, Japanese, Korean and Chinese scripts. --navigator-video-captions-position places them. A typesafe navigator writes no captions.

Example

Run locally

zshot -f pipeline.png \
  --navigator-type "anthropic://YOUR_API_KEY@" \
  --navigate "Open the pipeline" \
  --navigator-captures-video session.webm \
  --navigator-video-shows-captions \
  https://zshot-cli.com/example_assets/zrm/

{
  "url": "https://zshot-cli.com/example_assets/zrm/",
  "output_type": "png",
  "navigate": "Open the pipeline",
  "with_navigator_video": true,
  "navigator_video_shows_captions": true,
  "navigator_type": ["anthropic://YOUR_API_KEY@"]
}

curl -X POST http://127.0.0.1:3000/ \
  -H "Content-Type: application/json" \
  -d '{"url":"https://zshot-cli.com/example_assets/zrm/","output_type":"png","navigate":"Open the pipeline","with_navigator_video":true,"navigator_video_shows_captions":true,"navigator_type":["anthropic://YOUR_API_KEY@"]}' \
  -D - -o pipeline.png