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 的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,以避免在使用者環境變更時發生無聲的供應商漂移。 - 務必傳遞
--model給transcribe。 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重建,或使用該工作流程的明確覆寫機制(如有)。