Speech & Audio Playback

4
Stop and Restart Speech
stopSpeechreplay
5
Preload Audio
loadAudio
7
Adjust Audio Volume
setPlayerVolume
8
Silent Mock Speech
saySilent
11
Speaking Long TTS Input
sayTextlong input
12
Add Audio Effects to TTS
sayTexteffects

Avatar Control & Animation

13
Control Your Avatar's Gaze
setGazerecenter
15
Control Facial Movement
setIdleMovementsetSpeechMovementfreezeToggle
16
Control Facial Expressions
setFacialExpressionclearExpressionList
17

Scene Appearance

Scene Layout & Embedding

28
Play Audio While Scene is Hidden
dynamicResize sayText stopSpeech
29
Embed Overlay
overlayOpenoverlayClose
30
31
Load and Unload a Scene
loadSceneByIDunloadScene
32
Belated Load Example
loadSceneByIDbelated
33
Access Raw Audio Data
getAudioObject
34
Get / Set Frame Rate
getFPSsetFPS

AI Avatar Integration

Callbacks & Events

39
Using Callbacks
vh_sceneLoadedvh_talkStartedvh_talkEndedvh_audioStartedvh_audioEndedvh_audioErrorvh_playPausevh_audioProgressvh_aiResponsevh_audioLoadedvh_ttsLoadedvh_portalReady

JavaScript Framework Examples

JS Frameworks Embed Guide

Complete reference and best practices for embedding SitePal Avatars in modern JavaScript frameworks.

Open Embed Guide (PDF)

API Function → Example Cross-Reference

Function Category Example(s)
followCursorAnimation#14 Cursor Tracking
freezeToggleAnimation#15 Facial Movement
recenterAnimation#13 Avatar Gaze
setGazeAnimation#13 Avatar Gaze
setFacialExpressionAnimation#16 Facial Expressions
clearExpressionListAnimation#16 Facial Expressions
setIdleMovementAnimation#15 Facial Movement
setSpeechMovementAnimation#15 Facial Movement
setBlinkingAnimation#17 Blink Frequency
getFPSAnimation#34 Frame Rate
setFPSAnimation#34 Frame Rate
loadAudioSpeech#5 Preload Audio
loadTextSpeech#6 Preload TTS
sayAudioSpeech#1 Pre-Existing Audio, #9 Audio Sequence
sayTextSpeech#2 TTS Audio, #10 TTS Sequence, #11 Long TTS, #12 Effects, #28 Hidden Scene
sayAISpeech#35 AI Avatar, #36 AI STT, #37 3rd Party AI, #38 React AI Speech
sayAIResponseSpeech#35 AI Avatar
saySilentSpeech#8 Silent Speech
setPlayerVolumeSpeech#7 Audio Volume
stopSpeechSpeech#4 Stop & Restart, #28 Hidden Scene
replaySpeech#4 Stop & Restart
getSceneAttributesScene#22 Scene Attributes
setBackgroundScene#19 Background Image
setBackgroundColorScene#20 Background Color
setColorScene#18 Avatar Colors
setStatusScene#3 Playback Queuing, #21 Display Controls
dynamicResizeScene#24 Responsive, #26 Resize 1, #27 Resize 2, #28 Hidden Scene
getAudioObjectScene#33 Raw Audio Data
is3DScene#23 Check 3D
overlayOpenEmbed#29 Overlay
overlayCloseEmbed#29 Overlay
loadSceneByIDEmbed#30 Scene per Portal, #31 Load/Unload, #32 Belated
unloadSceneEmbed#31 Load/Unload
selectPortalEmbed#30 Scene per Portal, #46 Conversation, #47 Conv. + Video
vh_sceneLoadedCallback#39 Callbacks
vh_talkStartedCallback#39 Callbacks
vh_talkEndedCallback#39 Callbacks
vh_audioStartedCallback#39 Callbacks
vh_audioEndedCallback#39 Callbacks
vh_audioErrorCallback#39 Callbacks
vh_playPauseCallback#39 Callbacks
vh_audioProgressCallback#39 Callbacks
vh_aiResponseCallback#39 Callbacks
vh_audioLoadedCallback#39 Callbacks
vh_ttsLoadedCallback#39 Callbacks
vh_portalReadyCallback#39 Callbacks