fix(producer): accept plain integer fps in createRenderJob#1034
Merged
Conversation
The rational `Fps = { num, den }` refactor in 5dcc89c broke callers
passing `fps: 30` (the form documented in every code example and used
by external consumers). FFmpeg received `undefined/undefined` as the
framerate, causing a cryptic exit-code error.
Add `FpsInput = number | Fps` and `toFps()` normalizer in
@hyperframes/core. `createRenderJob` now accepts both forms —
plain integers are promoted to `{ num, den: 1 }` at the boundary;
`RenderConfig.fps` stays strict `Fps` internally so no downstream
code changes.
Also fixes the producer and engine docs, which showed phantom
`input`/`output` fields on `createRenderJob` and a wrong
`executeRenderJob(job)` signature (missing `projectDir`/`outputPath`
args).
Closes #1031
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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
1 participant
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
FpsInput = number | Fpstype andtoFps()normalizer to@hyperframes/corecreateRenderJobnow accepts bothfps: 30andfps: { num: 30, den: 1 }— plain integers are promoted to{ num, den: 1 }at the boundary;RenderConfig.fpsstays strictFpsinternallyinput/outputfields, fixedexecuteRenderJobsignature (was missingprojectDir/outputPathargs), updated format list{ num, den }form the engine APIs requireContext
The rational
Fpsrefactor in 5dcc89c changedRenderConfig.fpsfromnumberto{ num, den }but never updated the docs or added input coercion. External callers (like #1031) passingfps: 30gotundefined/undefinedas the FFmpeg framerate — a cryptic error.Test plan
bun run build— all packages passbun run --filter @hyperframes/core test— 984 tests passbun run --filter @hyperframes/engine test— 612 tests passcreateRenderJob({ fps: 30 })normalizes to{ num: 30, den: 1 }at runtimecreateRenderJob({ fps: { num: 30000, den: 1001 } })passes through unchangedCloses #1031