HyperFrames 核心
Agent 陷阱(请先阅读):
- 使用 flex/
inset居中,而不是在随后用 GSAPx/y进行动画的节点上使用 CSStransform: translate(-50%,-50%)。Lint 错误:gsap_css_transform_conflict。应使用fromTo或xPercent/yPercent。 - 不要添加场景退出的
tl.set(..., {visibility:"hidden"})。运行时已经会隐藏计时片段。在内层节点上使用不透明度淡出(或.clip上的opacity)就足够了。字幕硬终止是另一套规则。 window.__timelines["id"]必须与根元素的data-composition-id匹配。- 在
render之后,阅读摘要的第二行:beginframe与screenshot、GPU 模式、阶段时间。在 Linux 上,screenshot+software gpu是慢路径。
HyperFrames 从 HTML 渲染视频。一个合成是一个 HTML 文件,其 DOM 通过 data-* 属性声明时间,其动画运行时是可寻址的,其媒体播放由框架拥有。
本技能是技术协议——如何构建一个 HyperFrames 项目。以下是构建指南;每个主题的详细信息位于 references/(索引见下文),按需阅读。流程文档(简报、故事板、评审、制作、分发、帧处理)位于 /hyperframes → references/。其他关注点位于同级领域技能中——hyperframes-animation、hyperframes-creative、media-use、hyperframes-cli、hyperframes-registry。/hyperframes 中的能力图说明了每个技能覆盖的内容。
参考资料
| 文件 | 阅读目的… |
|---|---|
references/minimal-composition.md | 从最小的可渲染合成骨架开始 |
references/composition-patterns.md | 选择整体式 vs 模块化;构建模块化 index.html;选择子合成原型 |
references/data-attributes.md | 查找任何 data-*(根元素 / 片段 / 子合成宿主 / 遗留别名);使用 class="clip" |
references/tracks-and-clips.md | 理解 data-track-index 的作用(以及不作用),z-index,相对于另一个片段计时;使用 npx hyperframes timeline 列出每个轨道和片段 |
references/creator-editing-recipes.md | 复制真实的剪切/裁剪/重新排序/重新计时/冻结/镜头/蒙版/交叉淡入淡出/音频编辑方案及其限制 |
references/sub-compositions.md | 连接子合成(宿主属性、<template>、每个实例的变量)并在其内部进行动画 |
references/variables-and-media.md | 声明变量;放置 <video>/<audio>,设置音量,裁剪 |
references/determinism-rules.md | 构建可寻址的时间线;确定性禁止项;布局/文本适配 |
references/full-screen-motion.md | 使用共享背景创作全帧运动 |
references/tailwind.md | 在 Tailwind v4 项目中工作(init --tailwind;运行时约定与 Studio 的 v3 不同) |
有关动画运行时的具体信息(GSAP API、Lottie、Three.js 等),请参见 hyperframes-animation → adapters/<runtime>.md。
构建合成
两种根形式(不可互换)
- 独立式(顶层
index.html):根<div data-composition-id="…">直接位于<body>中,没有<template>包裹。将独立根包裹起来会隐藏所有内容,并且lint会拒绝它(standalone_composition_wrapped_in_template,错误)。 - 子合成(通过
data-composition-src加载):将根元素包裹在<template>中。这是要编写的结构:加载器也接受普通的完整文档并回退到其<body>,但示例和工具假设的是模板形式。
⚠ 传输规则:对于模板化的子合成,装配器会丢弃文件自身的
<head><style>/<script>(packages/core/src/compiler/compositionAssembly.ts,hasTemplate门),因此请将<style>/<script>放在模板内部。<link>无论如何都会被提升。 ⚠ 宿主 ID 约定:给宿主插槽、内部模板和window.__timelines["<id>"]键使用相同的 ID。支持不同的本地 ID(装配器会回退到文件中的第一个根元素),但匹配失败是静默的,因此除非你有理由不使用,否则请匹配它们。
文件结构、宿主连接和预渲染检查清单 → references/sub-compositions.md。
根元素必须设置大小(静默布局错误)
独立根元素编写 width/height: 100%。画布大小是 data-width/data-height。运行时将这些像素值应用到合成根元素上。不要在 #root 上硬编码 1920px/1080px。骨架 → references/minimal-composition.md。
一个暂停的时间线
每个合成在 window.__timelines["<id>"] 处注册恰好一个 gsap.timeline({ paused: true })(键 = 根元素的 data-composition-id)。在异步回调(document.fonts.ready)内构建它是支持的;重要的是你仅在构建完成后注册。渲染长度是根元素的 data-duration,不是时间线的长度:超过它的时间线会被截断,提前结束的时间线会保持其最后一帧。省略根元素的 data-duration,则长度会被推断(时间线、媒体窗口或适配器)。你不需要 window.__timelines = window.__timelines || {}:运行时会在你的内联脚本运行之前创建注册表,并且 lint 不再要求它。不要手动将子时间线嵌套到宿主中;运行时会自动嵌套已注册的子时间线。完整约定(包括非 GSAP 运行时)→ references/determinism-rules.md + hyperframes-animation/adapters/。
首轮 lint 陷阱(保证首次构建失败)
lint 确实会捕获的规则,但仅在事后。请一次性正确编写:
- 切勿将 CSS 初始
transform与同一属性上的 GSAP 补间配对——CSS 值和补间的起始值会冲突,lint会以gsap_css_transform_conflict拒绝它。使用gsap.fromTo(el, { x: -40 }, { x: 0 })在补间内设置初始状态,而不是 CSStransform: translateX(-40px)。 - 切勿在
<video>/<audio>上放置crossorigin。lint无条件拒绝它,错误为media_crossorigin_breaks_preview(错误),包括用于 canvas/WebGL/WebAudio 回读。没有抑制方法。 - 切勿给
<video data-start>一个也带有data-start的祖先。lint会以video_nested_in_timed_element(错误)拒绝它。给包装器或视频计时,而不是两者都计时。 - 每个
<audio>都需要一个id。lint会以media_missing_id拒绝它,并且没有id的<audio>永远不会被混音器拾取,因此渲染是静音的。 - 切勿使用
autoAlpha或visibility对.clip进行补间——lint会以gsap_animates_clip_element拒绝它。改为对子元素进行动画。 - 命名的 CSS
font-family需要一个文件内的@font-face指向已发布的本地文件,否则lint触发font_family_without_font_face。 - 子合成
#root使用width/height: 100%(或inset: 0),而不是硬编码的1920px/1080px。画布大小是data-width/data-height。
Lint 错误还会关闭布局和对比度检查:check 随后报告 0 sample(s) 和 0/0 text checks,这看起来像文件干净,但意味着什么也没运行。在信任这些数字之前清除 lint 错误。
不可协商的规则(自动门可能遗漏的静默错误)
在此列出;完整理由见链接的参考资料。不要违反:
- 没有渲染时间时钟 / 未播种的
Math.random/ 网络 / 输入状态;没有repeat: -1(使用有限次数)。→determinism-rules.md - 切勿在
.clip元素上对display、visibility或autoAlpha进行补间。框架拥有片段可见性,lint拒绝它(gsap_animates_clip_element)。改为对子元素进行动画。→determinism-rules.md - 正文中没有
<br>;变换后的元素必须是块级且有大小;脉动的绝对定位装饰元素需要峰值间隙。→determinism-rules.md <video>/<audio>通过扁平文档查询找到,因此框架可以在任何嵌套深度(包括在子合成<template>或包装器内部)查找和解码它们。一个硬限制:如果<video data-start>位于另一个也带有data-start的普通元素内部,lint会报错,并且失败是真实的(错误的源帧,然后片段在中间消失),因此将计时放在包装器或视频上,绝不要同时放在两者上。子合成宿主是豁免的:子合成内部的媒体可以正确渲染。另一个问题是时间线,而不是位置:子合成时间线不能对宿主根元素进行动画。→variables-and-media.md- 保持每个
id在装配后的页面中唯一(为子合成 ID 添加组合 ID 前缀,如#<id>-hero),以便你自己的#idCSS 和getElementById调用能够正确解析。帧注入不再依赖于此:编译器会在每个video[src]/audio[src]/img[src]上打上文档唯一的data-hf-render-id。使用<source>子元素而不是src属性的媒体不会被打上标记,因此唯一的 ID 在那里仍然很重要。→composition-patterns.md - 在合成根元素上进行的全屏填充在正常渲染中是可以的。它仅在分层合成路径(HDR 内容或使用着色器过渡的合成)中被丢弃,此时引擎强制每个合成根元素透明,以使底层可见。如果你的合成使用着色器过渡或 HDR 媒体,请将填充放在一个全出血的子元素上(
position:absolute; inset:0)。→composition-patterns.md
编辑现有合成
- 先阅读文件。保留不相关的计时、轨道、ID、变量、媒体路径。
- 要了解项目时间线上的内容(轨道、片段、开始、结束、播放的内容),运行
npx hyperframes timeline [--json],而不是读取index.html和每个子合成文件。 - 匹配现有的合成 ID 和时间线键。
- 添加片段:有意地根据其周围的片段设置其
data-start/data-duration。data-track-index是 Studio 的显示通道,不是时间约束,因此它不需要是空闲的。 - 任何合成元素上的
data-hidden会在预览和渲染中隐藏它,覆盖其时间窗口;它是非破坏性/可逆的,并通过 Studio 的时间线眼睛图标切换。 - 添加子合成:在连接宿主之前,验证其内部的
data-composition-id。
验证
有关命令详细信息,请使用 hyperframes-cli
-
npx hyperframes check通过(0 个发现,涵盖 lint、运行时、布局、运动和对比度) - 包含子合成的项目:
npx hyperframes snapshot --at <midpoints>并仔细检查每一帧 -
npx hyperframes preview --background用于评审(用户可以在 Studio 的时间线中编辑任何内容,并且服务器会在调用命令后继续运行) - 仅在用户批准后运行
npx hyperframes render