| Documentation
> API Examples
Speech Functions
Speak Pre-Existing AudioInitiate speech of an audio from your account.
Speak Text-To-Speech AudioCreate your text & speak audio and speak it in real time.
Enable/Disable Playback QueingSusequent speech calls can be queued for playback, or not.
Stop and Restart SpeechA simple example demonstrating basic speech controls.
Preload AudioWhen timing is critical, you may want to pre-load your audio.
Preload Text-To-SpeechWhen timing is critical, you may want to pre-load your TTS audio.
Adjust Audio VolumeControl the volume of speech.
Silent Mock SpeechThis can be useful to get users’ attention before audio is enabled.
Overcome the Audio Time LimitPlay multiple audios in sequence, to speak longer or to achieve a tailored message.
Overcoming the TTS Character Limit - Example 1 Overcoming the TTS Character Limit - Example 2Play multiple TTS audios in sequence, to speak a longer text
Using Your Artificial Intelligence BotHow to set up your AI Agent, using the API.
Animation Control Functions
Control Your Character's GazeMake the character look in any direction
Set Your Character’s Cursor TrackingYour character can follow the cursor – you can control how
Control Facial MovementLimit or enhance your character’s facial movements.
Control Facial ExpressionsModify your 3D character’s facial expressions
Control Blink FrequencySet the (average) blink interval, or turn off blinking entirely
Manage Scene Attributes
Modify Your Character’s ColorsUpdate skin, hair, lips and eye color (2D character only)
Update Your Scene’s Background ImageScene background can be modified programmaticly
Modify Your Scene’s Background ColorAffects the color behind the character, and also while loading
Modify Display Settings for Play ControlsUse setStatus to determine when controls are shown
Get Scene AttributesCertain Scene attributes can be read via this API call.
Responsive Design
Responsive EmbedSee Scene responsive behavior when enabling 'Responsive' embed attribute.
Resize Scene Without Reloading It – Example 1This is useful for responsive design
Resize Scene Without Reloading It – Example 2This is useful for responsive design
Events
Using CallbacksCallbacks allow you to synchronize your page with character speech
Miscellaneous
Add Audio Effects to TTSAdd voice filters to your Text-To-Speech audio to create useful effects
Embed OverlayUse the API to show & hide a character embedded over the page (Full Body only)
Check Whether Character is 3DThis can be useful to determine whether facial expressions can be applied.
Navigation Flow Functions
Select Which Scene to Load Into Each PortalWith multiple Scenes on the page, you can control what loads where.
Load and Unload a SceneUse the API to load the Scene, then unload it.
Playback Navigation of Scenes in a ShowDemonstrates show playback navigation – Available for Studio only.
Context Dependent Greeting
Cookie Based MessagingUse cookies to greet visitors with a different message on each subsequent visit
Time Sensitive Greeting – Using TTSGreet your visitors according to the time of day
Time Sensitive Greeting – Using Pre-Recorded AudioGreet your visitors according to the time of day
Time & Day Sensitive GreetingGreet your visitors according to both time & day of the week.
WebRTC Video
WebRTC ExampleImplement real time video delivery using WebRTC
WebRTC Example Using RealTime TTSImplement video delivery using WebRTC, combining real time text input
Other Examples
SitePal ConversationTwo characters have a conversation
SitePal Conversation And Video BackgroundTwo characters chatting in front of video background
Implement Captions for TTS SpeechHow to implement captions using the vh_audioProgress() event
Belated Load ExampleDemonstrating how to use your character in a popup dialog
Simple FAQCreate a “frequently asked questions” implementation
Integrate Speech Recognition with an AI BotHave a chat with your AI Bot via Speech-To-Text (implemented using Web Speech API)
