--navigator-video-captions-position

CLI: --navigator-video-captions-position
REST: navigator_video_captions_position

ValuePOSITION

Defaultbottom

LicensePro

Places the captions of --navigator-video-shows-captions.

Position	Where
`top`, `bottom`, `center`	A band across the frame at that place, up to 900 CSS px wide and 30% of the frame tall
`rect(TOP RIGHT BOTTOM LEFT)`	The region whose edges lie that far from the frame’s top and left edges, as CSS’s `rect()`
`inset(TOP RIGHT BOTTOM LEFT)`	The region that far in from each of the frame’s sides, as CSS’s `inset()`, with its one to four value shorthand

Each edge is a percentage of the frame, a length in CSS px such as 16px, or auto for the frame’s own edge. A caption sits at the top of its region and grows to fit its text, shrinking its text to fit, then scrolling.

rect(20% auto 50% auto) spans the frame’s width from 20% to 50% of its height. inset(16px 16px 70% 16px) keeps to the top 30% of the frame, 16 px from its sides.

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 \
  --navigator-video-captions-position "rect(20% auto 50% auto)" \
  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_video_captions_position": "rect(20% auto 50% auto)",
  "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_video_captions_position":"rect(20% auto 50% auto)","navigator_type":["anthropic://YOUR_API_KEY@"]}' \
  -D - -o pipeline.png