Repository navigation
docs: use Windows-compatible frame example filenames - #114
Open
dajiaohuang wants to merge 1 commit into
Open
dajiaohuang wants to merge 1 commit into
dajiaohuang wants to merge 1 commit into
Conversation
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Use a literal
previewprefix in the README and frame cookbook examples that specifysize: '640x?'. Explain why%sis unsuitable for that inferred size on Windows.%ssubstitutes the requested size expression verbatim. The existing examples therefore ask FFmpeg to createpreview_640x?_1.jpg, which Windows cannot create. The documented frame extraction fails withFfmpegErrorcode 115. Usingpreviewproducespreview_1.jpgwithout changing dimensions, sampling, or the filename-template API.Validation
On Windows with Node 24.14.1 and FFmpeg/ffprobe 8.0:
preview_640x?_1.jpg.git diff --checkpasses.Existing platform/check limits: the unmodified unit suite has 56 failures on Windows (primarily direct execution of
.mjsfake 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:checkpasses its CommonJS smoke and dry-run steps but its package-types script fails atspawnSync npm.cmd EINVAL. Visual/browser checks were not run for this prose/example-only change.