Category 1

Speech & Audio Playback

1
Speak Pre-Existing Audio
sayAudio
2
Speak Text-To-Speech Audio
sayText
3
Enable/Disable Playback Queuing
setStatus
4
Stop and Restart Speech
stopSpeechreplay
5
Preload Audio
loadAudio
6
Preload Text-To-Speech
loadText
7
Adjust Audio Volume
setPlayerVolume
8
Silent Mock Speech
saySilent
9
Speaking Static Audios in Sequence
sayAudiosequence
10
Speaking Dynamic TTS in Sequence
sayTextsequence
11
Speaking Long TTS Input
sayTextlong input
12
Add Audio Effects to TTS
sayTexteffects
Category 2

Avatar Control & Animation

13
Control Your Avatar's Gaze
setGazerecenter
14
Set Your Avatar's Cursor Tracking
followCursor
15
Control Facial Movement
setIdleMovementsetSpeechMovementfreezeToggle
16
Control Facial Expressions
setFacialExpressionclearExpressionList
17
Control Blink Frequency
setBlinking
Category 3

Scene Appearance

18
Modify Your Avatar's Colors
setColor
19
Update Your Scene's Background Image
setBackground
20
Modify Your Scene's Background Color
setBackgroundColor
21
Modify Display Settings for Play Controls
setStatus
22
Get Scene Attributes
getSceneAttributes
23
Check Whether Avatar is 3D
is3D
Category 4

Scene Layout & Embedding

24
Responsive Embed — Standard Embed Code
dynamicResize
25
Responsive Embed — No JS Embed Code
responsive embed
26
Resize Scene Without Reloading It – Example 1
dynamicResize
27
Resize Scene Without Reloading It – Example 2
dynamicResize
28
Embed Overlay
overlayOpenoverlayClose
29
Select Which Scene to Load Into Each Portal
loadSceneByIDselectPortal
30
Load and Unload a Scene
loadSceneByIDunloadScene
31
Belated Load Example
loadSceneByIDbelated
32
Access Raw Audio Data
getAudioObject
33
Get / Set Frame Rate
getFPSsetFPS
Category 5

AI Avatar Integration

34
Using Your AI Avatar
sayAIsayAIResponse
35
Using Speech Input with Your AI Avatar
sayAISTT
36
Integration with 3rd Party AI Assistants
sayAI3rd party
48
React JS AI Avatar — Speech Input (Web Speech API)
sayAIreact
Category 6

Callbacks & Events

37
Using Callbacks
vh_sceneLoadedvh_talkStartedvh_talkEndedvh_audioStartedvh_audioEndedvh_audioErrorvh_playPausevh_audioProgressvh_aiResponsevh_audioLoadedvh_ttsLoadedvh_portalReady
Category 8

JavaScript Framework Examples

React

Technical Example
Core API integration with React
Responsive Example
Responsive embed in React
Conversation Example
Multi-portal conversation
AI Avatar — Text Input
AI Avatar with text-based input
AI Avatar — Speech Input
AI Avatar with speech recognition
AI Avatar — No Code Solution
No-code AI Avatar embed

Angular

Technical Example
Core API integration with Angular
Responsive Example
Responsive embed in Angular
Conversation Example
Multi-portal conversation
AI Avatar — Text Input
AI Avatar with text-based input
AI Avatar — Speech Input
AI Avatar with speech recognition
AI Avatar — No Code Solution
No-code AI Avatar embed

NextJS

Technical Example
Core API integration with NextJS
Responsive Example
Responsive embed in NextJS
Conversation Example
Multi-portal conversation
AI Avatar — Text Input
AI Avatar with text-based input
AI Avatar — Speech Input
AI Avatar with speech recognition
AI Avatar — No Code Solution
No-code AI Avatar embed

Vue

Technical Example
Core API integration with Vue
Responsive Example
Responsive embed in Vue
Conversation Example
Multi-portal conversation
AI Avatar — Text Input
AI Avatar with text-based input
AI Avatar — Speech Input
AI Avatar with speech recognition
AI Avatar — No Code Solution
No-code AI Avatar embed
Reference

API Function → Example Cross-Reference

Function Category Example(s)
followCursor Animation #14 Cursor Tracking
freezeToggle Animation #15 Facial Movement
recenter Animation #13 Avatar Gaze
setGaze Animation #13 Avatar Gaze
setFacialExpression Animation #16 Facial Expressions
clearExpressionList Animation #16 Facial Expressions
setIdleMovement Animation #15 Facial Movement
setSpeechMovement Animation #15 Facial Movement
setBlinking Animation #17 Blink Frequency
getFPS Animation #33 Frame Rate
setFPS Animation #33 Frame Rate
loadAudio Speech #5 Preload Audio
loadText Speech #6 Preload TTS
sayAudio Speech #1 Pre-Existing Audio, #9 Audio Sequence
sayText Speech #2 TTS Audio, #10 TTS Sequence, #11 Long TTS, #12 Effects
sayAI Speech #34 AI Avatar, #35 AI STT, #36 3rd Party AI, #48 React AI Speech
sayAIResponse Speech #34 AI Avatar
saySilent Speech #8 Silent Speech
setPlayerVolume Speech #7 Audio Volume
stopSpeech Speech #4 Stop & Restart
replay Speech #4 Stop & Restart
getSceneAttributes Scene #22 Scene Attributes
setBackground Scene #19 Background Image
setBackgroundColor Scene #20 Background Color
setColor Scene #18 Avatar Colors
setStatus Scene #3 Playback Queuing, #21 Display Controls
dynamicResize Scene #24 Responsive, #26 Resize 1, #27 Resize 2
getAudioObject Scene #32 Raw Audio Data
is3D Scene #23 Check 3D
overlayOpen Embed #28 Overlay
overlayClose Embed #28 Overlay
loadSceneByID Embed #29 Scene per Portal, #30 Load/Unload, #31 Belated
unloadScene Embed #30 Load/Unload
selectPortal Embed #29 Scene per Portal, #44 Conversation, #45 Conv. + Video
vh_sceneLoaded Callback #37 Callbacks
vh_talkStarted Callback #37 Callbacks
vh_talkEnded Callback #37 Callbacks
vh_audioStarted Callback #37 Callbacks
vh_audioEnded Callback #37 Callbacks
vh_audioError Callback #37 Callbacks
vh_playPause Callback #37 Callbacks
vh_audioProgress Callback #37 Callbacks
vh_aiResponse Callback #37 Callbacks
vh_audioLoaded Callback #37 Callbacks
vh_ttsLoaded Callback #37 Callbacks
vh_portalReady Callback #37 Callbacks