HyperFrames 媒体
为合成作品创建所需的音频和媒体资产——画外音(TTS)、背景音乐 + 音效、转录、字幕、背景去除——然后在 HTML 中消费和动画化这些数据。关于如何将资产放入合成作品中,请参阅 hyperframes-core。
音频引擎——TTS · BGM · SFX 的单一来源
工作流不会手动处理音频或复制供应商的副本。只有一个引擎——scripts/audio.mjs——它接受一个中立的 audio_request.json 并写入 audio_meta.json(以及 assets/voice|bgm|sfx 下的资产):
# <MEDIA_DIR> = 此技能的目录
node <MEDIA_DIR>/scripts/audio.mjs --request ./audio_request.json --hyperframes . --out ./audio_meta.json
所有三种能力都基于一个开关降级——是否存在 HeyGen 凭据(从 $HEYGEN_API_KEY / $HYPERFRAMES_API_KEY / ~/.heygen 解析,不是 CLI):
| 能力 | HeyGen 凭据存在 | 不存在 |
|---|---|---|
| TTS | HeyGen Starfish REST(原生字词时间戳) | → ElevenLabs → Kokoro(链接 transcribe 获取字词) |
| BGM | HeyGen 音乐检索 | Lyria → MusicGen 本地生成(分离运行) |
| SFX | HeyGen 音效检索(min_score 0.4) | 捆绑的 21 文件库(assets/sfx/) |
- 请求(
audio_request.json):{ provider?, lang?, speed?, lines: [{ id, text, sfx?: [names] }], bgm: { mode?, query?, prompt? } }。id将每一行连接回调用者的模型(帧号、场景 ID 等)。bgm.mode=retrieve | generate | none;省略则为自动模式(有凭据时检索,否则生成)。显式的retrieve是严格的——它会跳过而不是启动一个分离的生成(适用于没有wait-bgm步骤的调用者)。 - 输出(
audio_meta.json,按 id 键控):{ tts_provider, voice_id, bgm, bgm_pending, …, voices: [{ id, path, duration_s, words }], sfx: [{ id, name, file, source, offset_s, duration_s, volume }], total_duration_s }。 --only tts,bgm,sfx运行一个子集并将结果合并到现有的--out中(例如,先 TTS+BGM,一旦有了提示,再处理 SFX)。- BGM 生成是分离启动的(
bgm_pending: true)——在组装前运行scripts/wait-bgm.mjs。 scripts/heygen-tts.mjs是一个基于相同代码的单次 CLI(一段文本 → wav + 字词),适用于你只需要 HeyGen TTS 而无需请求文件的情况。
完整标志列表和 audio_meta.json 模式位于 scripts/audio.mjs 的头部。下面的参考资料涵盖了每种能力背后的提供商细节和边界情况。
预检——在任何音频之前显示登录状态
在生成语音或 BGM 之前始终运行此步骤——无论是在完整工作流中,还是在一次性的“为我生成 BGM/画外音”请求中。 没有 HeyGen 凭据不是静默回退到本地引擎的理由:首先建议登录,让用户决定。运行共享预检并原样传递其输出——不要自己编造“缺少密钥”的提示,也不要提供将密钥写入每个仓库的 .env 文件中:
npx hyperframes auth status
- 已登录 → 它将打印账户信息;继续。
- 未登录(这里预期
exit 1——“未登录”是正常状态,不是失败)→ 它将打印注册优先的指导。建议登录:npx hyperframes auth login是浏览器 OAuth——它登录并创建一个账户(始终可通过此仓库的 CLI 使用)。要使用现有的 HeyGen API 密钥(来自 app.heygen.com/settings/api),运行npx hyperframes auth login --api-key——它会保存到共享的~/.heygen(无需每个仓库的.env)。输出还会列出本地引擎的语音/BGM 将回退到的提供商,以及当依赖项缺失时的pip提示。原样传递此输出——不要用你自己的措辞改写它。 然后停止并等待用户选择——登录,或说“go”/“local”以继续离线模式——在生成任何内容之前。 这是一个真实的决策点,而不是一个简单的说明:不要把它折叠到另一个问题中,也不要自己越过它。(例外:在自主/非交互模式下,记录状态并继续离线。) npx hyperframes auth status --json返回{ configured, recommended_action, offline_engines },用于确定性分支。- 如果 CLI 无法运行(不在 PATH 上且
npx无法获取)→ 仍然建议登录(npx hyperframes auth login)并停止等待用户选择——不要将“没有凭据”视为本地生成的静默绿灯。
凭据解析、完整密钥优先级和本地依赖列表位于 references/requirements.md 中。
提供商链(引擎背后的细节)
TTS——第一个可用的提供商获胜(引擎,或 npx hyperframes tts "..."):
| 顺序 | 提供商 | 检测时机 | 字词时间戳 |
|---|---|---|---|
| 1 | HeyGen(Starfish) | $HEYGEN_API_KEY / hyperframes auth login | 是,原生——传递 --words narration.words.json 以捕获 |
| 2 | ElevenLabs | 设置 $ELEVENLABS_API_KEY | 否——之后链接 transcribe |
| 3 | Kokoro-82M(本地,54 种声音) | 始终可用(无需密钥) | 否——之后链接 transcribe |
发布的
hyperframes ttsCLI 通常是仅本地的构建版本(其--help显示“Kokoro-82M”,没有--provider/--words),即使设置了$HEYGEN_API_KEY也会静默回退到 Kokoro。这就是为什么引擎的 HeyGen 路径是自包含的scripts/heygen-tts.mjs(REST),而不是 CLI;CLI 仅用于 Kokoro 路径。请参阅references/tts.md。
BGM & SFX——默认从 HeyGen 音频库检索(/v3/audio/sounds),凭据与 HeyGen TTS 相同,无凭据时回退到上述开关:
| 资产 | HeyGen type | 存放位置 | 回退(无凭据) |
|---|---|---|---|
| BGM | music | assets/bgm/track.mp3(检索)· track.wav(生成) | Lyria / MusicGen 生成 |
| SFX | sound_effects(min_score 0.4) | assets/sfx/<slug>.mp3 | 捆绑的 21 文件库(assets/sfx/* + manifest.json) |
请参阅 references/bgm.md 和 references/sfx.md。
路由
| 任务 | 阅读 |
|---|---|
音频引擎——请求/元数据模式,--only,开关 | scripts/audio.mjs(头部注释) |
npx hyperframes tts / heygen-tts.mjs——提供商、声音、字词 | references/tts.md |
| BGM——HeyGen 检索 + 本地 Lyria / MusicGen 生成 | references/bgm.md |
| SFX——HeyGen 检索(min_score 0.4)+ 捆绑的本地库 | references/sfx.md |
npx hyperframes transcribe——Whisper,模型规则,输出形状 | references/transcribe.md |
npx hyperframes remove-background——透明剪切 | references/remove-background.md |
| TTS → 转录 → 字幕(无需录制的画外音) | references/tts-to-captions.md |
| 字幕编辑——样式检测、布局、字词分组、退出 | references/captions/authoring.md |
| 转录处理——输入格式、质量门、清理、API | references/captions/transcript-handling.md |
| 字幕动画——卡拉 OK、标记效果、音频反应式 | references/captions/motion.md |
| 模型缓存、系统依赖项、故障排除 | references/requirements.md |
不可协商的规则
- 一个引擎,无供应商副本。 通过
scripts/audio.mjs(或heygen-tts.mjs用于一次性 HeyGen TTS)生成音频。不要在工作流中重新实现 TTS/BGM/SFX——编写一个audio_request.json适配器并调用引擎。 - "HeyGen 可用" = 可解析的凭据,而不是 CLI。 整个开关以
heygenCredential()为键控;发布的hyperframes tts可能只是 Kokoro 版本,而且根本没有hyperframes bgm/hyperframes sfx命令。 - 语音 ID 是特定于提供商的。
am_michael仅适用于 Kokoro;HeyGen UUID 在 Kokoro 上不起作用。如果你传递--voice,也要固定--provider以避免当用户的环境发生变化时出现无声的提供商漂移。 - 始终向
transcribe传递--model。 CLI 默认的small.en会静默翻译非英语音频。请参阅references/transcribe.md→ "语言规则"。 - HeyGen 返回字词时间戳;ElevenLabs / Kokoro 不返回。 引擎会自动为后两者链接触发
transcribe;独立使用时,向 HeyGen 传递--words或对音频文件运行transcribe。 - 字幕使用扁平的字词数组格式,包含
{ id, text, start, end }。请参阅references/transcribe.md→ "输出形状"。 remove-background --background-output是抠洞,不是内补。 对于“没有人的场景”,需要使用不同的工具。请参阅references/remove-background.md→ "何时不是合适的工具"。- BGM/SFX 默认使用 HeyGen 检索;无凭据时回退到生成(BGM)或捆绑库(SFX)。
/audio/sounds按文本查询排序——具体命名效果(glass shatter,而不是dramatic sound);无匹配则跳过,从不阻塞渲染。SFX 在语音 + BGM 下的音量约为 0.35。请参阅references/sfx.md/references/bgm.md。 - 将工作流字幕 HTML 视为生成的输出。 对于基于预设的视频,可重复使用的皮肤源位于
.hyperframes/caption-skin.html,工作流脚本写入compositions/captions.html;不要编辑生成的compositions/captions.html来修复皮肤。通过工作流的captions.mjs重新构建,或在工作流存在时使用其显式覆盖机制。