docs: document ffmpeg multi-file output and input sources#17
Merged
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
The job.completed and job.failed webhook payloads now carry the same
output and error contract as GET /jobs/:id. Replace the old
result.url / metadata / price / priceFormatted fields with the unified
output ({ data, file, files, expiresAt }) and cost
({ amount, currency, formatted }), and point to the canonical
concepts/job-output reference. job.failed now documents the full error
shape (code, message, detail, retryable).
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.
Documents the new input/output model for Rendobar's FFmpeg API across both ffmpeg doc pages.
Inputs
The
inputsmap is the command's working directory. Each value can be:{ "url": "..." }{ "content": "..." }for inline text up to 64 KB (subtitles, concat lists, LUTs){ "ref": "uploads/..." }for an already-uploaded fileDocuments that aux files read by a filter (
subtitles=,lut3d=,drawtext fontfile=, concat lists) must come throughinputsrather than-i. Added a subtitle-burn example using{ "content": ... }.Outputs
The filenames the command writes define the output.
-f segment) return anoutputobject withtype,url,playlist,baseUrl,expiresAt,fileCount,files[], andmanifestUrl. URLs expire and refresh by re-fetching the job. Added an HLS example response.Failures
A failed job now exposes
errorDetail: the last ~2 KB of the real FFmpeg stderr.Pages changed
guides/ffmpeg.mdx(how-to) — Input sources section, subtitle-burn example, Output files section with HLS example, errorDetail in error handlingjob-types/ffmpeg.mdx(reference) —inputsparam with source shapes,output/errorDetailresponse fieldsValidation
node scripts/validate-frontmatter.mjspasses (frontmatter untouched). Contract verified against the monorepo source of truth (packages/shared/src/jobs/definitions/shared.tsinput schema,packages/shared/src/api/responses.tsjob response schema).