插件安装: 在运行设置或更新命令之前,如果此技能位于 HyperFrames 插件内部,请遵循 插件执行规则。独立安装则保留以下更新说明。
HyperFrames Core
Agent 陷阱(先阅读):
- 使用 flex/
inset居中,而不是在一个节点上使用 CSStransform: translate(-50%,-50%)然后通过 GSAPx/y动画。Lint:gsap_css_transform_conflict。使用fromTo或xPercent/yPercent。 - 不要添加场景退出
tl.set(..., {visibility:"hidden"})。运行时已经隐藏了定时片段。对内部节点(或.clip上的opacity)进行不透明度渐变就足够了。字幕硬性终止是另一条规则。 window.__timelines["id"]必须与根元素的data-composition-id相匹配。- 在
render之后,阅读摘要的第二行:beginframevsscreenshot、GPU 模式、阶段时序。screenshot+software gpu在 Linux 上是慢路径。
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 | 选择整体式与模块化;构建模块化 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。
一个暂停的时间轴
每个合成都注册恰好一个 gsap.timeline({ paused: true }) 在 window.__timelines["<id>"] 处(键 = 根元素 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>永远不会被混音器拾取,因此渲染是静默的。 - 永远不要对
.clip使用autoAlpha或visibility进行补间——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仅在有限的根元素data-duration下(导出片段到它——否则使用有限计数)。→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>-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-duration之后结束的片段会被截断:在同一个编辑中将根元素data-duration延长到片段的结束位置(lint会发出clip_ends_past_root_duration警告)。 - 任何合成元素上的
data-hidden在预览和渲染中都会隐藏它,覆盖其时间窗口;它是非破坏性/可逆的,并由 Studio 的时间轴眼睛图标切换。 - 添加子合成:在连接宿主之前验证其内部的
data-composition-id。
验证
使用 hyperframes-cli 了解命令详情
-
npx hyperframes check通过(在 lint、运行时、布局、运动和对比度方面没有发现任何问题) - 包含子合成的项目:
npx hyperframes snapshot --at <midpoints>并目视检查每一帧 -
npx hyperframes preview --background用于评审(用户可以在 Studio 的时间轴中编辑任何内容,并且服务器在调用命令后仍然存活) - 仅在用户批准后执行
npx hyperframes render