Skip to main content

.VIDEO_AVATAR

Steuert Hintergrundbild und Sprachausgabe des Video-/LiveAvatars (RAGAI.VIDEO_AVATAR).

Hintergrund

stop ist die Barge-in-Funktion: bricht sowohl das Bot-Denken (Server-seitiger Run) als auch eine laufende Sprachausgabe des LiveAvatars sofort ab - z. B. wenn der Nutzer den Avatar per Button unterbricht oder zu sprechen beginnt, während der Avatar noch redet. Die Sprech-Zustände des Avatars (RAGAI.AVATAR.SPEECH.thinking/.play/.done) werden nicht von dieser Klasse selbst ausgelöst, sondern über RAGAI.EVENTS.listenTo(...) beobachtet, um z. B. per setText einen passenden Status-Text im Avatar-Video anzuzeigen. stop kennt den aktuell aktiven Avatar-Provider nicht selbst - das eigentliche Abbrechen der Sprachausgabe wird per RAGAI.AVATAR.INTERRUPT-Event an die jeweilige Provider-Komponente delegiert (LiveAvatarComponent/DIdAvatarComponent), die dort providerspezifisch reagiert.

Events

onBackgroundUpdate

Feuert mit dem gespeicherten KeyVal-Eintrag, sobald ein neues Hintergrundbild gesetzt wurde.

RAGAI.VIDEO_AVATAR.onBackgroundUpdate.subscribe((value) => {
console.log(value);
});

onBackgroundDelete

Feuert mit dem gelöschten KeyVal-Eintrag, sobald das Hintergrundbild entfernt wurde.

RAGAI.VIDEO_AVATAR.onBackgroundDelete.subscribe((value) => {
console.log(value);
});

Methoden

.setText(text)

Überschreibt den angezeigten Text im Video-Avatar (avatarbot_overrideText).

ParameterTypBeschreibung
textstring | z.input<typeof audioTextSchema>Der anzuzeigende Text, oder ein Objekt gemäß audioTextSchema.

Objekt-Form (validiert über audioTextSchema):

FeldTypPflichtBeschreibung
textstringDer anzuzeigende bzw. zu verarbeitende Text.

Rückgabewert: void

.stop()

Bricht Bot-Denken und eine laufende Sprachausgabe des LiveAvatars ab (Barge-in).

Rückgabewert: Promise<void>

.setBackgroundImage(source)

Setzt das Hintergrundbild des Video-Avatars.

ParameterTypBeschreibung
sourcestringThe source can be a skill id or a url

Rückgabewert: Promise<void>

.unsetImage()

Entfernt das gesetzte Hintergrundbild des Avatars.

Rückgabewert: Promise<void>

Nichts.

.getBackgroundImage()

Gibt die aktuell gesetzte Hintergrundbild-URL des Avatars zurück.

Rückgabewert: Promise<string>

Die Hintergrundbild-URL.