You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 22da764
Browse filesBrowse the repository at this point in the historyBrowse files
Named data-safe-frames windows crop the encoded master via --crop-pack.
Studio overlays and the player safe-frame attribute preview those windows.
No Co-authored-by: trailers.
Copy file name to clipboardExpand all lines: docs/guides/4k-rendering.mdx
+7Lines changed: 7 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,6 +52,13 @@ For a fully sharp 4K result, use 4K source media and size canvas/WebGL buffers f
52
52
53
53
HyperFrames checks these conditions before opening the browser. Render at the composition's native size and resize separately when a combination is unsupported.
54
54
55
+
`--crop-pack` is a different path. It does not reshape the capture viewport and
56
+
it is not `--resolution`. The master is captured at the authored size (or the
57
+
`--resolution` supersample, if you asked for one), then ffmpeg crops sibling
58
+
files from that encoded master. A 9:16 crop of a 1920×1080 composition is still
59
+
a crop of 1080p pixels, not a portrait capture and not a 4K re-render. See
Copy file name to clipboardExpand all lines: docs/reference/html-schema.mdx
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -81,6 +81,7 @@ timeline registry key.
81
81
|`data-width` and `data-height`| Yes | Authored frame dimensions in pixels |
82
82
|`data-duration`| Usually | Total render duration in seconds |
83
83
|`data-no-timeline`| Only for a timeline-free composition | Tells the runtime not to wait for a timeline |
84
+
|`data-safe-frames`| No | JSON array of named crop windows on this root. Each object is `{ id, ratio, x, y, width, height }`. `id` is `[a-z][a-z0-9-]{0,31}` and unique. `ratio` is `16:9`, `9:16`, or `1:1`. Fractions are of the authored frame, origin top-left, each in `[0, 1]`, with `x + width ≤ 1` and `y + height ≤ 1`. Pixel size must match the named ratio within one pixel after snap. Used by `--crop-pack`, Studio overlays, the player `safe-frame` attribute, and `data-safe-critical` checks. Cropping the encoded master does not reflow layout. |
84
85
85
86
An explicit root `data-duration` is the render length. The compiler reads it
86
87
before composition scripts run, so a script or variable override cannot change
@@ -99,6 +100,7 @@ unbounded animation, and timeline-free compositions need an explicit duration.
99
100
|`data-duration`| Yes for DOM, image, and nested-composition clips | Visible slot length in seconds |
100
101
|`data-track-index`| No | Studio timeline lane, display only. The render never reads it and it does not prevent overlap |
101
102
|`class="clip"`| Recommended for authored timed DOM and image elements | Layout and tooling convention. Visibility is keyed off `data-start`, but the shared `.clip` rule supplies the full-frame box |
103
+
|`data-safe-critical`| No | Boolean, or a comma-separated list of `data-safe-frames` ids. The element's border box must stay inside every required crop window while it is visible. Static lint checks unknown ids; `hyperframes check` samples overflow (`safe_critical_overflow`). Cropping is not reflow — keep critical copy inside the windows you intend to deliver. |
102
104
103
105
`data-track-index` does not control paint order. Use CSS `z-index` for
104
106
front-to-back layering. Two clips on the same track may overlap in time; the
Copy file name to clipboardExpand all lines: docs/schema/hyperframes.json
+15Lines changed: 15 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -57,6 +57,21 @@
57
57
"pattern": "^[a-z0-9][a-z0-9-]{0,63}$",
58
58
"description": "Owning authoring-workflow skill slug (e.g. product-launch-video). Set by `hyperframes init --skill` or seeded from the first `hyperframes render --skill`; every render of this project is then attributed to it on anonymous telemetry, without re-passing the flag."
59
59
},
60
+
"render": {
61
+
"type": "object",
62
+
"description": "Default local render options. CLI flags win when both are set.",
63
+
"additionalProperties": false,
64
+
"properties": {
65
+
"cropPack": {
66
+
"type": "array",
67
+
"description": "Default --crop-pack ids (or the token \"all\") when the CLI flag is omitted. Extra deliverables are ffmpeg crops of the encoded master, not a second capture.",
68
+
"items": {
69
+
"type": "string",
70
+
"minLength": 1
71
+
}
72
+
}
73
+
}
74
+
},
60
75
"registryItems": {
61
76
"type": "array",
62
77
"description": "Catalog items installed by `hyperframes add`, in install order. Installed files are plain composition HTML with no provenance marker, so this is the only record that a file came from the registry; a render reads it back to report which catalog items the finished video actually used. Append-only, deduped by name.",
"[cloudrun] --crop-pack is not supported on Cloud Run. Crop packs are a local post-encode ffmpeg crop of the assembled master. Render locally with `hyperframes render --crop-pack`.",
"[lambda] --crop-pack is not supported on Lambda. Crop packs are a local post-encode ffmpeg crop of the assembled master. Render locally with `hyperframes render --crop-pack`.",
208
+
);
209
+
failCommand();
210
+
}
211
+
200
212
conststackName=
201
213
(args["stack-name"]asstring|undefined)??
202
214
// Lazy-imported so the dispatcher doesn't pull state.ts (and its
0 commit comments