Média HyperFrames
Créez les actifs audio et médias nécessaires à une composition — voix off (TTS), musique de fond + effets sonores, transcription, sous-titres, suppression d'arrière-plan — puis consommez et animez ces données en HTML. Pour placer des actifs dans des compositions, voir hyperframes-core.
Le moteur audio — une source unique pour TTS · BGM · SFX
Les workflows ne créent PAS d'audio manuellement ni n'utilisent de copie externalisée. Il existe un moteur unique — scripts/audio.mjs — qui prend un audio_request.json neutre et écrit audio_meta.json (plus les actifs sous assets/voice|bgm|sfx) :
# <MEDIA_DIR> = répertoire de cette compétence
node <MEDIA_DIR>/scripts/audio.mjs --request ./audio_request.json --hyperframes . --out ./audio_meta.json
Les trois capacités dépendent d'UN SEUL commutateur — la présence d'un identifiant HeyGen (résolu à partir de $HEYGEN_API_KEY / $HYPERFRAMES_API_KEY / ~/.heygen, pas de la CLI) :
| Capacité | Identifiant HeyGen présent | absent |
|---|---|---|
| TTS | HeyGen Starfish REST (horodatages natifs par mot) | → ElevenLabs → Kokoro (chaîne transcribe pour les mots) |
| BGM | Récupération musique HeyGen | Lyria → MusicGen génération locale (détachée) |
| SFX | Récupération effets sonores HeyGen (min_score 0.4) | bibliothèque intégrée de 21 fichiers (assets/sfx/) |
- Requête (
audio_request.json) :{ provider?, lang?, speed?, lines: [{ id, text, sfx?: [names] }], bgm: { mode?, query?, prompt? } }.idrattache chaque ligne au modèle de l'appelant (un numéro d'image, un identifiant de scène, …).bgm.mode=retrieve | generate | none; omettre pour auto (récupérer avec identifiant, sinon générer). Unretrieveexplicite est strict — il saute plutôt que de lancer une génération détachée (pour les appelants sans étapewait-bgm). - Sortie (
audio_meta.json, indexée par 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,sfxexécute un sous-ensemble et fusionne avec un--outexistant (par exemple, TTS+BGM tôt, SFX une fois les repères existants).- La génération BGM est lancée détachée (
bgm_pending: true) — exécutezscripts/wait-bgm.mjsavant l'assemblage. scripts/heygen-tts.mjsest une CLI à usage unique sur le même code (un texte → wav + mots) pour quand vous avez juste besoin du TTS HeyGen sans fichier de requête.
La liste complète des indicateurs et le schéma audio_meta.json se trouvent dans l'en-tête de scripts/audio.mjs. Les références ci-dessous couvrent les détails des fournisseurs et les cas particuliers derrière chaque capacité.
Pré-vérification — afficher l'état de connexion avant tout audio
Exécutez TOUJOURS cette étape avant de générer une voix ou un BGM — dans un workflow complet ou une demande ponctuelle « génère-moi un BGM/voix off ». L'absence d'identifiant HeyGen n'est pas une raison pour utiliser silencieusement les moteurs locaux : recommandez d'abord la connexion et laissez l'utilisateur décider. Exécutez la pré-vérification partagée et retransmettez sa sortie textuellement — n'improvisez pas votre propre message « clé manquante » et n'offrez pas d'écrire des clés dans un .env par dépôt :
npx hyperframes auth status
- Connecté → il affiche le compte ; continuez.
- Non connecté (
exit 1est attendu ici — « non connecté » est un état normal, pas un échec) → il affiche des conseils d'inscription. Recommandez la connexion :npx hyperframes auth loginest un OAuth navigateur — il connecte et crée un compte (toujours disponible via la CLI de ce dépôt). Pour utiliser une clé API HeyGen existante (depuis app.heygen.com/settings/api), exécuteznpx hyperframes auth login --api-key— elle enregistre dans~/.heygenpartagé (pas de.envpar dépôt). La sortie liste également les moteurs locaux vers lesquels la voix/BGM basculera et un indicepiplorsque les dépendances manquent. Retransmettez cette sortie telle quelle — ne la paraphrasez pas dans vos propres mots. Ensuite, ARRÊTEZ et attendez le choix de l'utilisateur — se connecter, ou dire « go » / « local » pour continuer hors ligne — avant de générer quoi que ce soit. C'est un véritable point de décision, pas une note de passage : ne le fondez pas dans une autre question et ne continuez pas par vous-même. (Exception : en mode autonome / non interactif, notez l'état et continuez hors ligne.) npx hyperframes auth status --jsonrenvoie{ configured, recommended_action, offline_engines }pour une ramification déterministe.- Si la CLI ne peut pas s'exécuter (pas dans le PATH et
npxne peut pas la récupérer) → recommandez toujours la connexion (npx hyperframes auth login) et ARRÊTEZ pour le choix de l'utilisateur — ne traitez pas « pas d'identifiant » comme un feu vert silencieux pour la génération locale.
La résolution des identifiants, la priorité complète des clés et la liste des dépendances locales se trouvent dans references/requirements.md.
Chaînes de fournisseurs (le détail derrière le moteur)
TTS — le premier fournisseur disponible gagne (le moteur, ou npx hyperframes tts "...") :
| Ordre | Fournisseur | Détecté quand | Horodatages par mot |
|---|---|---|---|
| 1 | HeyGen (Starfish) | $HEYGEN_API_KEY / hyperframes auth login | Oui, natifs — passez --words narration.words.json pour capturer |
| 2 | ElevenLabs | $ELEVENLABS_API_KEY défini | Non — chaînez transcribe après |
| 3 | Kokoro-82M (local, 54 voix) | toujours (aucune clé requise) | Non — chaînez transcribe après |
La CLI publiée
hyperframes ttsest souvent la version locale uniquement (son--helpdit « Kokoro-82M », pas de--provider/--words) et utilise silencieusement Kokoro même avec$HEYGEN_API_KEYdéfini. C'est pourquoi le chemin HeyGen du moteur est lescripts/heygen-tts.mjs(REST) autonome, PAS la CLI ; la CLI est utilisée uniquement pour le chemin Kokoro. Voirreferences/tts.md.
BGM et SFX — par défaut récupérés depuis la bibliothèque audio HeyGen (/v3/audio/sounds), même identifiant que pour le TTS HeyGen, avec la solution de secours sans identifiant du commutateur ci-dessus :
| Actif | Type HeyGen | Atterrit dans | Solution de secours (sans identifiant) |
|---|---|---|---|
| BGM | music | assets/bgm/track.mp3 (récupération) · track.wav (génération) | Génération Lyria / MusicGen |
| SFX | sound_effects (min_score 0.4) | assets/sfx/<slug>.mp3 | Bibliothèque intégrée de 21 fichiers (assets/sfx/* + manifest.json) |
Voir references/bgm.md et references/sfx.md.
Routage
| Tâche | Lire |
|---|---|
Le moteur audio — schéma requête/meta, --only, le commutateur | scripts/audio.mjs (commentaire d'en-tête) |
npx hyperframes tts / heygen-tts.mjs — fournisseurs, voix, mots | references/tts.md |
| BGM — Récupération HeyGen + génération locale Lyria / MusicGen | references/bgm.md |
| SFX — Récupération HeyGen (min_score 0.4) + bibliothèque locale intégrée | references/sfx.md |
npx hyperframes transcribe — Whisper, règles de modèle, forme de sortie | references/transcribe.md |
npx hyperframes remove-background — découpes transparentes | references/remove-background.md |
| TTS → transcription → sous-titres (sans voix off enregistrée) | references/tts-to-captions.md |
| Création de sous-titres — détection de style, disposition, regroupement de mots, sortie | references/captions/authoring.md |
| Gestion des transcriptions — formats d'entrée, contrôles de qualité, nettoyage, API | references/captions/transcript-handling.md |
| Animation des sous-titres — karaoké, effets de marqueur, réactif à l'audio | references/captions/motion.md |
| Caches de modèles, dépendances système, dépannage | references/requirements.md |
Règles non négociables
- Un moteur unique, pas de copies externalisées. Produisez l'audio via
scripts/audio.mjs(ouheygen-tts.mjspour un TTS HeyGen ponctuel). Ne réimplémentez pas TTS/BGM/SFX dans un workflow — écrivez un adaptateuraudio_request.jsonet appelez le moteur. - « HeyGen disponible » = un identifiant résoluble, pas la CLI. Tout le commutateur se base sur
heygenCredential(); la CLI publiéehyperframes ttspeut être Kokoro uniquement, et il n'existe aucune commandehyperframes bgm/hyperframes sfx. - Les identifiants de voix sont spécifiques au fournisseur.
am_michaelest Kokoro uniquement ; les UUID HeyGen ne fonctionnent pas sur Kokoro. Si vous passez--voice, verrouillez également--providerpour éviter une dérive silencieuse du fournisseur lorsque l'environnement de l'utilisateur change. - Passez toujours
--modelàtranscribe. Le défaut de la CLIsmall.entraduit silencieusement l'audio non anglais. Voirreferences/transcribe.md→ « Règle de langue ». - HeyGen renvoie des horodatages par mot ; ElevenLabs / Kokoro non. Le moteur chaîne
transcribeautomatiquement pour ces deux derniers ; de manière autonome, passez--wordsà HeyGen ou exécuteztranscribesur le fichier audio. - Les sous-titres consomment le format de tableau de mots plat avec
{ id, text, start, end }. Voirreferences/transcribe.md→ « Forme de sortie ». remove-background --background-outputest un trou découpé, pas un remplissage intelligent. Pour « scène sans la personne », un outil différent est nécessaire. Voirreferences/remove-background.md→ « Quand NE PAS utiliser cet outil ».- BGM/SFX utilisent par défaut la récupération HeyGen ; la solution de secours sans identifiant est la génération (BGM) ou la bibliothèque intégrée (SFX).
/audio/soundsclasse par requête textuelle — nommez les effets concrètement (verre brisé, passon dramatique) ; une absence de correspondance saute, ne bloque jamais le rendu. Les SFX sont à un volume d'environ 0,35 sous la voix et le BGM. Voirreferences/sfx.md/references/bgm.md. - Traitez le HTML des sous-titres du workflow comme une sortie générée. Pour les vidéos basées sur des skins prédéfinis, la source du skin réutilisable se trouve à
.hyperframes/caption-skin.htmlet le script du workflow écritcompositions/captions.html; ne modifiez pas lecompositions/captions.htmlgénéré pour corriger le skin. Reconstruisez via lecaptions.mjsdu workflow ou utilisez le mécanisme de surcharges explicites de ce workflow lorsqu'il est présent.