Skip to content

docs: use Windows-compatible frame example filenames - #114

Open
dajiaohuang wants to merge 1 commit into
damianociarla:mainfrom
dajiaohuang:docs/windows-frame-example-20261016
Open

dajiaohuang wants to merge 1 commit into
damianociarla:mainfrom
dajiaohuang:docs/windows-frame-example-20261016

Conversation

@dajiaohuang

Copy link
Copy Markdown

Summary

Use a literal preview prefix in the README and frame cookbook examples that specify size: '640x?'. Explain why %s is unsuitable for that inferred size on Windows.

%s substitutes the requested size expression verbatim. The existing examples therefore ask FFmpeg to create preview_640x?_1.jpg, which Windows cannot create. The documented frame extraction fails with FfmpegError code 115. Using preview produces preview_1.jpg without changing dimensions, sampling, or the filename-template API.

Validation

On Windows with Node 24.14.1 and FFmpeg/ffprobe 8.0:

  • Generated a small, silent blue 12-second local video (no external media).
  • Original README frame options fail attempting preview_640x?_1.jpg.
  • Corrected README and cookbook options each produce a valid 640×480 JPEG.
  • Also exercised metadata, conversion/resizing/tags, Promise and callable CommonJS/constructor/callback paths, isolated clients, lifecycle correlation, and process-error callbacks using synthetic local media.
  • Build, lint/typecheck, VitePress build, and formatting of both changed documents pass; git diff --check passes.

Existing platform/check limits: the unmodified unit suite has 56 failures on Windows (primarily direct execution of .mjs fake executables, plus POSIX path assumptions), with 197 passing and 3 skipped. Repository-wide formatting reports pre-existing CRLF issues; only the changed documents were normalized. pack:check passes its CommonJS smoke and dry-run steps but its package-types script fails at spawnSync npm.cmd EINVAL. Visual/browser checks were not run for this prose/example-only change.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant