{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"06d37f0b-f870-4884-9eba-23656b6e8022"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"0e8021aa-ec0e-4c91-bcb3-44717da9a51f"}},{"type":"heading","attrs":{"level":1},"content":[{"text":"Intro","type":"text"}]},{"type":"paragraph","content":[{"text":"The Animaze API enables 3rd party apps to control certain functions (e.g. load avatar) or get certain info (e.g. list of ready to use avatars) of/from the Animaze Desktop application. The API is implemented using a ","type":"text"},{"text":"websocket ","type":"text","marks":[{"type":"strong"}]},{"text":"that exchanges ","type":"text"},{"text":"JSON ","type":"text","marks":[{"type":"strong"}]},{"text":"messages between the Animaze app and 3rd party clients.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"If you are looking into making your app control the avatar’s expressions and body motions, best to look into our ","type":"text"},{"text":"Programmable Tracker","type":"text","marks":[{"type":"link","attrs":{"href":"https://animaze.tv/programmable-tracker"}}]},{"text":", which allows for you to directly retarget your tracking data to the avatar. Read more ","type":"text"},{"text":"here","type":"text","marks":[{"type":"link","attrs":{"href":"https://animaze.tv/programmable-tracker"}}]},{"text":".","type":"text"}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"If you are looking into making your app control the avatar’s body (full body tracking or hands tracking), best to look into using the ","type":"text"},{"text":"VMC protocol","type":"text","marks":[{"type":"link","attrs":{"href":"https://protocol.vmc.info/english"}}]},{"text":", as Animaze supports it. Here is a user-facing guide: ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://animaze.tv/vmc"}}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Setup","type":"text"}]},{"type":"paragraph","content":[{"text":"The Animaze API websocket uses by default ","type":"text"},{"text":"ws://localhost:9000 ","type":"text","marks":[{"type":"strong"}]},{"text":"address.","type":"text"}]},{"type":"paragraph","content":[{"text":"Animaze is not accepting commands by default, so you need to activate the API from Settings > Animaze API > Enabled. The Port number can also be changed from Settings > Animaze API in the Animaze Desktop app.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":313,"id":"1bb30758-5129-46f2-a8a0-261527f3197f","collection":"contentId-157941761","type":"file","height":156}}]},{"type":"paragraph","content":[{"text":"Present and future API settings will reside in Settings > Animaze API, so be sure to check them from time to time.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"The Animaze API supports commands or actions (send a command, receive a response) and in the future will also support triggers, Animaze state changes broadcasted to all clients (e.g. the avatar changed)","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Actions","type":"text"}]},{"type":"paragraph","content":[{"text":"Actions are messages sent to Animaze that describe a specific command that needs to be executed and provide a response.","type":"text"}]},{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Action request example","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"LoadAvatar\", // required by all action messages\n \"id\": \"0E9AA4AE-8C70-4999-BFAE-4D639A3F73E2\", // optional\n \"name\": \"Avatar03\" // required by the \"LoadAvatar\" action\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"An action response will echo the ","type":"text"},{"text":"“action”","type":"text","marks":[{"type":"strong"}]},{"text":" field and ","type":"text"},{"text":"“id“","type":"text","marks":[{"type":"strong"}]},{"text":" field if present (use this to link your original request with it’s response for a better management) and an optional ","type":"text"},{"text":"“error“","type":"text","marks":[{"type":"strong"}]},{"text":" message in case the command failed.","type":"text"}]},{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Action response example","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"LoadAvatar\",\n \"id\": \"0E9AA4AE-8C70-4999-BFAE-4D639A3F73E2\",\n \"error\": \"Avatar not found\"\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Triggers","type":"text"}]},{"type":"paragraph","content":[{"text":"Triggers are messages sent by Animaze to all connected clients with information about state changes initiated by the app.","type":"text"}]},{"type":"paragraph","marks":[{"type":"alignment","attrs":{"align":"center"}}],"content":[{"text":"Trigger example","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"event\": \"AvatarChanged\", // changed state\n \"new_avatar\": \"AvatarBomb\" // state value\n}","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":1},"content":[{"text":"API Reference (Actions)","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Load Avatar","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"LoadAvatar\", // required\n \"id\": // optional (string)\n \"name\": \"Avatar03\" // Avatar name (required by action)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"paragraph","content":[{"text":"same command","type":"text","marks":[{"type":"em"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Load Scene","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"LoadScene\", // required\n \"id\": // optional (string)\n \"name\": \"customization01_scene\" // Scene name (required by action)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"paragraph","content":[{"text":"same command","type":"text","marks":[{"type":"em"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Get Avatars","type":"text"}]},{"type":"paragraph","content":[{"text":"Get the list of ready to use avatars (.avatar files are already on disk).","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetAvatars\", // required (string)\n \"id\": // optional (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetAvatars\", // string\n \"id\": , // string\n \"avatars\": [\"avatar03\", \"AvatarBomb\"] // All available avatars (array) \n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Get Current Avatar Info (available only on next-version branch of Animaze App)","type":"text"}]},{"type":"paragraph","content":[{"text":"Get advanced info on a list of currently loaded avatars. The command returns a list so that it covers the Animaze Rooms scenario where there are multiple avatars spawned.","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n\t\"action\": \"GetCurrentAvatarInfo\", \t// required (string)\n\t\"id\": \"MyDevName\" \t\t\t\t\t// optional (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n\t\"action\": \"GetCurrentAvatarInfo\",\n\t\"avatars\": [{\n\t\t\"animStandard\": \"AnimazeStandard_1_0\",\n\t\t\"description\": \"A spiffy and adorable red panda.\",\n\t\t\"friendlyName\": \"Fluffo\",\n\t\t\"isCustomized\": true,\n\t\t\"itemName\": \"avatar01_BS_Full\",\n\t\t\"itemType\": \"Avatar3D\",\n\t\t\"numProps\": 3,\n\t\t\"props\": [\"crown_king\", \"greenGlasses\", \"headphones\"]\n\t}],\n\t\"id\": \"MyDevName\",\n\t\"numAvatars\": 1\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Get Scenes","type":"text"}]},{"type":"paragraph","content":[{"text":"Get the list of ready-to-use scenes (.avatar files are already on disk).","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetScenes\", // required (string)\n \"id\": // optional (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetScenes\", // string\n \"id\": , // string\n \"scenes\": [\"Spaceship\", \"Stream\"] // All available scenes (array) \n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Get Current Scene Info (available only on next-version branch of Animaze App)","type":"text"}]},{"type":"paragraph","content":[{"text":"Get advanced info on the currently loaded scene.","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n\t\"action\": \"GetCurrentSceneInfo\", \t// required (string)\n\t\"id\": \"MyDevName\" \t\t\t\t\t// optional (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n\t\"action\": \"GetCurrentSceneInfo\",\n\t\"description\": \"A gamer's room.\",\n\t\"friendlyName\": \"The RGB Room\",\n\t\"id\": \"MyDevName\",\n\t\"itemName\": \"RGBRoom\"\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Get Item Icon","type":"text"}]},{"type":"paragraph","content":[{"text":"Get the item’s icon as base64 encoded image. This function works for all Animaze items, such as: avatars, scenes, props, emotes, voice effects, etc.","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetItemIcon\", // required (string)\n \"id\": // optional (string)\n \"name\": \"customization01_scene\" // Works for all animaze items that are present \n // in a gallery: avatars, scenes, props,\n // voice effects, etc (required by action)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetItemIcon\", // string\n \"id\": , // string\n \"image\": \"iVBORw0KGgoAAAANSUhE...\" // base64 encoded image file (string) \n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Get Emotes","type":"text"}]},{"type":"paragraph","content":[{"text":"Get the list of ready to use emotes (.avatar files are already on disk).","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetEmotes\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetEmotes\", // string\n \"emotes\":[{\"friendlyName\":\"Alarm\",\"itemName\":\"Emote_Alarm\"},{\"friendlyName\":\"Angry\",\"itemName\":\"Emote_Angry\"}..] //all available Emotes\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Trigger Emote","type":"text"}]},{"type":"paragraph","content":[{"text":"Triggers an emote","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"TriggerEmote\", // required (string)\n \"itemName\": \"Emote_Alarm\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"paragraph","content":[{"text":"same command","type":"text","marks":[{"type":"em"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Get Special Actions","type":"text"}]},{"type":"paragraph","content":[{"text":"Get the special actions list of the ","type":"text"},{"text":"current ","type":"text","marks":[{"type":"strong"}]},{"text":"avatar","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetSpecialActions\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetSpecialActions\", // string\n {\"action\":\"GetSpecialActions\",\"specialActions\":[{\"animName\":\"Come here\",\"index\":0},{\"animName\":\"Hello\",\"index\":1},..] //list of all special actions for the current avatar\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Trigger Special Action","type":"text"}]},{"type":"paragraph","content":[{"text":"Start a special action on the ","type":"text"},{"text":"current ","type":"text","marks":[{"type":"strong"}]},{"text":"avatar","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"TriggerSpecialAction\", // required (string)\n \"index\": // required (int)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"paragraph","content":[{"text":"same command","type":"text","marks":[{"type":"em"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Get Poses","type":"text"}]},{"type":"paragraph","content":[{"text":"Get the special poses list of the ","type":"text"},{"text":"current ","type":"text","marks":[{"type":"strong"}]},{"text":"avatar","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetPoses\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetPoses\", // string\n {\"action\":\"GetPoses\",\"poseList\":[{\"animName\":\"Puff Cheeks\",\"index\":0},{\"animName\":\"Tongue Out\",\"index\":1}]} //list of all special poses for the current avatar\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Trigger Pose","type":"text"}]},{"type":"paragraph","content":[{"text":"Set the pose for the ","type":"text"},{"text":"current ","type":"text","marks":[{"type":"strong"}]},{"text":"avatar","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"TriggerPose\", // required (string)\n \"index\" : // required (int)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"paragraph","content":[{"text":"same command","type":"text","marks":[{"type":"em"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Get Idle Anims","type":"text"}]},{"type":"paragraph","content":[{"text":"Get the idle animations list of the ","type":"text"},{"text":"current ","type":"text","marks":[{"type":"strong"}]},{"text":"avatar","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetIdleAnims\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetIdleAnims\", // string\n {\"action\":\"GetIdleAnims\",\"idleList\":[{\"animName\":\"Default Idle\",\"index\":0},{\"animName\":\"Bored\",\"index\":2},{\"animName\":\"Fight\",\"index\":3}]} //list of all idle animations for the current avatar\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Trigger Idle","type":"text"}]},{"type":"paragraph","content":[{"text":"Set the idle animations for the ","type":"text"},{"text":"current ","type":"text","marks":[{"type":"strong"}]},{"text":"avatar","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"TriggerIdle\", // required (string)\n \"index\" : // required (int)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"paragraph","content":[{"text":"same command","type":"text","marks":[{"type":"em"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Get Quickscenes","type":"text"}]},{"type":"paragraph","content":[{"text":"Get the ready-to-use Quickscenes list","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetQuickscenes\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetQuickscenes\", // required (string)\n \"quickslots\":[{\"index\":0,\"image\":\"iVBORw0KGgoAAAANSUhE...\"}..] // list of indices and base64 encoded image file (string)\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Load Quickscene","type":"text"}]},{"type":"paragraph","content":[{"text":"Loads the Quickscene","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"LoadQuickscene\", // required (string)\n \"index\" : // required (int)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"paragraph","content":[{"text":"same command","type":"text","marks":[{"type":"em"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Save Quickscene","type":"text"}]},{"type":"paragraph","content":[{"text":"Triggers saving current setup (avatar, scene, camera placement, voice effects, etc.) to be saved as a Quickscene.","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"SaveQuickscene\", // required (string)\n \"index\" : // required (int)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"paragraph","content":[{"text":"same command","type":"text","marks":[{"type":"em"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Calibrate Tracker","type":"text"}]},{"type":"paragraph","content":[{"text":"Trigger Animaze’s tracker calibration function","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"CalibrateTracker\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"paragraph","content":[{"text":"same command","type":"text","marks":[{"type":"em"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Broadcast","type":"text"}]},{"type":"paragraph","content":[{"text":"Enables virtual camera broadcast.","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"Broadcast\", // required (string)\n \"toggle\": // required (bool)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"paragraph","content":[{"text":"same command","type":"text","marks":[{"type":"em"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Set Camera Transform","type":"text"}]},{"type":"paragraph","content":[{"text":"Sets a custom World Space transformation to the render camera. Camera transformation is right-handed (OpenGL).","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"SetCameraTransform\", // required (string)\n \"position\" : [, , ], // required ([float, float, float])\n \"rotation\" : [, , , ] // required ([float, float, float, float]) quaternion\n}\n","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"paragraph","content":[{"text":"same command","type":"text","marks":[{"type":"em"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Get Camera Transform","type":"text"}]},{"type":"paragraph","content":[{"text":"Gets render camera’s World Space Transformation. Camera transformation is right-handed (OpenGL).","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetCameraTransform\" // required (string) \n}\n","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetCameraTransform\", // (string)\n \"position\":[0.0,1.7000000476837158,1.0], // (float, float, float)\n \"rotation\":[0.0,0.0,0.0,1.0] // (float, float, float, float) quaternion\n}","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Set Camera Fov","type":"text"}]},{"type":"paragraph","content":[{"text":"Sets a a new Fov to the render camera. Fov must be given in degrees.","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"SetCameraFov\", // required (string)\n \"fov\" : float // required (float) in degrees \n}\n","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"paragraph","content":[{"text":"same command","type":"text","marks":[{"type":"em"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Get Camera Fov","type":"text"}]},{"type":"paragraph","content":[{"text":"Gets render camera’s Fov","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetCameraFov\" // required (string) \n}\n","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetCameraFov\", // (string)\n \"fov\":60.000003814697266 // (float)\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Set Avatar Transform","type":"text"}]},{"type":"paragraph","content":[{"text":"Sets a custom Word Space transformation to the render camera. Camera transformation is right-handed (OpenGL).","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"SetAvatarTransform\", // required (string)\n \"position\" : [, , ], // required ([float, float, float])\n \"rotation\" : [, , , ], // required ([float, float, float, float]) quaternion\n \"scale\": // required (float)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"paragraph","content":[{"text":"same command","type":"text","marks":[{"type":"em"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Get Avatar Transform","type":"text"}]},{"type":"paragraph","content":[{"text":"Gets render camera’s World Space Transformation. Camera transformation is right-handed (OpenGL).","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetAvatarTransform\" // required (string) \n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetAvatarTransform\", // (string)\n \"position\":[0.0,1.7000000476837158,1.0], // (float, float, float)\n \"rotation\":[0.0,0.0,0.0,1.0], // (float, float, float, float) quaternion\n \"scale\": 1.0 // (float)\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Set Override","type":"text"}]},{"type":"paragraph","content":[{"text":"Activates/deactivates one of the following override behaviors on the current avatar. Parameters are optional:","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Follow Mouse Cursor","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"SetOverride\", // required (string) \n \"behavior\": \"Follow Mouse Cursor\", // required (string)\n \"value\": // required (bool)\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Mouse Keyboard Behavior","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"SetOverride\", // required (string) \n \"behavior\": \"Mouse Keyboard Behavior\", // required (string)\n \"value\": , // required (bool)\n \"keyboardScale\": , // optional (float)\n \"handToKeyboardDist\": , // optional (float)\n \"xAxisOffset\": , // optional (float)\n \"yAxisOffset\": , // optional (float)\n \"zAxisOffset \": // optional (float)\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Tracked Blinking","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"SetOverride\", // required (string) \n \"behavior\": \"Tracked Blinking\", // required (string)\n \"value\": // required (bool)\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Auto Blink","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"SetOverride\", // required (string) \n \"behavior\": \"Auto Blink\", // required (string)\n \"value\": , // required (bool)\n \"frequency\": // optional (float)\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Look At Camera","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"SetOverride\", // required (string) \n \"behavior\": \"Look At Camera\", // required (string)\n \"value\": , // required (bool)\n \"range\": // optional (float)\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Look At Camera Head","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"SetOverride\", // required (string) \n \"behavior\": \"Look At Camera Head\", // required (string)\n \"value\": // required (bool)\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Cross Eyes","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"SetOverride\", // required (string) \n \"behavior\": \"Cross Eyes\", // required (string)\n \"value\": // required (bool)\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Pupil Behavior","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"SetOverride\", // required (string) \n \"behavior\": \"Pupil Behavior\", // required (string)\n \"value\": , // required (bool)\n \"frequency\": // optional (float)\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Forced Symmetry Eyebrows","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"SetOverride\", // required (string) \n \"behavior\": \"Forced Symmetry Eyebrows\", // required (string)\n \"value\": , // required (bool)\n \"range\": // optional (float)\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Forced Symmetry Eyelids","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"SetOverride\", // required (string) \n \"behavior\": \"Forced Symmetry Eyelids\", // required (string)\n \"value\": , // required (bool)\n \"range\": // optional (float)\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Forced Symmetry Mouth","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"SetOverride\", // required (string) \n \"behavior\": \"Forced Symmetry Mouth\", // required (string)\n \"value\": , // required (bool)\n \"range\": // optional (float)\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Enhanced Body Movement 2D","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"SetOverride\", // required (string) \n \"behavior\": \"Enhanced Body Movement 2D\", // required (string)\n \"value\": // required (bool)\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Enhanced Body Movement 3D","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"SetOverride\", // required (string) \n \"behavior\": \"Enhanced Body Movement 3D\", // required (string)\n \"value\": // required (bool)\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Extreme Head Angles Attenuation","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"SetOverride\", // required (string) \n \"behavior\": \"Extreme Head Angles Attenuation\", // required (string)\n \"value\": , // required (bool)\n \"range\": , // optional (float)\n \"maxSmoothingValue\" : // optional (float)\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Sound to Mouth Open","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"SetOverride\", // required (string) \n \"behavior\": \"Sound to Mouth Open\", // required (string)\n \"value\": , // required (bool)\n \"mouthSmoothTme\": , // optional (float)\n \"soundSensitivity\": // optional (float) \n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Alternate lipsync Retargeting","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"SetOverride\", // required (string) \n \"behavior\": \"Alternate lipsync Retargeting\", // required (string)\n \"value\": // required (bool)\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Idle Intensity","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"SetOverride\", // required (string) \n \"behavior\": \"Idle Intensity\", // required (string)\n \"value\": , // required (bool)\n \"intensity\": // optional (float)\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Inferred Body Yaw Movement","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"SetOverride\", // required (string) \n \"behavior\": \"Inferred Body Yaw Movement\", // required (string)\n \"value\": , // required (bool)\n \"neutralZoneSize\": , // optional (float)\n \"movementSmoothing\": , // optional (float)\n \"headYawWeight\": // optional (float)\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Breathing Behavior","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"SetOverride\", // required (string) \n \"behavior\": \"Breathing Behavior\", // required (string)\n \"value\": , // required (bool)\n \"amplitude\": , // optional (float)\n \"frequency\": // optional (float)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"paragraph","content":[{"text":"same command","type":"text","marks":[{"type":"em"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Get Override","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns the status of an override behavior (activated/deactivated) and its current parameters, applied on the current avatar.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Follow Mouse Cursor","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // required (string) \n \"behavior\": \"Follow Mouse Cursor\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // string\n \"behavior\": \"Follow Mouse Cursor\", // string\n \"value\": true/false // bool\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Mouse Keyboard Behavior","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // required (string) \n \"behavior\": \"Mouse Keyboard Behavior\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // string \n \"behavior\": \"Mouse Keyboard Behavior\", // string\n \"value\": true/false, // bool\n \"keyboardScale\": , // float\n \"handToKeyboardDist\": , // float\n \"xAxisOffset\": , // float\n \"yAxisOffset\": , // float\n \"zAxisOffset \": // float\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Tracked Blinking","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // required (string) \n \"behavior\": \"Tracked Blinking\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // string \n \"behavior\": \"Tracked Blinking\", // string\n \"value\": true/false // bool\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Auto Blink","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // required (string) \n \"behavior\": \"Auto Blink\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // string \n \"behavior\": \"Auto Blink\", // string\n \"value\": true/false, // bool\n \"frequency\": // float\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Look At Camera","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // required (string) \n \"behavior\": \"Look At Camera\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // string \n \"behavior\": \"Look At Camera\", // string\n \"value\": true/false, // bool\n \"range\": // float\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Look At Camera Head","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // required (string) \n \"behavior\": \"Look At Camera Head\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // string \n \"behavior\": \"Look At Camera Head\", // string\n \"value\": true/false // bool\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Cross Eyes","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // required (string) \n \"behavior\": \"Cross Eyes\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // string \n \"behavior\": \"Cross Eyes\", // string\n \"value\": true/false // bool\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Pupil Behavior","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // required (string) \n \"behavior\": \"Pupil Behavior\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // string \n \"behavior\": \"Pupil Behavior\", // string\n \"value\": true/false, // bool\n \"frequency\": // float\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Forced Symmetry Eyebrows","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // required (string) \n \"behavior\": \"Forced Symmetry Eyebrows\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // string \n \"behavior\": \"Forced Symmetry Eyebrows\", // string\n \"value\": true/false, // bool\n \"range\": // float\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Forced Symmetry Eyelids","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // required (string) \n \"behavior\": \"Forced Symmetry Eyelids\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // string \n \"behavior\": \"Forced Symmetry Eyelids\", // string\n \"value\": true/false, // bool\n \"range\": // float\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Forced Symmetry Mouth","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // required (string) \n \"behavior\": \"Forced Symmetry Mouth\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // string \n \"behavior\": \"Forced Symmetry Mouth\", // string\n \"value\": true/false, // bool\n \"range\": // float\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Enhanced Body Movement 2D","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // required (string) \n \"behavior\": \"Enhanced Body Movement 2D\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // string \n \"behavior\": \"Enhanced Body Movement 2D\", // string\n \"value\": true/false // bool\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Enhanced Body Movement 3D","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // required (string) \n \"behavior\": \"Enhanced Body Movement 3D\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // string \n \"behavior\": \"Enhanced Body Movement 3D\", // string\n \"value\": true/false // bool\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Extreme Head Angles Attenuation","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // required (string) \n \"behavior\": \"Extreme Head Angles Attenuation\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // string \n \"behavior\": \"Extreme Head Angles Attenuation\", // string\n \"value\": true/false, // bool\n \"range\": , // float\n \"maxSmoothingValue\" : // float\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Sound to Mouth Open","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // required (string) \n \"behavior\": \"Sound to Mouth Open\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // string \n \"behavior\": \"Sound to Mouth Open\", // string\n \"value\": true/false, // bool\n \"mouthSmoothTme\": , // float\n \"soundSensitivity\": // float \n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Alternate lipsync Retargeting","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // required (string) \n \"behavior\": \"\"Alternate lipsync Retargeting\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // string \n \"behavior\": \"Alternate lipsync Retargeting\", // string\n \"value\": true/false // bool\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Idle Intensity","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // required (string) \n \"behavior\": \"Idle Intensity\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // string \n \"behavior\": \"Idle Intensity\", // string\n \"value\": true/false, // bool\n \"intensity\": // float\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"Inferred Body Yaw Movement","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // required (string) \n \"behavior\": \"Inferred Body Yaw Movement\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // string \n \"behavior\": \"Inferred Body Yaw Movement\", // string\n \"value\": true/false, // bool\n \"neutralZoneSize\": , // float\n \"movementSmoothing\": , // float\n \"headYawWeight\": // float\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Breathing Behavior","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // required (string) \n \"behavior\": \"Breathing Behavior\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"GetOverride\", // string \n \"behavior\": \"Breathing Behavior\", // string\n \"value\": true/false, // bool\n \"amplitude\": , // float\n \"frequency\": // float\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Send Message to Animaze ChatPal","type":"text"}]},{"type":"paragraph","content":[{"text":"Send a prompt to Animaze ChatPal, and receive the conversational AI response, while the avatar starts speaking. You can use this command as echo (for the text-to-speech functionality) as well by adding -echo at the start of the “message“ string.","type":"text"}]},{"type":"paragraph","content":[{"text":"Send to Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"ChatbotSendMessage\", // required (string)\n \"id\": , // optional (string)\n \"message\": \"prompt to Animaze Chatpal\" // required (string)\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Receive from Animaze","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"action\": \"ChatbotSendMessage\", // string\n \"response\": \"response from Animaze ChatPal\" // string\n}","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":1},"content":[{"text":"API Reference (Triggers)","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Animaze ChatPal Speech Start/End Events (available only on next-version branch of Animaze App)","type":"text"}]},{"type":"paragraph","content":[{"text":"ChatbotSpeechStarted","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"ChatbotSpeechEnded","type":"text","marks":[{"type":"code"}]},{"text":" events are sent by Animaze when ChatPal agent starts and stops speaking (start and end of audio). These events aren’t extremely accurate and depend on the voice engine, but the error could be that the ","type":"text"},{"text":"ChatbotSpeechStarted","type":"text","marks":[{"type":"code"}]},{"text":" is sent slightly earlier and ","type":"text"},{"text":"ChatbotSpeechEnded","type":"text","marks":[{"type":"code"}]},{"text":" is sent slightly later. Error is empirically determined up to 1 second.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"event\": \"ChatbotSpeechStarted\"\n}","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"event\": \"ChatbotSpeechEnded\"\n}","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":1},"content":[{"text":"Sample","type":"text"}]},{"type":"paragraph","content":[{"text":"You can check out a sample Python script that uses all the available actions at this time. Here’s the archive:","type":"text"}]},{"type":"mediaGroup","content":[{"type":"media","attrs":{"id":"025c4d41-62cd-49cc-bc99-9171ee5abb14","collection":"contentId-157941761","type":"file"}}]},{"type":"paragraph","content":[{"text":"The “AnimazeAPITest.py“ script iterates through all commands in the “commands.json” file and sends them through the websocket.","type":"text"}]},{"type":"paragraph","content":[{"text":"Requirements:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Python 3.11+","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Python modules: websockets","type":"text"}]}]}]}],"version":1}

Browser not supported