VuppetMaster Dokumentation

JavaScript-API

Die dokumentierten v4-Aufrufe für Projektstart, Animationen, Szenen und Sprache im Überblick.

Referenzstand: archivierte v4-Dokumentation, 2025. Diese Beispiele sind keine Zusage zur aktuellen Dienstverfügbarkeit. Script-URL, gültiger Projektzugang und verfügbare Methoden müssen mit Ihrer Projektversion übereinstimmen. Es wird hier kein externer API-Code ausgeführt.

Engine starten

Laden Sie zuerst das für Ihr Projekt bereitgestellte VuppetMaster-Script. Danach steht im dokumentierten v4-Modell der Konstruktor VM.Vuppetmaster bereit. Starten Sie die Engine einmal je Instanz und registrieren Sie Ladeereignisse vor dem Start.

<div id="avatar" style="width:100%; height:420px"></div>
<!-- Zuerst das bereitgestellte Projekt-Script laden. -->
<script>
  const vm = new VM.Vuppetmaster();
  vm.api.on('project.loaded', () => {
    console.log('Avatar-Projekt geladen');
  });
  vm.api.start({ target: 'avatar' });
</script>

Inhalte gezielt abspielen

Die folgenden Namen sind Beispiele. Ersetzen Sie sie durch die Namen aus Ihrem Projekt. Führen Sie Aufrufe erst nach erfolgreichem Laden aus.

vm.api.setSceneByName('beratung');
vm.api.playAnimationByName('begruessung');
vm.api.playSequenceByName('produkt_erklaeren');

Methoden und Ereignisse

Aufruf / Ereignis	Funktion laut v4-Referenz
`start(options)`	Projekt und Render-Engine starten; `target` legt den Container fest.
`on('project.loaded', callback)`	Auf das geladene Projekt reagieren.
`on('model.progress', callback)`	Ladefortschritt als Wert verarbeiten.
`playAnimationByName(name)`	Benannte Animation starten.
`setSceneByName(name)`	Aktuelle Szene wechseln.
`playSequenceByName(name)`	Benannte Sequenz starten.
`speak(options)`	Text an die konfigurierte Sprachausgabe übergeben.
`speakStop()`	Laufende Sprachausgabe stoppen.
`destroy()`	Rendering beenden.

Sprache ausgeben

Die v4-Referenz beschreibt ein Objekt mit voice, text und optional endCB. Die tatsächlich verfügbare Stimme richtet sich nach dem angebundenen Sprachdienst und Ihrem Projekt. Starten Sie Audio nach einer Nutzeraktion und verarbeiten Sie keine vertraulichen Inhalte ohne abgestimmtes Datenschutzkonzept.

Wichtige Integrationsregeln

Keine Beispiel-Lizenzschlüssel aus dem Archiv übernehmen.
Projektzustand prüfen, bevor Interaktionen freigeschaltet werden.
Fehler- und Ladezustände in Ihrer Anwendung sichtbar behandeln.
Engine beim Entfernen der Avatar-Ansicht sauber beenden.

Fragen zu Ihrer konkreten Integration?

Technischen Austausch anfragen