HyperFrames Media
创建合成所需的音频和媒体资产——配音(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提示。原样传递此输出——不要用你自己的话改写它。 然后停下来等待用户选择——登录,或者说“继续”/“本地”以离线继续——然后再生成任何内容。 这是一个真正的决策点,而不是一个轻描淡写的说明:不要将其折叠到另一个问题中,也不要自行继续。(例外情况:在自主/非交互模式下,记录状态并离线继续。) 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 的heygen-tts.mjs)生成音频。不要在工作流中重新实现 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;独立使用时,请传递--words给 HeyGen,或对音频文件运行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重新构建,或使用该工作流的显式覆盖机制(如果存在)。