ultron-ai-sdk 1.1.6 → 1.1.8

package/README.md

@@ -24,7 +24,7 @@ npm install ultron-ai-sdk
     let character
     
     const init = async() => {
-        sceneCanvas = new SceneCanvas('target-html-element')
+        sceneCanvas = new SceneCanvas('target-html-element-id')
         const initializationSetting= {
             avatarId: "AVATAR_ID",       // AvatarId and Request Id are same
             config:{
@@ -62,7 +62,7 @@ npm install ultron-ai-sdk
     let character
     
     const init = async() => {
-        sceneCanvas = new SceneCanvas('target-html-element')
+        sceneCanvas = new SceneCanvas('target-html-element-id')
         const initializationSetting= {
             avatarId: "AVATAR_ID",       // AvatarId and Request Id are same
             config:{
@@ -70,9 +70,10 @@ npm install ultron-ai-sdk
                 // sessionId: "SESSION_ID_FOR_CURRENT_USER" // Recomended method for secure access
             },
             options:{
-                hideClickMessage: true  // Remove default "Click message" on the avatar
+                hideClickMessage: true,  // Remove default "Click message" on the avatar
                 alwaysListen: false,    // For Push to talk conversation
-                highFidelityMode: true  // Enables higher graphics quality (can impact performance on low-end devices)
+                highFidelityMode: true,  // Enables higher graphics quality (can impact performance on low-end devices)
+                hideMicButton: false
             }
         }
         await sceneCanvas.init(initializationSetting)
@@ -113,7 +114,7 @@ Check out the sample app git repository: [🔗React SDK Sample](https://github.c
 
 ```html
 
-<div id="target-html-element"></div>
+<div id="target-html-element-id"></div>
 
 ```
 
@@ -123,7 +124,7 @@ Check out the sample app git repository: [🔗React SDK Sample](https://github.c
 
 ```javascript
 
-        let sceneCanvas = new SceneCanvas('target-html-element')
+        let sceneCanvas = new SceneCanvas('target-html-element-id')
         
         await sceneCanvas.init({
             avatarId: "AVATAR_ID",    
@@ -226,23 +227,40 @@ Note: Please use the method above to get session id on your server side for a se
 
 Makes the character listen all the time once click  for continous conversation (voice to voice)
 
-- `alwaysListen`: **Boolean** - The unique identifier for the avatar
+- `alwaysListen`: **Boolean** 
 
 ## Hide default click message
 
 Hides the default text message on the avatar to prompt user to click as an initial click is required for any audio to play in any browser
 
-- `hideClickMessage`: **Boolean** - The unique identifier for the avatar
+- `hideClickMessage`: **Boolean** 
 
 
 ## High Fidelity mode
 
 Enables very high quality renders with better lighting and details, but it will require more performance
 
-- `highFidelityMode`: **Boolean** - The unique identifier for the avatar
+- `highFidelityMode`: **Boolean** 
 
 
-## Core Methods
+## Hide Mic button
+
+Hide the default mic button, This can be use if want to add your own buttons
+
+- `hideMicButton`: **Boolean** 
+
+
+## Show background model
+
+Use this only if you want show a existing background 3D Modal assigned on Ultron Portal
+
+- `showBackgroundModel`: **Boolean** 
+
+
+
+
+
+# Core Methods
 
 ### loadAvatar(avatarId)
 
@@ -328,7 +346,7 @@ ultronSDK.setAudioInputDevice(myDevice.deviceId)
     let character
     
     const init = async() => {
-        sceneCanvas = new SceneCanvas('target-html-element')
+        sceneCanvas = new SceneCanvas('target-html-element-id')
         const initializationSetting= {
             avatarId: "AVATAR_ID/REQUEST_ID",
             config:{
@@ -391,6 +409,33 @@ Set the background image of target html block in which the character is present.
 sceneCanvas.setBackgroundImage('IMAGE_URL')
 
 ```
+Note: If `showBackgroundModel` is set to `true` background image will not be visible
+
+---
+
+### Stop Character 
+
+`stopCurrentSpeaking()` This method stops all the ongoing speaking activity of the Character.
+
+```javascript
+charcater.stopCurrentSpeaking()
+
+```
+
+
+---
+
+### Detect speech completion 
+
+`onSpeakComplete()` this function is called when the character stops speaking.
+
+```javascript
+charcater.onSpeakComplete=()=>{
+    //Do something when character stops speaking
+}
+
+```
+
 
 ---