{"version":1,"pages":[{"id":"pFMIlVh3aGhHqpINgQIU","title":"Welcome","pathname":"/api-docs","siteSpaceId":"sitesp_wqN6M","description":"Start here to create, customize, test, and share interactive AI characters with Convai, covering Playground, no-code experiences, plugins and integrations, and API reference."},{"id":"41Q0qvQwmIZYFETUyYIc","title":"Get Started","pathname":"/api-docs/convai-playground/get-started","siteSpaceId":"sitesp_wqN6M","description":"A guided overview of the first steps in Convai Playground, including navigation, character creation, testing, and essential global controls.","breadcrumbs":[{"label":"Convai Playground"}]},{"id":"pyJBFrVIlYqmEzXGRG74","title":"Dashboard Overview","pathname":"/api-docs/convai-playground/get-started/dashboard-overview","siteSpaceId":"sitesp_wqN6M","description":"Learn how to navigate and use the Convai Playground Dashboard to manage characters, experiences, and simulations efficiently.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Get Started"}]},{"id":"1agb1T1gwGFVdO5CH1P5","title":"Creating a New Character","pathname":"/api-docs/convai-playground/get-started/creating-a-new-character","siteSpaceId":"sitesp_wqN6M","description":"Learn how to create and customize a new AI character in Convai Playground, including description, avatar, voice, and language settings.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Get Started"}]},{"id":"DVUL91wEFtZZ6jBkbHTt","title":"Testing a Character","pathname":"/api-docs/convai-playground/get-started/testing-a-character","siteSpaceId":"sitesp_wqN6M","description":"Learn the different ways to test your AI character in Convai Playground, including text chat, voice input, and video call with an avatar.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Get Started"}]},{"id":"QC1r2g57kZyPjFX2SZzP","title":"Global Character Controls","pathname":"/api-docs/convai-playground/get-started/global-character-controls","siteSpaceId":"sitesp_wqN6M","description":"A single reference for the shared toolbar controls available across all character pages in Convai Playground, including Versioning, Update, and Character Settings.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Get Started"}]},{"id":"x0BSOwHlqiBM9Qw49zui","title":"Character Versioning","pathname":"/api-docs/convai-playground/get-started/character-versioning","siteSpaceId":"sitesp_wqN6M","description":"Manage multiple versions of character and switch between them as required.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Get Started"}]},{"id":"A7G2tHGNEZICB8Hu5zNr","title":"Interact in Voice Mode","pathname":"/api-docs/convai-playground/get-started/interact-in-voice-mode","siteSpaceId":"sitesp_wqN6M","description":"Enable real-time, low-latency voice conversations with your Convai character using Voice Mode for natural, hands-free interactions.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Get Started"}]},{"id":"j4sTdssjBd3tQtEEshBg","title":"Character Customization","pathname":"/api-docs/convai-playground/character-customization","siteSpaceId":"sitesp_wqN6M","description":"Learn how to refine your AI character’s personality, appearance, knowledge, and behavior to create consistent and engaging interactions.","breadcrumbs":[{"label":"Convai Playground"}]},{"id":"izmhrnoQkFUEhckJYF5w","title":"Character Description","pathname":"/api-docs/convai-playground/character-customization/character-description","siteSpaceId":"sitesp_wqN6M","description":"Learn how to use the Character Description page in Convai Playground to define your character’s identity, speaking style, and unique traits.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"xYNqL3nGQ6Yzl0agxI8q","title":"Avatar Studio","pathname":"/api-docs/convai-playground/character-customization/avatar-section","siteSpaceId":"sitesp_wqN6M","description":"Learn how to access and customize your character’s avatar in Convai Playground using Avatar Studio.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"WEKrAcz1SyYUo9EnGJtq","title":"Language And Speech","pathname":"/api-docs/convai-playground/character-customization/language-and-speech","siteSpaceId":"sitesp_wqN6M","description":"Learn how to configure languages, voices, custom pronunciations, and word recognition for your AI character in Convai Playground.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"hoKnTfp2FxSbDLPI6C4k","title":"Knowledge Bank","pathname":"/api-docs/convai-playground/character-customization/knowledge-bank","siteSpaceId":"sitesp_wqN6M","description":"Learn how to upload, manage, and connect knowledge files to your AI character using Knowledge Bank.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"7NqGRdXVakURpzyxcX0S","title":"Personality Traits","pathname":"/api-docs/convai-playground/character-customization/personality-traits","siteSpaceId":"sitesp_wqN6M","description":"Learn how to customize your AI character’s personality using presets or manual trait adjustments.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"zaMRHpXnaDARX9ZGZgO6","title":"Core AI Settings","pathname":"/api-docs/convai-playground/character-customization/core-ai-settings","siteSpaceId":"sitesp_wqN6M","description":"Learn how to configure moderation, foundation model selection, and temperature for your AI character","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"mdYVNsUXIZrtJGq4CcEt","title":"Guardrails","pathname":"/api-docs/convai-playground/character-customization/guardrails","siteSpaceId":"sitesp_wqN6M","description":"The Guardrails tab is a safety and control interface designed to restrict and guide a character's AI behavior. It allows creators to define the ethical and topical boundaries of the conversation.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"euTj9gaXMcDOcoEvKr26","title":"State Of Mind","pathname":"/api-docs/convai-playground/character-customization/state-of-mind","siteSpaceId":"sitesp_wqN6M","description":"Learn how the State of Mind feature visualizes your AI character’s emotional state in real time during conversations.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"aAGm9eZJV0AVSVTsPaov","title":"Memory","pathname":"/api-docs/convai-playground/character-customization/memory","siteSpaceId":"sitesp_wqN6M","description":"Learn how to use the Memory feature to review past sessions, manage conversation history, and enable long-term memory for your character.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"eKYhbAZMbPHYOBWvFWhT","title":"Mindview","pathname":"/api-docs/convai-playground/character-customization/mindview","siteSpaceId":"sitesp_wqN6M","description":"Learn how to use the Mindview feature to review the actual prompts to the LLM for your current or previous sessions and interactions.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"bHvht3CwA8bDmCDcwdcd","title":"Narrative Design | Playground","pathname":"/api-docs/convai-playground/character-customization/narrative-design","siteSpaceId":"sitesp_wqN6M","description":"Build goal‑oriented conversation flows using sections, decisions, and triggers that move the story forward without rigid dialogue trees.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"qf4NbtXNuBVaWaCGbchz","title":"External API","pathname":"/api-docs/convai-playground/character-customization/external-api","siteSpaceId":"sitesp_wqN6M","description":"Learn how to integrate and configure the External API feature to enable your characters to access real-time information, create tasks, and interact with third-party platforms.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"bp1e8yWNdIT26u2PSgBU","title":"Publish","pathname":"/api-docs/convai-playground/character-customization/publish","siteSpaceId":"sitesp_wqN6M","description":"Learn how to publish and share your Convai Experience with the public, selected users, or embed it on your own website.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"TieBWynAKx8Ei5oExSzd","title":"Avatar Studio Experiences","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences","siteSpaceId":"sitesp_wqN6M","description":"Create intelligent 3D AI avatars directly in your browser — no downloads, no code, fully customizable.","breadcrumbs":[{"label":"No Code Experiences"}]},{"id":"r9B8q8s3zXPBKq65TeZ9","title":"Customizing Your Avatar","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar","siteSpaceId":"sitesp_wqN6M","description":"Learn how to visually and behaviorally personalize your Convai avatar using the Avatar Studio configurator.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"}]},{"id":"rnoxZ2yBz6tBkvMluZUT","title":"Configure Avatar","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/configure-avatar","siteSpaceId":"sitesp_wqN6M","description":"Learn how to choose, customize, or upload avatars in Avatar Studio.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"}]},{"id":"3gF4TWlNAR7gdcrwFIfb","title":"Uploading Avatars","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/configure-avatar/uploading-avatars","siteSpaceId":"sitesp_wqN6M","description":"","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"},{"label":"Configure Avatar"}]},{"id":"7RiOQDqXiSshcIxvesJU","title":"Metahuman Avatars","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/configure-avatar/uploading-avatars/metahuman-avatars","siteSpaceId":"sitesp_wqN6M","description":"Upload custom Metahuman characters from Unreal Engine to Avatar Studio using the Convai Asset Uploader.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"},{"label":"Configure Avatar"},{"label":"Uploading Avatars"}]},{"id":"KaEFOuvtwU0O5irCjn9v","title":"Reallusion Avatars","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/configure-avatar/uploading-avatars/reallusion-avatars","siteSpaceId":"sitesp_wqN6M","description":"Upload custom Reallusion characters from Unreal Engine to Avatar Studio using the Convai Asset Uploader.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"},{"label":"Configure Avatar"},{"label":"Uploading Avatars"}]},{"id":"6wQK6C3Tz1gDZ2X7t7gb","title":"Face Filter","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/face-filter","siteSpaceId":"sitesp_wqN6M","description":"Use the Face Filter feature to make your avatar resemble a specific person based on a photo.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"}]},{"id":"Fu7cIEYNH9oHgjdi8qkw","title":"Environment","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/environment","siteSpaceId":"sitesp_wqN6M","description":"Choose from immersive 3D and Solid environments to place your avatar in the right setting.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"}]},{"id":"ja8N9ZC28t5Vc0qixai9","title":"Lighting Adjustments","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/lighting-adjustments","siteSpaceId":"sitesp_wqN6M","description":"","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"}]},{"id":"zN3Zw1qIulaXUdhKi0en","title":"Animation & Expression Settings","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/animation-and-expression-settings","siteSpaceId":"sitesp_wqN6M","description":"Customize your avatar’s expressiveness with facial and body animations, emotions, and intelligent actions.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"}]},{"id":"Ib0U6R37C7GVmnADnE6t","title":"Interface Configuration","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/interface-configuration","siteSpaceId":"sitesp_wqN6M","description":"Tailor the visual and functional interface of your avatar experience to match your device, context, and brand needs.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"}]},{"id":"Bbyq4c05QHG0Lk9HZwGg","title":"Experience Settings","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/experience-settings","siteSpaceId":"sitesp_wqN6M","description":"Control idle session handling, welcome interactions, microphone behavior, and input processing timing to fine-tune your avatar experience.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"}]},{"id":"nqOkXUfzdX6wS0YC2mDI","title":"Publishing an Avatar Studio Experience","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/publishing-an-experience","siteSpaceId":"sitesp_wqN6M","description":"Learn how to publish and share your customized avatar experience for use across web, kiosks, apps, and more.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"}]},{"id":"roLZWRjRZyiRdKUtZIYo","title":"Convai Sim Experiences","pathname":"/api-docs/no-code-experiences/convai-sim-experiences","siteSpaceId":"sitesp_wqN6M","description":"Create AI-powered avatars and deploy them in interactive 3D environments—directly from your browser.","breadcrumbs":[{"label":"No Code Experiences"}]},{"id":"wKIgxvLa1ZFp5chDyXOA","title":"Creating Your AI Simulation with Convai Sim","pathname":"/api-docs/no-code-experiences/convai-sim-experiences/creating-your-ai-simulation-with-convai-sim","siteSpaceId":"sitesp_wqN6M","description":"Bring your Convai characters to life by placing them into 3D interactive environments using Convai Sim","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Convai Sim Experiences"}]},{"id":"lJ3ep46Kfwn6q0IGsBdC","title":"Avatar Customization","pathname":"/api-docs/no-code-experiences/convai-sim-experiences/avatar-customization","siteSpaceId":"sitesp_wqN6M","description":"Fine-tune your deployed avatar’s appearance, size, and position within your 3D simulation scene","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Convai Sim Experiences"}]},{"id":"HYwgAOEKclTWyqt7Arh5","title":"Tour Guide","pathname":"/api-docs/no-code-experiences/convai-sim-experiences/tour-guide","siteSpaceId":"sitesp_wqN6M","description":"Turn your AI avatar into an interactive tour guide using Convai Sim’s built-in tour planning tools","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Convai Sim Experiences"}]},{"id":"Fn1T9S7vnt8W0i6QMnLu","title":"Publishing a Convai Sim Experience","pathname":"/api-docs/no-code-experiences/convai-sim-experiences/publishing-an-experience","siteSpaceId":"sitesp_wqN6M","description":"Learn how to finalize and publish your AI simulation or tour guide experience created with Convai Sim","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Convai Sim Experiences"}]},{"id":"xT1TtWs3Nou8Xf4lE1wL","title":"Convai XR Animation Capture App","pathname":"/api-docs/no-code-experiences/convai-xr-animation-capture-app","siteSpaceId":"sitesp_wqN6M","description":"Capture animations in VR using your Meta Quest and animate AI avatars—no mocap suit required.","breadcrumbs":[{"label":"No Code Experiences"}]},{"id":"QVolyrxHNbjPVss42fT3","title":"Convai XR Animation Capture App Setup","pathname":"/api-docs/no-code-experiences/convai-xr-animation-capture-app/convai-xr-animation-capture-app-setup","siteSpaceId":"sitesp_wqN6M","description":"Learn how to install and connect the Convai XR Animation Capture App on your Meta Quest headset to start recording avatar animations in VR.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Convai XR Animation Capture App"}]},{"id":"AMu3Ygl07F5ShmmygPKG","title":"Creating Animations for AI Avatars","pathname":"/api-docs/no-code-experiences/convai-xr-animation-capture-app/creating-animations-for-ai-avatars","siteSpaceId":"sitesp_wqN6M","description":"Capture lifelike animations using your Meta Quest headset to bring your AI avatars to life—no mocap suit required.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Convai XR Animation Capture App"}]},{"id":"vZgEAxvS8fiQVnhs8mbC","title":"Adding Your Recorded Animations to AI Avatars Inside Unity","pathname":"/api-docs/no-code-experiences/convai-xr-animation-capture-app/adding-your-recorded-animations-to-ai-avatars-inside-unity","siteSpaceId":"sitesp_wqN6M","description":"Learn how to import animations recorded in VR and apply them to your AI avatars in Unity.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Convai XR Animation Capture App"}]},{"id":"22b9b4b526c2c8c38e0131559b94d8ae7778017a","title":"Convai Unity SDK","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk","siteSpaceId":"sitesp_wqN6M","description":"Add real-time AI characters to Unity training simulations, interactive experiences, and games — with speech, emotion, actions, and persistent memory.","breadcrumbs":[{"label":"Plugins & Integrations"}]},{"id":"a3d7afb80b74f02afa29c790d79751f4f29227c8","title":"Convai Unity SDK overview","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/overview","siteSpaceId":"sitesp_wqN6M","description":"Find explanations of what the Convai Unity SDK is, how its four-tier architecture is organized, and what feature modules ship with the package.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"}]},{"id":"3d552fbc704f9580bbec1cc230e2eae41818f025","title":"What is the Convai Unity SDK","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/overview/what-is-the-convai-unity-sdk","siteSpaceId":"sitesp_wqN6M","description":"Real-time conversational AI characters for Unity — voice pipeline, opt-in feature modules, supported platforms, and minimum requirements.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Convai Unity SDK overview"}]},{"id":"E0sHZRYpXvCTPJiLrAH4","title":"Convai Unity SDK architecture","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/overview/convai-unity-sdk-architecture","siteSpaceId":"sitesp_wqN6M","description":"Understand the Convai Unity SDK four-tier architecture — Runtime, Room, Agent, and Module — and the responsibilities of each tier.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Convai Unity SDK overview"}]},{"id":"052c621eeaba9b20d93167f3c9981bf9dc20372f","title":"Feature map","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/overview/feature-map","siteSpaceId":"sitesp_wqN6M","description":"Find the right Convai Unity SDK feature, module, guide, or reference page for any development goal, indexed by use case.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Convai Unity SDK overview"}]},{"id":"ae8k7JCmNIvZyl8ctZ6K","title":"Release notes","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/overview/release-notes","siteSpaceId":"sitesp_wqN6M","description":"Release notes for the Convai Unity SDK — current version highlights, previous release notes, bug fixes, and migration guidance for each release.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Convai Unity SDK overview"}]},{"id":"ijdGXp5AdxHr05KBoBHM","title":"Compatibility and requirements","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/compatibility-and-requirements","siteSpaceId":"sitesp_wqN6M","description":"Find the Unity version, render pipeline, platform, and network requirements you need before installing the Convai Unity SDK.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"}]},{"id":"d270f20a06743da76d0e46e64e17440ad758dad6","title":"Unity versions and render pipelines","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/compatibility-and-requirements/unity-versions-and-render-pipelines","siteSpaceId":"sitesp_wqN6M","description":"Reference for Convai Unity SDK environment requirements, including the minimum Unity version, required package dependencies, and render pipeline support.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Compatibility and requirements"}]},{"id":"e8f8a0a8257efa9a6ff3e80c02b6bdc1224d50fc","title":"Platform support matrix","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/compatibility-and-requirements/platform-support-matrix","siteSpaceId":"sitesp_wqN6M","description":"Reference for Convai Unity SDK platform support, including feature availability across Windows, macOS, Android, iOS, Meta Quest, and WebGL.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Compatibility and requirements"}]},{"id":"451345facd5cd16f0b40e81f6f7a06784935c82b","title":"Network and API requirements","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/compatibility-and-requirements/network-and-api-requirements","siteSpaceId":"sitesp_wqN6M","description":"Reference for Convai Unity SDK network access, including Convai and LiveKit hosts, firewall rules, authentication, and log-based connection checks.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Compatibility and requirements"}]},{"id":"1d9fa274483952ca377014dd2a4fb49c2f3e80a1","title":"Getting started","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started","siteSpaceId":"sitesp_wqN6M","description":"Step-by-step path from installing the Convai Unity SDK to a validated, working conversational AI character in your scene.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"}]},{"id":"9c9a13d2a745ff9a78da0c1790759ba17484a304","title":"Prerequisites","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/prerequisites","siteSpaceId":"sitesp_wqN6M","description":"System requirements, Unity version, required packages, and account prerequisites for the Convai Unity SDK.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"}]},{"id":"f1aef51364acf8a4bf5802a99774c033d9ee6e68","title":"Install the Convai Unity SDK","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/installation","siteSpaceId":"sitesp_wqN6M","description":"Add the Convai Unity SDK to your Unity 2023.1+ project via the Package Manager or Asset Store. Both methods install the identical package.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"}]},{"id":"nLYDmLXfx19u9jY8DiYD","title":"Configure the API key","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/configure-api-key","siteSpaceId":"sitesp_wqN6M","description":"Enter and validate your Convai API key in the SDK Settings window so your Unity project can authenticate and communicate with Convai characters.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"}]},{"id":"41c4fa4e32b4314bedf2eeac4548c536e758ce3f","title":"Import and run sample scenes","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/import-and-run-sample-scenes","siteSpaceId":"sitesp_wqN6M","description":"Import the bundled sample scenes and verify the SDK is installed and connected correctly before building your own scene.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"}]},{"id":"0ovsiZNbY51a9fHPtneG","title":"Scene components reference","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/scene-components","siteSpaceId":"sitesp_wqN6M","description":"Learn the role of ConvaiManager, ConvaiRoomManager, ConvaiCharacter, and ConvaiPlayer, and how they depend on each other.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"}]},{"id":"KM3jUMFCMu4M0nS1MSJH","title":"Build a custom scene","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/build-a-custom-scene","siteSpaceId":"sitesp_wqN6M","description":"Add required Convai components to a new Unity scene using the Setup Required Components command and configure your first character.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"}]},{"id":"35a808a76b0d30cee351c5b850b110058a2eb840","title":"Validate your setup","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/validate-your-setup","siteSpaceId":"sitesp_wqN6M","description":"Run the scene validation tool to confirm all required components are present, connected, and configured correctly.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"}]},{"id":"2532db82ab7e792207320a0655ef32ccfd5f99e4","title":"Configure conversation input mode","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/configure-conversation-input-mode","siteSpaceId":"sitesp_wqN6M","description":"Choose between hands-free voice activation and push-to-talk, and configure the trigger key or button for your project.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"}]},{"id":"MGgUuRj5tRGxy8aDaXHd","title":"Configure character audio","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/configure-character-audio","siteSpaceId":"sitesp_wqN6M","description":"Configure per-character and project-wide voice volume, spatial audio, and audio feedback, and control playback in script with mute and unmute calls.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"}]},{"id":"vzAH1RAH4ciuh2ypEwaO","title":"Configure microphone","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/configure-microphone","siteSpaceId":"sitesp_wqN6M","description":"Select an active microphone device at runtime, set a project-wide default, and configure platform permissions for Android, iOS, and WebGL builds.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"}]},{"id":"3b61dcb812f9a6f38643f1fce0883e718828e8d1","title":"Add chat UI","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/add-chat-ui","siteSpaceId":"sitesp_wqN6M","description":"Add the shipped chat transcript prefab to display scrolling conversation history on screen during character interactions.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"}]},{"id":"96d3c58b6fd5623574443837c77ebcb98c1071e6","title":"Add lip sync","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/add-lip-sync","siteSpaceId":"sitesp_wqN6M","description":"Connect Convai audio output to your character's facial blendshapes, synchronize mouth movement with speech, and tune playback latency.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"}]},{"id":"bWXMsjnl9w0v1XGbrvox","title":"Profiles and mappings","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/add-lip-sync/profiles-and-mappings","siteSpaceId":"sitesp_wqN6M","description":"Reference for the profile and map assets that control how Convai blendshape data reaches your character's face mesh, and when to create custom ones.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"},{"label":"Add lip sync"}]},{"id":"W7KKkYg5RjVc2F3b63Vz","title":"Create a lip sync profile","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/add-lip-sync/create-a-lip-sync-profile","siteSpaceId":"sitesp_wqN6M","description":"Create a ConvaiLipSyncProfile asset to define a custom transport format identifier for blendshape formats beyond the three bundled profiles.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"},{"label":"Add lip sync"}]},{"id":"dZnu5jciNDbTRscNenck","title":"Create a custom lip sync map","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/add-lip-sync/create-a-custom-blendshape-map","siteSpaceId":"sitesp_wqN6M","description":"Create a lip sync map that routes incoming blendshape channels to your character's mesh, with per-channel weight and clamp tuning.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"},{"label":"Add lip sync"}]},{"id":"oXL608mEMdrEEudHoaSJ","title":"AI coding assistant","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/ai-coding-assistant","siteSpaceId":"sitesp_wqN6M","description":"Find guides for connecting AI coding agents to Unity through Convai's SDK-aware MCP tools, including setup, supported agents, and troubleshooting.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"}]},{"id":"z66YD8D1BvUpEXCOjXz9","title":"AI coding assistant quick start","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/ai-coding-assistant/quick-start","siteSpaceId":"sitesp_wqN6M","description":"Open AI Coding Setup, accept the Unity MCP terms, install a coding agent's instructions, and verify Convai's MCP tools are ready.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"AI coding assistant"}]},{"id":"4fzoj3RtQTbbG69I9A9p","title":"Supported coding agents","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/ai-coding-assistant/supported-coding-agents","siteSpaceId":"sitesp_wqN6M","description":"Reference for the coding agents the Convai Unity SDK supports, including the exact instruction file path and install behavior for each agent.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"AI coding assistant"}]},{"id":"Gd4pCWmZTgamoBbmr0R2","title":"MCP tools reference","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/ai-coding-assistant/mcp-tools-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for every Convai MCP tool exposed to a coding agent, including default enablement and scene-mutation behavior.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"AI coding assistant"}]},{"id":"6KguvwDVvWMYC4R123tO","title":"Troubleshoot AI coding assistant setup","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/ai-coding-assistant/troubleshooting","siteSpaceId":"sitesp_wqN6M","description":"Diagnose and fix Unity MCP bridge reconnects, tool registry refreshes, stale tool rejections, and Unity AI Assistant install failures in the Convai Unity SDK.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"AI coding assistant"}]},{"id":"e324eb9293dfc478fb2c227def03dca5d44cc512","title":"Core concepts","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/core-concepts","siteSpaceId":"sitesp_wqN6M","description":"Find explanations for how the Convai Unity SDK works at runtime — connection management, session state, turn-taking, and event-driven scene responses.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"}]},{"id":"LV9IsLoeHhBA2EovBKod","title":"Runtime architecture","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/core-concepts/runtime-architecture","siteSpaceId":"sitesp_wqN6M","description":"Understand the four-layer Convai Unity SDK runtime — what each layer owns, which components are replaceable, and how RuntimeState transitions are managed.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Core concepts"}]},{"id":"TvL9WjMsqfa9XQdTFSUo","title":"Session lifecycle","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/core-concepts/session-lifecycle","siteSpaceId":"sitesp_wqN6M","description":"Understand how ConvaiCharacter sessions transition through states, where session IDs are stored, and how to configure reconnection and conversation-resume behavior.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Core concepts"}]},{"id":"b9e67d1d27aaccf9e9bc9b260045411047aa37c3","title":"Turn-taking modes","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/core-concepts/turn-taking-modes","siteSpaceId":"sitesp_wqN6M","description":"Reference for TurnTakingOptions, SmartTurnSettings, and PushToTalkPolicy — field reference for hands-free voice detection and push-to-talk modes.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Core concepts"}]},{"id":"pbfCCar59Jtf59bTd3Bh","title":"Voice activity detection","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/core-concepts/voice-activity-detection","siteSpaceId":"sitesp_wqN6M","description":"Understand how the Convai Unity SDK resolves user voice activity detection settings once, at connect time, using either Convai's defaults or your custom values.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Core concepts"}]},{"id":"bcd284a409f00820e1693ab998dc7a99a4fbd780","title":"Event system","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/core-concepts/event-system","siteSpaceId":"sitesp_wqN6M","description":"Reference for Convai event relay components, including available events, payload fields, and subscription patterns for scene logic.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Core concepts"}]},{"id":"d5302389270319f4ca9bf82b6b3081d22b81bd8f","title":"Features","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features","siteSpaceId":"sitesp_wqN6M","description":"","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"}]},{"id":"8e2d39906eb40512aa9c4c6b05ffc3352eb87e51","title":"Character actions","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions","siteSpaceId":"sitesp_wqN6M","description":"Find quick-start guides, executor references, dispatcher configuration, scripting API, and usage examples for the Convai character actions system.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"}]},{"id":"mqkxc4D6OCQA9OVVDCLv","title":"How character actions work","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/how-character-actions-work","siteSpaceId":"sitesp_wqN6M","description":"Understand the Convai character actions pipeline — how the backend selects actions, how Unity resolves targets, and which components are required.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Character actions"}]},{"id":"M9Lh8OZ24Oqv9SmxMjzb","title":"Character actions quick start","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/quick-start","siteSpaceId":"sitesp_wqN6M","description":"Wire up a working Move To action for your NPC entirely through the Inspector, with no scripting required, and confirm it runs in Play Mode.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Character actions"}]},{"id":"u3JAohXiqBNMG6zZ5m60","title":"Configure character actions","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/configuring-actions","siteSpaceId":"sitesp_wqN6M","description":"Configure which actions, objects, and characters a Convai NPC can use, then update those affordances during an active session.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Character actions"}]},{"id":"KujMCkE0oVyqYjXPi4UQ","title":"Update character actions at runtime","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/update-actions-at-runtime","siteSpaceId":"sitesp_wqN6M","description":"Send an action configuration patch mid-session, track its update ID, and confirm the backend's acknowledgement before assuming the change applied.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Character actions"}]},{"id":"6RYF3LHemCYzxRfZpueZ","title":"Action executors","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/action-executors","siteSpaceId":"sitesp_wqN6M","description":"Reference for all seven action executor components — look-at, event, NavMesh movement, animation trigger, and compound pickup/placement executors.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Character actions"}]},{"id":"yKmOPjUYIRCR4eqPYD0A","title":"Write a custom action executor","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/writing-custom-executors","siteSpaceId":"sitesp_wqN6M","description":"Connect custom movement, inventory, UI, or physics behaviors to the Convai action pipeline by writing your own executor component.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Character actions"}]},{"id":"L2RNE4SlLqEb39SpjbDU","title":"Dispatcher and batch policies","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/dispatcher-and-batch-policies","siteSpaceId":"sitesp_wqN6M","description":"Configure the dispatcher's batch policy, failure policy, speech gate timeout, and lifecycle events for character action execution.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Character actions"}]},{"id":"RKSqmXPbQonS4iJeIfiO","title":"Attention and reference grounding","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/attention-and-reference-grounding","siteSpaceId":"sitesp_wqN6M","description":"Update NPC focus at runtime so Convai resolves vague player references such as \"pick that up\" or \"go to it\" to the correct registered scene object.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Character actions"}]},{"id":"73HufYIPX0JRnnAsGDbk","title":"Character actions scripting reference","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/actions-scripting-reference","siteSpaceId":"sitesp_wqN6M","description":"API reference for the Convai character actions system — dispatcher types, executor interface, config classes, invocation objects, result types, and enums.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Character actions"}]},{"id":"f7muso7lrEOfJU9hnYeK","title":"Character actions examples","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Progressive examples for the Convai character actions system — Inspector setup, event subscriptions, scripted batch injection, and speech-synced timing.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Character actions"}]},{"id":"LZcDaILUbaCK85OVcPJ6","title":"Troubleshoot character actions","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/debugging-and-troubleshooting","siteSpaceId":"sitesp_wqN6M","description":"Diagnose character action pipeline and runtime state issues using two debug tools, with a complete symptom, cause, and fix reference for common failures.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Character actions"}]},{"id":"HLRHVibG6Nqvot1DGfvc","title":"Dynamic context","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context","siteSpaceId":"sitesp_wqN6M","description":"Find guides for sending live scene state to Convai characters through the dynamic context relay, scripting API, and synced world-object properties.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"}]},{"id":"Oyh83QIsfM02w8hOnerK","title":"How dynamic context works","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/how-dynamic-context-works","siteSpaceId":"sitesp_wqN6M","description":"Understand how Dynamic Context tracks scene state and events, batches updates, and reports acknowledgement and token feedback.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"c83fd507c05d6353540d730017d6b1681c7bb60d","title":"Dynamic context quick start","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/dynamic-context-quick-start","siteSpaceId":"sitesp_wqN6M","description":"Add a Dynamic Context Relay component to an NPC, send a tracked update from a UI button, and confirm the character references it.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"tCnCpnGAXfuegK7SIPBn","title":"Relay component reference","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/relay-component-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for the Dynamic Context relay component, covering its Inspector fields, public methods, events, and character resolution behavior.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"wuITWZtDYpGKPOC2GUTI","title":"Static context at connection time","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/static-context-at-connection-time","siteSpaceId":"sitesp_wqN6M","description":"Configure fixed scenario facts a character receives once at the start of a conversation, separate from updates sent while the conversation is running.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"jLDVtNvrQQtepjrSEeAv","title":"Sync behavior and timing","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/sync-behavior-and-timing","siteSpaceId":"sitesp_wqN6M","description":"Understand how the SDK batches dynamic context updates before sending them and how action and attention changes are confirmed by Convai.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"Pwb170m39yjzkfAghzLG","title":"Dynamic context scripting API","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/dynamic-context-scripting-api","siteSpaceId":"sitesp_wqN6M","description":"Reference for the Convai Unity SDK dynamic context scripting interface, including every method, the respond mode enum, and the attention object API.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"3UWNhGolZFLe1BduX0bt","title":"Dynamic context usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/dynamic-context-usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Five Dynamic Context examples show a relay-driven trigger, a batched update, an event log, an emergency transition, and synced world-object context.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"7ij66qcsYVpiLPUZFGvh","title":"Troubleshoot dynamic context","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/troubleshoot-dynamic-context","siteSpaceId":"sitesp_wqN6M","description":"Fix common dynamic context problems in the Convai Unity SDK, including missed updates, delayed responses, and reset behavior that does not clear everything.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"pzyAnwgRmeSToQBXFJYu","title":"Emotion","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion","siteSpaceId":"sitesp_wqN6M","description":"Find guides for adding emotionally responsive facial animation to Convai characters — from quick setup to scripting API and troubleshooting.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"}]},{"id":"VKDUIdxDSqYZKjcrf1FW","title":"How the emotion system works","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion/how-the-emotion-system-works","siteSpaceId":"sitesp_wqN6M","description":"Understand the emotion pipeline — how Convai sends emotion signals, how the SDK resolves and smooths them, and which components to place and where.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Emotion"}]},{"id":"PyOgkztYoFXIQ0l3uTfN","title":"Emotion quick start","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion/quick-start","siteSpaceId":"sitesp_wqN6M","description":"Build a working emotion pipeline on a Convai NPC — attach the Emotion Controller, assign the bundled sample profile, and verify expressions in Play Mode.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Emotion"}]},{"id":"4kPK7vkbjtuDa9qfc75O","title":"Emotion profile","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion/emotion-profile","siteSpaceId":"sitesp_wqN6M","description":"Reference for ConvaiEmotionProfile, including smoothing speed, micro-burst settings, neutral alternation, and output binding configuration.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Emotion"}]},{"id":"mqwNGzveKocvvR9sOhts","title":"Emotion output bindings","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion/output-bindings","siteSpaceId":"sitesp_wqN6M","description":"Reference for EmotionSlotBinding and the two binding types — field ranges, weight calculation, isMouthShape routing, and the pre-built slot factory.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Emotion"}]},{"id":"FOiJ57aQtQ6qN404z3rE","title":"Emotion taxonomy","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion/emotion-taxonomy","siteSpaceId":"sitesp_wqN6M","description":"Reference for EmotionTaxonomyAsset, including the built-in Plutchik set, server alias resolution, and custom taxonomy authoring.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Emotion"}]},{"id":"OM0Nzbb46ldsnhmYvu6a","title":"Emotion scripting API","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion/scripting-api","siteSpaceId":"sitesp_wqN6M","description":"Reference for the emotion scripting surface — ConvaiEmotionController, EmotionReading, override and lock methods, C# events, and IEmotionStateSource.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Emotion"}]},{"id":"5Bo6oC1qF0jfrzgrtD56","title":"Emotion examples","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion/usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Six complete scenarios covering hazard overrides, locked expressions, distress branching, analytics logging, no-code UI wiring, and Editor authoring.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Emotion"}]},{"id":"N6zov1sJHXMKI44gRL56","title":"Troubleshoot emotion","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion/troubleshooting-and-diagnostics","siteSpaceId":"sitesp_wqN6M","description":"Fix common emotion pipeline failures in the Convai Unity SDK — from missing output and silent neutral fallback to LipSync conflicts and locked expressions.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Emotion"}]},{"id":"Yg6rMK5Mnh9zStBOwoca","title":"Long-term memory","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory","siteSpaceId":"sitesp_wqN6M","description":"Find all long-term memory guides — enable memory on characters, manage user identity, use the memory API, and access the scripting reference.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"}]},{"id":"vmFTDbOMYC0TTWNIC7Nw","title":"How long-term memory works","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/how-long-term-memory-works","siteSpaceId":"sitesp_wqN6M","description":"Understand the long-term memory session lifecycle, how memory is scoped by user and character, and how facts are extracted, deduplicated, and injected.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"jhH0HpubiAmSHgHB5acq","title":"Long-term memory quick start","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/quick-start","siteSpaceId":"sitesp_wqN6M","description":"Enable Long-Term Memory for a Convai character and verify cross-session recall in the Unity Editor in three steps.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"lG0GNEfMD5jvoHOjCCax","title":"Configure memory for a character","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/configure-memory-for-a-character","siteSpaceId":"sitesp_wqN6M","description":"Toggle Long-Term Memory on or off per character via the Convai dashboard or the CharacterService scripting API, and understand the global scope implications.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"GQgbZSFMOcRCBLwo1vqX","title":"End-user identity","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/end-user-identity","siteSpaceId":"sitesp_wqN6M","description":"Understand how the SDK identifies users for long-term memory scoping and how to implement a custom authentication-backed identity provider.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"09sxltM2pYC5cl7evTls","title":"Manage end-user records","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/end-user-management","siteSpaceId":"sitesp_wqN6M","description":"Browse and manage end-user records from the Convai Configuration Window or via the EndUsersService scripting API — covers the editor tool, all four methods, and pagination.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"3GS4gHtc1oXVknBcIakW","title":"Memory management API","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/memory-management-api","siteSpaceId":"sitesp_wqN6M","description":"Use ConvaiRestClient.Memory to list, add, retrieve, and delete memory records for a user–character pair — includes setup, all five methods, response types, and error handling.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"rNXGHpGQBdg9YBcHJ3hR","title":"Long-term memory scripting reference","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/long-term-memory-scripting-reference","siteSpaceId":"sitesp_wqN6M","description":"Complete API reference for ConvaiRestClient.Memory and ConvaiRestClient.EndUsers — all method signatures, parameters, return types, identity interfaces, and data models.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"k71sbCPyoe2SjjSKXPAv","title":"Long-term memory usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Four complete long-term memory patterns for Unity — zero-config persistence, authenticated identity, memory seeding, and memory reset.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"ljp5Ye0OhKTKJVYgfM50","title":"Troubleshoot long-term memory","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/troubleshooting-and-diagnostics","siteSpaceId":"sitesp_wqN6M","description":"Diagnose why long-term memory isn't persisting, verify end-user identity stability across sessions, and resolve Memory Management API HTTP errors.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"vN4t84KHA949ufTTNaVd","title":"Narrative design","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design","siteSpaceId":"sitesp_wqN6M","description":"Find guides for setting up, configuring, scripting, and troubleshooting the Narrative Design system in the Convai Unity SDK.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"}]},{"id":"xq1fYsxzZSvmTVHhAuzP","title":"How narrative design works","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design/how-narrative-design-works","siteSpaceId":"sitesp_wqN6M","description":"Understand the Narrative Design pipeline — how sections, triggers, and template keys connect at runtime to advance a story graph.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"bKLk8evl0rKJoAJVLBDc","title":"Narrative design quick start","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design/quick-start","siteSpaceId":"sitesp_wqN6M","description":"Add a Narrative Design Manager and a collision trigger to a Convai character and confirm a section change in Play Mode — no code required.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"kZqgIdGNMRTi9mAsEy9T","title":"Configure the narrative design manager","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design/setting-up-the-narrative-design-manager","siteSpaceId":"sitesp_wqN6M","description":"Add and configure ConvaiNarrativeDesignManager on a character, sync sections from Convai, and wire per-section Unity Events in the Inspector.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"TN48vuadtxlKi07jDDXf","title":"Configure narrative design triggers","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design/setting-up-narrative-design-triggers","siteSpaceId":"sitesp_wqN6M","description":"Configure ConvaiNarrativeDesignTrigger to advance the narrative graph using collision, proximity, time-based, or manual activation modes.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"GGAj3nmRIj3JmjXWgn9u","title":"Configure narrative template keys","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design/template-keys-dynamic-narrative-variables","siteSpaceId":"sitesp_wqN6M","description":"Set narrative template keys so a Convai character can reference runtime values — player name, scenario parameters, or session state — in its objectives.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"ShMEkDz5iXv32f3SAnZ6","title":"Narrative design scripting reference","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design/scripting-narrative-design","siteSpaceId":"sitesp_wqN6M","description":"Reference for controlling a character's narrative flow from code, covering section events, trigger invocation, scripted speech, and data fetching.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"P5OgJto88LWqfhKMP4eD","title":"Narrative design usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design/usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Four worked Narrative Design examples from a single-trigger welcome sequence to an adaptive multi-section scenario with dynamic feedback.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"aqms53VNdK2b217bHljp","title":"Troubleshoot narrative design","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design/troubleshooting-and-diagnostics","siteSpaceId":"sitesp_wqN6M","description":"Resolve trigger status failures, Inspector misconfigurations, fetch errors, and queue timeouts using built-in validation and diagnostic tools.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"a62866eb2b9826eb452e50eb8875192eb2464f3c","title":"Scene metadata","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/scene-metadata","siteSpaceId":"sitesp_wqN6M","description":"Find guides, component reference, and examples for Scene Metadata — the feature that gives Convai characters awareness of objects in your Unity scene.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"}]},{"id":"KwecfeB1C1fimjgaLENp","title":"How scene metadata works","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/scene-metadata/how-scene-metadata-works","siteSpaceId":"sitesp_wqN6M","description":"Understand the registration and delivery flow for scene object metadata, and learn when to use Scene Metadata versus Dynamic Context.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Scene metadata"}]},{"id":"b21526ee9b2c1ed58e407fc454da6b3bd057905a","title":"Scene metadata quick start","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/scene-metadata/quick-start","siteSpaceId":"sitesp_wqN6M","description":"Add object awareness to a Unity scene so a Convai character can reference named objects in conversation from the moment it connects.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Scene metadata"}]},{"id":"cb67fd355a439e2cf54faaa44dd018f205299a93","title":"Scene metadata component reference","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/scene-metadata/component-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for the two components that describe scene objects to Convai and expose their live tracked state, including Inspector fields and lifecycle.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Scene metadata"}]},{"id":"aa4f25375b3961f18138e4a75710532316656e63","title":"Scene metadata scripting API","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/scene-metadata/scripting-api-reference","siteSpaceId":"sitesp_wqN6M","description":"Complete C# reference for Scene Metadata's classes, covering object properties, tracked-property updates, registry queries, and manual send triggers.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Scene metadata"}]},{"id":"c47675608acf86e70caf6c8b756d2be389006162","title":"Scene metadata usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/scene-metadata/usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Complete Scene Metadata setups for medical training, industrial drills, museum guides, runtime object updates, and tracked property state.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Scene metadata"}]},{"id":"66fddc4b0f911e97d589403a45f3ae569eb83b5d","title":"Troubleshoot scene metadata","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/scene-metadata/troubleshooting-and-diagnostics","siteSpaceId":"sitesp_wqN6M","description":"Fix scene metadata problems including empty payloads, missing collection logs, dependency injection failures, and AI characters ignoring scene objects.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Scene metadata"}]},{"id":"c776d88f01e63c32eee310e37d0ed10bc12eb355","title":"Vision","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision","siteSpaceId":"sitesp_wqN6M","description":"Find guides for adding real-time scene vision to Convai characters in Unity, including frame sources, publish policies, scripting, and troubleshooting.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"}]},{"id":"l8e8VHFqAfizSNNTRxLW","title":"How vision works","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/how-vision-works","siteSpaceId":"sitesp_wqN6M","description":"Understand the Vision pipeline architecture, including frame sources, publish policy, the WebRTC track to Convai, and how dynamic vision context fits in.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Vision"}]},{"id":"WDQCR3FaRn8g7peekArL","title":"Dynamic vision context","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/dynamic-vision-context","siteSpaceId":"sitesp_wqN6M","description":"Reference for the dynamic vision context types that configure backend-driven camera frame sampling and per-lane respond-mode defaults.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Vision"}]},{"id":"XSaPw0kFVyXD2NbMU5k2","title":"Vision quick start","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/quick-start","siteSpaceId":"sitesp_wqN6M","description":"Add Vision to an existing Convai scene so a character can see and respond to live camera input, using the SDK's automatic component setup.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Vision"}]},{"id":"ae0edd0be3d5b82330547283ee17259071673848","title":"Vision frame sources","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/frame-sources","siteSpaceId":"sitesp_wqN6M","description":"Reference for CameraVisionFrameSource, WebcamVisionFrameSource, and QuestVisionFrameSource, including Inspector fields, capture presets, and platform support.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Vision"}]},{"id":"8e81321c92ed2b28e658ae5686d3cac89efa9213","title":"Publish policies","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/publishing-and-policies","siteSpaceId":"sitesp_wqN6M","description":"Reference for Vision publish policies, including FPS and bitrate budgets, runtime control methods, auto-publish behavior, and WebGL-specific behavior.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Vision"}]},{"id":"eP36iBni1AamThCZdCLM","title":"Vision debug preview","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/debug-preview","siteSpaceId":"sitesp_wqN6M","description":"Verify the vision camera feed and confirm that vision status requests and triggers reach Convai using Unity Editor debug tools.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Vision"}]},{"id":"a605ab5aa55eec202ad6748667a5629e34141045","title":"Custom frame sources","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/custom-frame-sources","siteSpaceId":"sitesp_wqN6M","description":"Implement IVisionFrameSource to publish a custom video pipeline to Convai, including the Y-flip requirement, lifecycle state pattern, and auto-discovery rules.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Vision"}]},{"id":"35fce4a7255d7ee06c08b0cc4b37b598f89f6068","title":"Vision scripting API","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/scripting-api","siteSpaceId":"sitesp_wqN6M","description":"Reference for the Convai Unity SDK vision scripting API, including publish control, runtime status queries, on-demand triggers, and respond-mode events.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Vision"}]},{"id":"A2LuvcFg2YlW1OiZkeEV","title":"Vision usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Find code patterns for common Vision setups, including safety training, webcam selection, look-at activation, on-demand triggers, and WebGL deployment.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Vision"}]},{"id":"nydFtT4kGp2HzURUi5L5","title":"Troubleshoot vision","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/troubleshooting-and-diagnostics","siteSpaceId":"sitesp_wqN6M","description":"Fix Vision publishing failures, blank feeds, permission errors, and platform-specific issues in Unity using a structured checklist and decision tree.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Vision"}]},{"id":"1d9a66db894bd027727ec456c7ba69d7696ce43c","title":"Utilities","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities","siteSpaceId":"sitesp_wqN6M","description":"Opt-in presentation modules that enhance character animation, eye tracking, and head movement — running entirely in Unity with no data sent to Convai.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"}]},{"id":"e7963b2cdbdecc024efd724f61855cea3fab1ea9","title":"Dialogue Animation","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation","siteSpaceId":"sitesp_wqN6M","description":"Drive body and head gesture animation from dialogue state and emotion using a pooled clip library and an AnimatorOverrideController — no per-clip animator states required.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"}]},{"id":"PUogHoj0NzoSUeYvrPHG","title":"How Dialogue Animation works","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation/how-dialogue-animation-works","siteSpaceId":"sitesp_wqN6M","description":"Understand how Dialogue Animation selects clips, drives the four-layer animator stack, and uses emotion and dialogue state to animate AI characters.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Dialogue Animation"}]},{"id":"d426f4256a6e1f6125be8f4b95380e63040b0ad8","title":"Dialogue Animation quick start","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation/quick-start","siteSpaceId":"sitesp_wqN6M","description":"Add ConvaiDialogueAnimationController to a character, assign a library and runtime config, and verify gesture animation in Play Mode.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Dialogue Animation"}]},{"id":"qPHprAmwjoclwLCbma19","title":"Animation libraries and profiles","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation/animation-libraries-and-profiles","siteSpaceId":"sitesp_wqN6M","description":"Complete field reference for all Dialogue Animation ScriptableObject assets — library, clip entries, runtime config, and bundled profiles.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Dialogue Animation"}]},{"id":"rexsr9WEf5LaEqGfromC","title":"Animator Controller requirements","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation/animator-controller-requirements","siteSpaceId":"sitesp_wqN6M","description":"Dialogue Animation Animator Controller contract — required layer structure, state names, placeholder clip names, and DialogueAnimatorContract fields.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Dialogue Animation"}]},{"id":"b8VTVWXZAZp2TSqTLyKK","title":"Build a compatible Animator Controller","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation/animator-controller-setup","siteSpaceId":"sitesp_wqN6M","description":"Build a compatible four-layer Animator Controller from scratch so the Dialogue Animation module can inject and swap gesture clips at runtime.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Dialogue Animation"}]},{"id":"e7ea454fb7376765b1f7a8b97e873070ac4737e1","title":"Dialogue Animation usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation/usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Four progressive examples — from Inspector-only setup to runtime library swapping — covering training, medical, corporate, and adaptive assessment scenarios.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Dialogue Animation"}]},{"id":"9a94177eabc282ee3f3c5ea48a63fc768dca0453","title":"Dialogue Animation scripting API","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation/scripting-api","siteSpaceId":"sitesp_wqN6M","description":"Runtime scripting reference for ConvaiDialogueAnimationController — swap libraries and configs at runtime, and read current layer weights and clip selection state.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Dialogue Animation"}]},{"id":"53c2015ebf2f2d7e04074279408d7cbacde002e8","title":"Dialogue Animation troubleshooting","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation/troubleshooting","siteSpaceId":"sitesp_wqN6M","description":"Symptom-driven fixes for silent talk layers, missing animations, clip snapping, layer index errors, and speech energy issues in the Dialogue Animation module.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Dialogue Animation"}]},{"id":"64f87fbb4fb6aa685a57fa969e6b5253c7ee2246","title":"Gaze and Attention","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/gaze-and-attention","siteSpaceId":"sitesp_wqN6M","description":"Two-system pipeline for natural eye and head behavior — Attention selects focus targets, Gaze drives procedural eye tracking, head rotation, saccades, and blinks.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"}]},{"id":"zUCenpeFJGFhW3yhHOQV","title":"How Gaze and Attention works","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/gaze-and-attention/how-gaze-and-attention-works","siteSpaceId":"sitesp_wqN6M","description":"Understand the two-layer pipeline where Attention selects focus targets and Gaze drives procedural eye tracking, head rotation, and saccades.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Gaze and Attention"}]},{"id":"8db0a7c73598ac534a4c40ffac06ec94256588a3","title":"Gaze and Attention quick start","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/gaze-and-attention/quick-start","siteSpaceId":"sitesp_wqN6M","description":"Add ConvaiAttentionController, ConvaiEyeGazeActuator, and ConvaiHeadLookActuator to a character, assign profiles, and verify eye and head tracking in Play Mode.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Gaze and Attention"}]},{"id":"bdf689d789a4f88bf1d26ce6d354d98074cfd771","title":"Attention and gaze profiles","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/gaze-and-attention/profiles-and-tuning","siteSpaceId":"sitesp_wqN6M","description":"Complete field reference for all four gaze profile ScriptableObjects — attention timing, gaze coordination, eye behavior, and head rotation.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Gaze and Attention"}]},{"id":"4485b09fb5be00f7295b696c5de8687d4a80c779","title":"Gaze and Attention usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/gaze-and-attention/usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Four progressive examples of Gaze & Attention configuration — from basic Inspector setup to custom IFocusTargetProvider implementations and attention profile tuning.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Gaze and Attention"}]},{"id":"0f74068e38a6f78390e41d0506de247f8d68516e","title":"Gaze and Attention scripting API","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/gaze-and-attention/scripting-api","siteSpaceId":"sitesp_wqN6M","description":"Runtime scripting reference for ConvaiAttentionController, AttentionReading, IFocusTargetProvider, ConvaiGazeCoordinator, and GazeIntent.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Gaze and Attention"}]},{"id":"b50c3bd12a4412920ecbcc86ebf1d36dec758689","title":"Gaze and Attention troubleshooting","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/gaze-and-attention/troubleshooting","siteSpaceId":"sitesp_wqN6M","description":"Fixes for the 13 most common Gaze & Attention issues — static eyes, frozen head, eyelid clipping, attention not targeting, and focus provider conflicts.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Gaze and Attention"}]},{"id":"26837dafaf3d20063e1664f52a690823bbbb0eb7","title":"UI and Presentation","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation","siteSpaceId":"sitesp_wqN6M","description":"Optional, scene-level UI for displaying transcripts, surfacing notifications, and giving users a runtime settings panel — add only what your project needs.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"}]},{"id":"efc9aca742d268965e004a82e3c4e738db24a1a7","title":"Transcript UI","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation/transcript-ui","siteSpaceId":"sitesp_wqN6M","description":"Understand how the Convai Unity SDK separates durable chat history from speech-aligned captions, and which built-in component displays each.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"UI and Presentation"}]},{"id":"351d64ae28927aa533926b237ec3ddf6860763c6","title":"Transcript history and queries","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation/transcript-ui/transcript-history-and-queries","siteSpaceId":"sitesp_wqN6M","description":"Read the current conversation turn timeline from code, react to live turn changes as they happen, and export session history as text, Markdown, or JSON.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"UI and Presentation"},{"label":"Transcript UI"}]},{"id":"04dba1e30bd200179a770ba5dffcaab5b5eadf16","title":"Chat and subtitle modes","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation/transcript-ui/chat-and-subtitle-modes","siteSpaceId":"sitesp_wqN6M","description":"Add scrolling chat history, live subtitle captions, or both to a scene, and configure how each transcript display looks and behaves.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"UI and Presentation"},{"label":"Transcript UI"}]},{"id":"fa6f53862719c13f17357086ad27f2c08beeefa3","title":"Notification system","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation/notification-system","siteSpaceId":"sitesp_wqN6M","description":"Add toast-style alerts that automatically display session error notifications and let you trigger custom in-scene alerts from code using ScriptableObject notification assets.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"UI and Presentation"}]},{"id":"rRfhodnKJWoOgCXobKwX","title":"Notification system reference","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation/notification-system/notification-system-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for SONotification, SONotificationGroup, UINotificationController, and SONotificationErrorMap — fields, methods, and configuration options.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"UI and Presentation"},{"label":"Notification system"}]},{"id":"1e28d73ef0dad9569b5d54c8f9f0b70586425f5a","title":"Settings panel","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation/settings-panel","siteSpaceId":"sitesp_wqN6M","description":"Add a runtime settings panel so users can adjust microphone, transcript visibility, and notification preferences, or access the same settings programmatically.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"UI and Presentation"}]},{"id":"iiqODFfGzsLeWIN6mmNq","title":"Runtime settings API","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation/settings-panel/runtime-settings-api","siteSpaceId":"sitesp_wqN6M","description":"Reference for IConvaiRuntimeSettingsService — read current settings, apply patches, react to changes, and reset to defaults from code.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"UI and Presentation"},{"label":"Settings panel"}]},{"id":"271853384cbbd26c8a6dd213f1d25c8a1dcae34a","title":"Customizing UI components","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation/customizing-ui-components","siteSpaceId":"sitesp_wqN6M","description":"Restyle or replace the built-in transcript, notification, and settings UI using character visibility filters or prefab swapping.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"UI and Presentation"}]},{"id":"cd1efd3a5ca8009cafe359f0b008bc9d6038de38","title":"Scripting reference","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for the Convai Unity SDK C# scripting APIs — events, transcripts, audio control, and async operation patterns.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"}]},{"id":"13ed97201ea2961909236d907e7a691b7b7def81","title":"Session events","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference/session-events","siteSpaceId":"sitesp_wqN6M","description":"Reference for session events — connection state, errors, idle warnings, and participant changes — via relay component or the `ConvaiEvents` C# hub.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Scripting reference"}]},{"id":"3fa7a83ca1955b2d681906cc6ffdc44f9683ef41","title":"Character events","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference/character-events","siteSpaceId":"sitesp_wqN6M","description":"Reference for character events — speech, emotion, transcripts, turn lifecycle, and actions — via relay component or the `ConvaiEvents` C# hub.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Scripting reference"}]},{"id":"e501926159d08f9eb11113c38bcb4aee32ea2253","title":"Transcript API","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference/transcript-api","siteSpaceId":"sitesp_wqN6M","description":"Query transcript turns, subscribe to live changes, read captions, and export session history from Unity scripts using the transcript facade.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Scripting reference"}]},{"id":"zSQGrBgxcfPV6Be5qFA6","title":"Character and Player API","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference/character-and-player-api","siteSpaceId":"sitesp_wqN6M","description":"Reference for ConvaiCharacter and ConvaiPlayer, including properties, methods, and events for session control, speech, audio, and attention.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Scripting reference"}]},{"id":"bc1b761d6432e6496add7c93a083259799218063","title":"ConvaiManager API","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference/convaimanager-api","siteSpaceId":"sitesp_wqN6M","description":"Scripting reference for ConvaiManager — the SDK entry point for connection control, facade access, conversation ownership, and service discovery.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Scripting reference"}]},{"id":"1873379028012da716187c46997839e09a10b6ad","title":"Audio API","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference/audio-api","siteSpaceId":"sitesp_wqN6M","description":"Scripting reference for ConvaiAudio — microphone muting, per-character audio control, audio playback unlock, and listening state management.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Scripting reference"}]},{"id":"88530803851e054def9b3a199945d96762d4ac8c","title":"Operation and stream types","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference/operation-and-stream-types","siteSpaceId":"sitesp_wqN6M","description":"Type reference for IConvaiOperation<T>, IConvaiStream<T>, ConvaiError, and Unit — the async primitives used across all Convai SDK scripting APIs.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Scripting reference"}]},{"id":"1c63f5b931ba9aeb0d22176097b938c510fb5891","title":"Async patterns","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference/async-patterns","siteSpaceId":"sitesp_wqN6M","description":"Consume IConvaiOperation<T> and IConvaiStream<T> using async/await, coroutines, chaining, progress tracking, cancellation, and streams.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Scripting reference"}]},{"id":"d375c5c4e58f4a666f3cb8c940558eb222674e75","title":"Platform guides","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/platform-guides","siteSpaceId":"sitesp_wqN6M","description":"Deploy the Convai Unity SDK on any supported platform — covers what requires extra configuration on WebGL, iOS, Android, and XR headsets before shipping.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"}]},{"id":"f635f366dd1077c203af8bdee8521341b6e36cf5","title":"Windows, macOS, and Linux","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/platform-guides/windows-macos-and-linux","siteSpaceId":"sitesp_wqN6M","description":"Windows, macOS, and Linux builds require no extra SDK configuration — all features including Vision, spatial audio, and screen share work after standard setup.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Platform guides"}]},{"id":"7b2c74ff6faeac7d9557447799d0496b11e50783","title":"WebGL","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/platform-guides/webgl","siteSpaceId":"sitesp_wqN6M","description":"Configure and validate the Convai Unity SDK for WebGL — covers HTTPS requirements, browser audio gesture handling, Vision canvas capture, and the known lip-sync drift defect.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Platform guides"}]},{"id":"32708cb5ab33fa2d1d0f91e747cc06da20220bc1","title":"iOS and Android","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/platform-guides/ios-and-android","siteSpaceId":"sitesp_wqN6M","description":"Declare microphone and camera permissions for iOS and Android builds — omitting them causes crashes on iOS and silent failures on Android.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Platform guides"}]},{"id":"86442e40afdd1c7fd12eb8dc8331a0cc75827347","title":"XR headsets","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/platform-guides/xr-headsets","siteSpaceId":"sitesp_wqN6M","description":"Find guides for deploying the Convai Unity SDK on XR headsets, including Meta Quest Vision passthrough setup and custom XR frame source implementation.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Platform guides"}]},{"id":"iRseCYB4vBfleWvWqnEO","title":"Meta Quest Vision setup","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/platform-guides/meta-quest-vision","siteSpaceId":"sitesp_wqN6M","description":"Configure QuestVisionFrameSource to stream the Meta Quest passthrough camera to a Convai character on Quest 3 and 3S builds.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Platform guides"}]},{"id":"50715c11049002775f940f15ab236a3bc207395c","title":"Customize and extend the SDK","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics","siteSpaceId":"sitesp_wqN6M","description":"Replace SDK providers, extend the runtime with custom modules, and diagnose latency using built-in telemetry — for deployments where the defaults are not enough.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"}]},{"id":"RSZXpj40gmNFoKyKxdOV","title":"Credentials, identity, and storage","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics/custom-providers","siteSpaceId":"sitesp_wqN6M","description":"Replace the SDK's default credential, identity, and persistence providers with custom implementations suited to your deployment environment.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Customize and extend the SDK"}]},{"id":"31f40f584b5fb6b136f239a3d28d2ec74eb938e7","title":"Custom credential provider","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics/custom-providers/custom-credential-provider","siteSpaceId":"sitesp_wqN6M","description":"Override the SDK's default credential source to supply API keys from environment variables, a secrets vault, or any runtime-resolved credential store.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Customize and extend the SDK"},{"label":"Credentials, identity, and storage"}]},{"id":"ab23b641f90fca90f9440603f9ec5293143b86e4","title":"Custom identity provider","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics/custom-providers/custom-identity-provider","siteSpaceId":"sitesp_wqN6M","description":"Implement a custom end-user identity provider to tie Convai's memory and MAU tracking to your own auth system, learner records, or kiosk login flow.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Customize and extend the SDK"},{"label":"Credentials, identity, and storage"}]},{"id":"ed2429f37bbe856909dff42ad46c8c9e20800e6c","title":"Custom persistence provider","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics/custom-providers/custom-persistence-provider","siteSpaceId":"sitesp_wqN6M","description":"Replace PlayerPrefs session storage with a cloud backend, encrypted file store, or in-memory implementation by implementing IKeyValueStore or IPersistenceProvider.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Customize and extend the SDK"},{"label":"Credentials, identity, and storage"}]},{"id":"a3f7030703670bbb62edbb00ba2ab32fd0f7c82a","title":"Personal access token","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics/custom-providers/personal-access-token","siteSpaceId":"sitesp_wqN6M","description":"Generate short-lived tokens from your backend so the real API key never ships inside your Unity build, eliminating credential exposure from client applications.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Customize and extend the SDK"},{"label":"Credentials, identity, and storage"}]},{"id":"5c7f9583038d0635f6ec4cab5bab3847c7c9e158","title":"Runtime module system","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics/extending-the-sdk","siteSpaceId":"sitesp_wqN6M","description":"Understand the Convai runtime module system, including when to use custom modules, the module lifecycle states, and which SDK extension points are safe to use.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Customize and extend the SDK"}]},{"id":"18ZqcEJr2DgHzICW0BuO","title":"Implement a custom module","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics/implement-a-custom-module","siteSpaceId":"sitesp_wqN6M","description":"Implement `IConvaiModule` to add custom runtime behavior that starts with the SDK, accesses runtime services, and reacts to domain events.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Customize and extend the SDK"}]},{"id":"5679714dc01a4244d0d11caee67e8c32da80d5c3","title":"Logging, metrics, and retry policy","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics/performance-and-optimization","siteSpaceId":"sitesp_wqN6M","description":"Configure SDK log verbosity per subsystem, route logs to custom sinks, read RTVI pipeline latency metrics, and tune the connection retry policy.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Customize and extend the SDK"}]},{"id":"d5350da7bd6402bba0c66f41fe2dadd0116fb2da","title":"Troubleshooting","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/troubleshooting","siteSpaceId":"sitesp_wqN6M","description":"Find troubleshooting guides for installation errors, API issues, audio failures, and debug tools in the Convai Unity SDK.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"}]},{"id":"21f9d826ef71da7f70e7312d5dca5de0bcbfa2f2","title":"Installation and package issues","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/troubleshooting/installation-and-package-issues","siteSpaceId":"sitesp_wqN6M","description":"Fix Convai Unity SDK import failures, missing dependencies, assembly errors, and bootstrapper startup warnings with step-by-step remediation.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Troubleshooting"}]},{"id":"bf2d3c0310bc8496a310e6c0331136dd3cf2399d","title":"Connection and API issues","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/troubleshooting/connection-and-api-issues","siteSpaceId":"sitesp_wqN6M","description":"Interpret Convai session error codes, read ConvaiRoomManager diagnostics, and resolve authentication, transport, and rate-limit failures.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Troubleshooting"}]},{"id":"607bf5ace60fb89b0eb5ed9df13d6a2718028170","title":"Audio and microphone issues","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/troubleshooting/audio-and-microphone-issues","siteSpaceId":"sitesp_wqN6M","description":"Fix microphone input failures and character voice playback issues on all Convai Unity SDK platforms, including Android, iOS, and WebGL.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Troubleshooting"}]},{"id":"33d51f5b9dd5b0b2ef292fc1b0dd113786346c3e","title":"Debug tools reference","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/troubleshooting/debug-tools-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for Convai SDK debug tools, including logging configuration, ConvaiActionDebugProbe, session diagnostics, and client latency metrics.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Troubleshooting"}]},{"id":"vAerDmlPwB1EoS3RixrT","title":"Convai Unreal Engine plugin","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin","siteSpaceId":"sitesp_wqN6M","description":"Find installation guides, feature documentation, Blueprint reference, and troubleshooting pages for the Convai Unreal Engine plugin.","breadcrumbs":[{"label":"Plugins & Integrations"}]},{"id":"YZJCXRAzNrUUtxgSDzG8","title":"Convai Unreal Engine plugin overview","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/overview","siteSpaceId":"sitesp_wqN6M","description":"Find explanations of what the Convai Unreal Engine plugin is, how its four modules and runtime components are structured, and what changed in each release.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"}]},{"id":"10h7Zgk3jx1Y3dSXWFS4","title":"What is the Convai Unreal Engine plugin","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/overview/what-is-the-convai-unreal-engine-plugin","siteSpaceId":"sitesp_wqN6M","description":"Understand what the Convai Unreal Engine plugin adds to a project: Blueprint components, a real-time voice pipeline, and opt-in feature add-ons.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Convai Unreal Engine plugin overview"}]},{"id":"avDtqiuctK8vS16Q8s7w","title":"Plugin architecture","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/overview/plugin-architecture","siteSpaceId":"sitesp_wqN6M","description":"Understand the Convai Unreal Engine plugin's four modules, runtime components, session proxies, and subsystem routing model.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Convai Unreal Engine plugin overview"}]},{"id":"HcWIzLmISVXTnaagYQMj","title":"Feature map","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/overview/feature-map","siteSpaceId":"sitesp_wqN6M","description":"Find the right Convai Unreal Engine plugin feature, guide, or reference page for any development goal, indexed by use case.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Convai Unreal Engine plugin overview"}]},{"id":"Z2cuD4gzRs1MiHPN778m","title":"Release notes","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/overview/release-notes","siteSpaceId":"sitesp_wqN6M","description":"Version history and notable changes for the Convai Unreal Engine plugin, covering public 4.x beta releases and the full 3.x history.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Convai Unreal Engine plugin overview"}]},{"id":"3oblPsurIGf7eseuvZPm","title":"Compatibility and requirements","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/compatibility-and-requirements","siteSpaceId":"sitesp_wqN6M","description":"Find the Unreal Engine version support, platform targets, character rig compatibility, and network requirements for the Convai Unreal Engine plugin.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"}]},{"id":"CA2WtOTx4l3bXAkUWO4l","title":"Unreal Engine versions","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/compatibility-and-requirements/unreal-engine-versions","siteSpaceId":"sitesp_wqN6M","description":"Reference for Convai Unreal Engine plugin version support, including module availability per UE version, load phases, and per-version setup notes.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Compatibility and requirements"}]},{"id":"aLS9wREFDwmaOgsKQZ3Z","title":"Unreal Engine platform support matrix","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/compatibility-and-requirements/unreal-engine-platform-support-matrix","siteSpaceId":"sitesp_wqN6M","description":"Reference for Convai Unreal Engine plugin platform support, including build targets, engine plugin dependencies, and Android microphone access.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Compatibility and requirements"}]},{"id":"9aF3O66XI2Xgu5NV461L","title":"Character rig support","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/compatibility-and-requirements/character-rig-support","siteSpaceId":"sitesp_wqN6M","description":"Which character rigs work with the Convai Unreal Engine plugin, what setup each requires, and where to find the rig-specific setup guides.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Compatibility and requirements"}]},{"id":"6QAApU1I0cvIZPD3M50b","title":"Network and API requirements","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/compatibility-and-requirements/network-and-api-requirements","siteSpaceId":"sitesp_wqN6M","description":"Reference for Convai Unreal Engine plugin network access, including Convai and LiveKit hosts, firewall rules, authentication, and session log checks.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Compatibility and requirements"}]},{"id":"5oPvRJZZEVuIVMYZLYh8","title":"Getting started","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started","siteSpaceId":"sitesp_wqN6M","description":"Install the Convai Unreal Engine plugin, configure your API key, and place your first talking character — follow the core path in order for the fastest result.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"}]},{"id":"rEn97nz5rOXoeSAteVQt","title":"Prerequisites","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/prerequisites","siteSpaceId":"sitesp_wqN6M","description":"Verify engine version, account, platform, and network requirements before installing the Convai Unreal Engine plugin into your project.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Getting started"}]},{"id":"zf9D2ktrnLMIujjWxizK","title":"Install the Convai plugin","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/install-the-convai-plugin","siteSpaceId":"sitesp_wqN6M","description":"Install the Convai Unreal Engine plugin from Fab or GitHub Releases, enable it in your project, and restart the Unreal Editor.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Getting started"}]},{"id":"yK6s42eZv16JXJzJnF9d","title":"Configure your API key","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/configure-your-api-key","siteSpaceId":"sitesp_wqN6M","description":"Sign in through the Convai editor window to store your API key and allow the plugin to send authenticated requests to Convai.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Getting started"}]},{"id":"TAMFvBX6DiCF3cUBeYtP","title":"Scene components reference","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/scene-components-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for the Convai Chatbot, Player, Object, and Face Sync components — their fields, runtime properties, and how they connect in a scene.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Getting started"}]},{"id":"62jSGyEcDL1LUmbU2yXD","title":"Add your first Convai character","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/add-your-first-convai-character","siteSpaceId":"sitesp_wqN6M","description":"Build a talking Convai character in Unreal Engine by adding Chatbot and Player components, setting a Character ID, and testing in Play mode.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Getting started"}]},{"id":"XbtaAPxghTKgeXTDOIn3","title":"Set up a MetaHuman character","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/set-up-a-metahuman-character","siteSpaceId":"sitesp_wqN6M","description":"Add Convai Chatbot and Face Sync components to a MetaHuman, assign the Convai animation classes, and configure lip sync for MetaHuman blendshapes.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Getting started"}]},{"id":"GjMgGIpOc6IFNfXiyJTr","title":"Set up a Reallusion (CC) character","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/set-up-a-reallusion-cc-character","siteSpaceId":"sitesp_wqN6M","description":"Export a Reallusion CC5 avatar, import it into Unreal Engine, configure Convai components, and add the Reallusion animation Blueprint for lip sync.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Getting started"}]},{"id":"9KUQ9XKjAMU6OaZfGxfJ","title":"Configure the microphone","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/configure-the-microphone","siteSpaceId":"sitesp_wqN6M","description":"Select a capture device, adjust volume, and handle Android microphone permissions so player speech reaches the Convai character correctly.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Getting started"}]},{"id":"hFMUaDotYrGAMPyQ8J6G","title":"Configure character audio","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/configure-character-audio","siteSpaceId":"sitesp_wqN6M","description":"Adjust character speech playback volume, enable spatial audio attenuation, and configure the interrupt fade duration on the Convai Chatbot component.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Getting started"}]},{"id":"wO1MGAXD0InYM2apk7cV","title":"Configure conversation input","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/configure-conversation-input","siteSpaceId":"sitesp_wqN6M","description":"Switch between push-to-talk and hands-free voice capture modes, tune VAD settings, and send text messages to a character without a microphone.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Getting started"}]},{"id":"HucPjSqJx8pLUO4dNPgQ","title":"Add the chat UI","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/add-the-chat-ui","siteSpaceId":"sitesp_wqN6M","description":"Add the built-in chat overlay to your scene, switch between interface styles, attach the 3D in-world widget to a character, or replace it with a custom widget.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Getting started"}]},{"id":"g8UGNK2Dicyeh9I9zZ6x","title":"Validate your setup","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/validate-your-setup","siteSpaceId":"sitesp_wqN6M","description":"Run through a checklist of plugin, component, audio, and API key checks to confirm your Convai Unreal Engine setup is working before adding features.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Getting started"}]},{"id":"uL5SILtUmeFvx3EidUSt","title":"Core concepts","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/core-concepts","siteSpaceId":"sitesp_wqN6M","description":"Understand the component model of the Convai Unreal Engine plugin, how each component is owned, and how they work together at runtime.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"}]},{"id":"36aeWZiRCKCEuHABFcbC","title":"Runtime architecture","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/core-concepts/runtime-architecture","siteSpaceId":"sitesp_wqN6M","description":"Understand the roles, ownership, and relationships between the Convai Chatbot, Player, Object, Face Sync components, and the Convai Subsystem.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Core concepts"}]},{"id":"eoZKwdeLf9Z6eibYUijz","title":"Session lifecycle","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/core-concepts/session-lifecycle","siteSpaceId":"sitesp_wqN6M","description":"Understand how Convai sessions start and stop, what connection states mean, and which Blueprint nodes monitor the global connection.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Core concepts"}]},{"id":"zDu9dPOf91gdHtGGWLZw","title":"Conversation flow","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/core-concepts/conversation-flow","siteSpaceId":"sitesp_wqN6M","description":"Understand voice input, playback state, transcription events, action queue execution, narrative triggers, and interruption handling.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Core concepts"}]},{"id":"qLn90PJJUY78IXQ8NIrm","title":"Event system","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/core-concepts/event-system","siteSpaceId":"sitesp_wqN6M","description":"Reference for core runtime Blueprint delegates on Convai components and the subsystem, organized by category with timing details.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Core concepts"}]},{"id":"AGnvNMLpxOxMFMMgKjWH","title":"Features","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features","siteSpaceId":"sitesp_wqN6M","description":"Find guides for all Convai Unreal Engine plugin features — lip sync, character actions, narrative design, long-term memory, vision, and more.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"}]},{"id":"NjVHOB3MELicvSSurEPd","title":"Character actions","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions","siteSpaceId":"sitesp_wqN6M","description":"Find guides, references, and examples for the Convai Unreal Engine character actions system — from quick start to Blueprint API reference.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"}]},{"id":"J36C3clan8yhcgYGTrUP","title":"How character actions work","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/how-character-actions-work","siteSpaceId":"sitesp_wqN6M","description":"Understand how Convai character actions move from session setup to queued Blueprint handler execution and completion reporting.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Character actions"}]},{"id":"B8YtLNagBWrxMPwLZWxf","title":"Character actions quick start","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/character-actions-quick-start","siteSpaceId":"sitesp_wqN6M","description":"Enable character actions, set up pawn movement and navigation, register scene objects, and verify default movement actions in Play mode.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Character actions"}]},{"id":"qIWRz61DFTTZdII0U2XA","title":"Configuring actions","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/configuring-actions","siteSpaceId":"sitesp_wqN6M","description":"Define the action set, enable character actions, and register environment objects and characters so Convai can reference them.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Character actions"}]},{"id":"t5DSC6B706zfqaDzJzHT","title":"Built-in action handlers","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/built-in-action-handlers","siteSpaceId":"sitesp_wqN6M","description":"Reference handler patterns for the four default Convai character actions, including parameters, completion rules, and Blueprint flow.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Character actions"}]},{"id":"Q9OxeZ4EchM8ABZ4pIOW","title":"Building custom action handlers","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/building-custom-action-handlers","siteSpaceId":"sitesp_wqN6M","description":"Add a custom action template, scaffold a Blueprint handler with the editor utility, and report completion so the queue advances.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Character actions"}]},{"id":"y5n6zO4nhEgGfJnXzGk4","title":"Parameterized actions","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/parameterized-actions","siteSpaceId":"sitesp_wqN6M","description":"Declare typed action parameters and read resolved values in Blueprint handlers for text, references, choices, and animations.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Character actions"}]},{"id":"H0jjq9t6AueURwGJUpI3","title":"Attention and reference grounding","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/attention-and-reference-grounding","siteSpaceId":"sitesp_wqN6M","description":"Understand how the Convai Unreal Engine plugin resolves pronoun references and attention targets so characters understand which object a player means.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Character actions"}]},{"id":"lEX58Owo3bAVjCGO0ezK","title":"Actions Blueprint reference","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/actions-blueprint-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for the Blueprint structs, enums, events, and queue functions that power Convai character actions in Unreal Engine.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Character actions"}]},{"id":"KjK5RrpmmborH095i0oC","title":"Character actions examples","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/character-actions-examples","siteSpaceId":"sitesp_wqN6M","description":"End-to-end action recipes for navigating to a registered object, following a character, and using parameterized actions in the Convai Unreal Engine plugin.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Character actions"}]},{"id":"EeeGTar0veyeNxdDlpfy","title":"Troubleshoot character actions","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/troubleshoot-character-actions","siteSpaceId":"sitesp_wqN6M","description":"Fix character actions that do not fire, movement failures, reference issues, and queue stalls in the Convai Unreal Engine plugin.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Character actions"}]},{"id":"VtreGBSkV3v9EqIKSNQH","title":"Dynamic context","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context","siteSpaceId":"sitesp_wqN6M","description":"Find guides for pushing live state and events to Convai characters through Blueprint nodes and verifying context-aware responses in your level.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"}]},{"id":"HGItmryh4PHfi7WIN9UG","title":"How dynamic context works","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context/how-dynamic-context-works","siteSpaceId":"sitesp_wqN6M","description":"Understand how dynamic context tracks runtime state, batches events, chooses response behavior, and assembles payloads for Convai.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"uLheo1rAJDdMVNFZj7ZL","title":"Dynamic context quick start","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context/dynamic-context-quick-start","siteSpaceId":"sitesp_wqN6M","description":"Push a state property and a context event to a connected Convai character in Blueprint and verify the update reaches the context pipeline.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"cf6u0S8978Cad9J2oR2W","title":"Static context at connection time","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context/static-context-at-connection-time","siteSpaceId":"sitesp_wqN6M","description":"Understand which verified connection data is fixed at session start and how live context updates use separate runtime messages.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"R2QEV8nZly3I7Sd1ew7G","title":"Sync behavior and timing","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context/sync-behavior-and-timing","siteSpaceId":"sitesp_wqN6M","description":"Understand how dynamic context payloads flush after debounce, how offline queueing works, and when immediate flushes bypass batching.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"KeXDDGyIx8dXyg80DYwi","title":"Dynamic context Blueprint reference","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context/dynamic-context-blueprint-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference the Blueprint controls that send runtime state, event, reset, and timing updates from an Unreal character to Convai during a live session.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"m4rqRxdMbmG8hRxTM7Q2","title":"Dynamic context usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context/dynamic-context-usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Blueprint recipes for health tracking, context events, zone transitions, state removal, and dynamic context resets in training simulations.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"G3KIxXwGh1BmpM1vFq9B","title":"Troubleshoot dynamic context","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context/troubleshoot-dynamic-context","siteSpaceId":"sitesp_wqN6M","description":"Fix dynamic context updates that arrive too late, trigger unexpected responses, or appear ignored after a flush or reconnect.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"dXQYIyvmX3Z6hN65zfqt","title":"Emotion","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/emotion","siteSpaceId":"sitesp_wqN6M","description":"Find guides for animating AI character expressions in sync with conversation — from quick Blueprint setup to full reference and troubleshooting.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"}]},{"id":"rhrJSUDsxJtlVoC5RBxt","title":"How the emotion system works","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/emotion/how-the-emotion-system-works","siteSpaceId":"sitesp_wqN6M","description":"Understand how Convai delivers emotion state as per-emotion scores, how server scale maps to score values, and what the offset and lock controls do.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Emotion"}]},{"id":"DdElnRB3Nhl5aVIsBAlu","title":"Emotion quick start","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/emotion/emotion-quick-start","siteSpaceId":"sitesp_wqN6M","description":"Wire a Convai character's emotion scores to morph targets on its Skeletal Mesh so facial expressions update automatically during conversation.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Emotion"}]},{"id":"49dLglYXwdqtxoT5OviR","title":"Emotion Blueprint reference","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/emotion/emotion-blueprint-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for emotion properties, functions, events, and enums on the Convai Chatbot component — including types, defaults, and parameter details.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Emotion"}]},{"id":"b9ztYs8XT0CsQtGnPjeC","title":"Emotion examples","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/emotion/emotion-examples","siteSpaceId":"sitesp_wqN6M","description":"Six scenarios covering forced expressions, cutscene locks, score-driven VFX, offset tuning, neutral reset, and Animation Blueprint blend poses.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Emotion"}]},{"id":"tBJKhFf61Mm1mKyjfr69","title":"Troubleshoot emotion","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/emotion/troubleshoot-emotion","siteSpaceId":"sitesp_wqN6M","description":"Fix common emotion problems — expressions not appearing, state locked unintentionally, morph target mismatches, and offset changes with no visible effect.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Emotion"}]},{"id":"DMTej4CYSOHRGmpxRVHi","title":"Long-term memory","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory","siteSpaceId":"sitesp_wqN6M","description":"Find guides for enabling long-term memory, identifying players, resuming sessions, and troubleshooting recall in Unreal Engine.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"}]},{"id":"Bc8OjnguS3F6H3oW7CJi","title":"How long-term memory works","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/how-long-term-memory-works","siteSpaceId":"sitesp_wqN6M","description":"Understand how Unreal long-term memory uses character settings, player identity, and connect-time parameters to recall prior interactions.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"qCWhjxGBv6qEO4Rkl0Ph","title":"Long-term memory quick start","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/long-term-memory-quick-start","siteSpaceId":"sitesp_wqN6M","description":"Set up long-term memory for an Unreal character, assign a stable player identity, and confirm recall across Play In Editor sessions.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"F5FsqjGFVKgO3SLqnTYj","title":"Configure memory for a character","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/configure-memory-for-a-character","siteSpaceId":"sitesp_wqN6M","description":"Enable long-term memory for an Unreal character, verify the dashboard setting, and reset the local conversation link when needed.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"qcfr1PrPOizoztRNloCY","title":"End-user identity","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/end-user-identity","siteSpaceId":"sitesp_wqN6M","description":"Configure a stable Unreal player identity so each Convai character loads memory for the correct user before a session starts.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"xIpC6mQGKNJNnXc3TQWn","title":"Speaker ID management","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/speaker-id-management","siteSpaceId":"sitesp_wqN6M","description":"Create, list, and delete Speaker ID records from Unreal Blueprints so each player keeps a stable memory identity across sessions.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"mwNxFe292Uo2iGpZiLAp","title":"LTM Blueprint reference","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/ltm-blueprint-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for Unreal long-term memory Blueprint nodes, Speaker ID data, component properties, and session fields used during startup.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"tyOWumFxG4lNGELvqAOH","title":"Long-term memory usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/long-term-memory-usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Apply Unreal long-term memory patterns for returning learners, shared devices, first sessions, and fresh-start reset flows.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"rHYMia3zb5OAQe1S06cT","title":"Troubleshoot long-term memory","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/troubleshoot-long-term-memory","siteSpaceId":"sitesp_wqN6M","description":"Diagnose disabled memory, unstable player identity, speaker identity failures, and shared-device recall issues for Unreal characters.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"adQWw1CiOcNdZRsmpBeB","title":"Narrative design","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design","siteSpaceId":"sitesp_wqN6M","description":"Drive character story graphs from Unreal Engine by invoking narrative triggers, injecting template keys, and handling section change events.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"}]},{"id":"5UHlXoAxUOLuWB0TElfn","title":"How narrative design works","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/how-narrative-design-works","siteSpaceId":"sitesp_wqN6M","description":"Understand the narrative design story graph, the runtime pipeline that advances sections, and how triggers and template keys shape character behavior.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"9naQ9wL6wpdxFfJuDkfH","title":"Narrative design quick start","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/narrative-design-quick-start","siteSpaceId":"sitesp_wqN6M","description":"Invoke a named narrative trigger from Blueprint and confirm a section change by printing the new section ID to the screen.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"Khv7SfpK36SvMkUjcjoW","title":"Narrative triggers","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/narrative-triggers","siteSpaceId":"sitesp_wqN6M","description":"Invoke named narrative triggers or dynamic context messages on a Convai chatbot component to advance the story graph and handle the section change event.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"WlLowI3BqDYQNs4lfQM4","title":"Template keys","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/template-keys","siteSpaceId":"sitesp_wqN6M","description":"Populate the Narrative Template Keys map on a chatbot component so section objectives reference live gameplay values through placeholder substitution.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"9dcZ9ULB2iFBCZcNEu6i","title":"Fetching narrative data","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/fetching-narrative-data","siteSpaceId":"sitesp_wqN6M","description":"Query a character's narrative sections and triggers at runtime using Convai Fetch Narrative Sections and Convai Fetch Narrative Triggers.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"7L5OLPdjT22ynoNiU7gD","title":"Narrative design Blueprint reference","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/narrative-design-blueprint-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for Blueprint functions, events, properties, and narrative structs on UConvaiChatbotComponent in the narrative design API.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"Y84uFwti8p03e69iFquR","title":"Narrative design usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/narrative-design-usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Blueprint recipes for linear scene progression, dynamic context events, template key injection, and trigger-name validation in narrative design.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"uGDfbeU2MRjQlg7HV1GY","title":"Troubleshoot narrative design","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/troubleshoot-narrative-design","siteSpaceId":"sitesp_wqN6M","description":"Diagnose and fix narrative design issues including missing section events, wrong transitions, ignored template keys, and fetch failures.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"vbGxc89Y9wflNJFl3EW4","title":"Scene metadata","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/scene-metadata","siteSpaceId":"sitesp_wqN6M","description":"Find guides, reference pages, and examples for giving Convai characters awareness of objects in your Unreal Engine level.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"}]},{"id":"ct7GZc4pJVR5cE2Nx02x","title":"How scene metadata works","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/scene-metadata/how-scene-metadata-works","siteSpaceId":"sitesp_wqN6M","description":"Understand how scene object metadata reaches Convai at connect time, through live updates, and via tracked property changes.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Scene metadata"}]},{"id":"wMA4p35fTyTTaaCVW5Iq","title":"Scene metadata quick start","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/scene-metadata/scene-metadata-quick-start","siteSpaceId":"sitesp_wqN6M","description":"Tag a world actor with the Convai Object Component, assign its name and description, and confirm a Convai character can reference it in conversation.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Scene metadata"}]},{"id":"D7AS0tddjNnZ6oTWwtlC","title":"Scene metadata component reference","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/scene-metadata/scene-metadata-component-reference","siteSpaceId":"sitesp_wqN6M","description":"Full property, function, and event reference for the Convai Object Component, including object identity, tracked properties, proximity state, and gaze events.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Scene metadata"}]},{"id":"0IWX9Z34917gjSpzDUY8","title":"Managing the environment at runtime","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/scene-metadata/managing-the-environment-at-runtime","siteSpaceId":"sitesp_wqN6M","description":"Reference for chatbot environment methods that add, remove, and update objects and characters during an active gameplay session.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Scene metadata"}]},{"id":"4fgSEKKPL6fKko07SAoV","title":"Scene metadata usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/scene-metadata/scene-metadata-usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Complete scene metadata setups for training simulations, industrial drills, military bases, and runtime environment updates in Unreal Engine.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Scene metadata"}]},{"id":"vDCzfp22bc2x6dppbHkD","title":"Troubleshoot scene metadata","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/scene-metadata/troubleshoot-scene-metadata","siteSpaceId":"sitesp_wqN6M","description":"Diagnose and fix common problems with scene objects not being recognized, stale environment data, and tracked properties failing to update.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Scene metadata"}]},{"id":"5TGq7ASz4xWw1Dhn8qy3","title":"Vision","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision","siteSpaceId":"sitesp_wqN6M","description":"Give Convai characters scene vision in Unreal Engine so they can respond to what is visible in the level during conversation.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"}]},{"id":"RNP7gLRl8F8AfVtFryly","title":"How vision works","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision/how-vision-works","siteSpaceId":"sitesp_wqN6M","description":"Understand how Unreal vision components are discovered, started, throttled, and used to send scene frames during a Convai session.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Vision"}]},{"id":"wz9pG5dZWcD3ZCNsrxON","title":"Vision quick start","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision/vision-quick-start","siteSpaceId":"sitesp_wqN6M","description":"Add scene vision to a Convai character Blueprint and verify that captured frames affect the character's response in Play In Editor.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Vision"}]},{"id":"1zs9olIHfeqwXONkvpVT","title":"Vision frame sources","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision/vision-frame-sources","siteSpaceId":"sitesp_wqN6M","description":"Configure the built-in Environment Webcam frame source, create its render target, and select the active vision component at runtime.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Vision"}]},{"id":"LiRqiZh8lqH02mdwtjJn","title":"Custom vision components","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision/custom-vision-components","siteSpaceId":"sitesp_wqN6M","description":"Implement a C++ frame source component for custom Unreal image pipelines that need to provide scene frames to a Convai chatbot.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Vision"}]},{"id":"8W9Lmm4Mqew1zEfyrsje","title":"Vision Blueprint reference","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision/vision-blueprint-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for Blueprint-accessible vision enums, Environment Webcam properties, webcam nodes, events, and Chatbot integration functions.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Vision"}]},{"id":"jR121aXRSrtaarm2aad5","title":"Vision usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision/vision-usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Apply common Blueprint patterns for Unreal vision, including auto-start capture, manual control, FPS tuning, and source switching.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Vision"}]},{"id":"P6Q0IslTrewgSnb1grWo","title":"Troubleshoot vision","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision/troubleshoot-vision","siteSpaceId":"sitesp_wqN6M","description":"Fix common Unreal vision problems including missing visual context, failed starts, blank render targets, and invalid source registration.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Vision"}]},{"id":"LWOprxC8MMYzTxzOV4pu","title":"Gaze attention","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/gaze-attention","siteSpaceId":"sitesp_wqN6M","description":"Find guides and reference for the gaze attention system, which lets players direct a Convai character's focus by looking at world objects.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"}]},{"id":"tzRboWm1eecuLuhSsAmt","title":"How gaze attention works","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/gaze-attention/how-gaze-attention-works","siteSpaceId":"sitesp_wqN6M","description":"Understand the gaze trace pipeline, attention promotion timers, component-scoped targeting, highlight rendering, and the attention-source locking rule.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Gaze attention"}]},{"id":"8wms0FA96K4gf9BhKcAt","title":"Gaze attention quick start","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/gaze-attention/gaze-attention-quick-start","siteSpaceId":"sitesp_wqN6M","description":"Enable gaze attention on the Convai Player Component and verify that a character responds when the player looks at a tagged world object.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Gaze attention"}]},{"id":"Y1a2EJCnlVUVqiuNeKuC","title":"Gaze attention reference","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/gaze-attention/gaze-attention-reference","siteSpaceId":"sitesp_wqN6M","description":"Complete property, event, method, and class reference for the gaze attention system, including all defaults and version-specific behavior.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Gaze attention"}]},{"id":"bPs8fXX51q1pu4P47Ypq","title":"Gaze attention usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/gaze-attention/gaze-attention-usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Blueprint recipes for gaze events, custom highlight visuals, component-scoped targeting, manual attention locking, and building a custom cursor widget.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Gaze attention"}]},{"id":"vhd0cZEs5OqbzqVwljKh","title":"Troubleshoot gaze attention","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/gaze-attention/troubleshoot-gaze-attention","siteSpaceId":"sitesp_wqN6M","description":"Diagnose and fix gaze attention issues — objects not highlighting, attention never promoting, cursor not appearing, and component-scoped gaze not matching.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Gaze attention"}]},{"id":"MUqoUJUdEwZL84AyCxoU","title":"Lip sync","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync","siteSpaceId":"sitesp_wqN6M","description":"Animate a character's face in sync with Convai speech using precomputed blendshape data and the Convai Face Sync AnimGraph node.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"}]},{"id":"lOSnElQlgFyVpLhYq4IH","title":"How lip sync works","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync/how-lip-sync-works","siteSpaceId":"sitesp_wqN6M","description":"Understand how Convai delivers facial animation data alongside audio, the supported lip-sync modes, and how the AnimGraph node applies it.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Lip sync"}]},{"id":"rHjIjF6OivZ5wW5NeV4L","title":"Lip sync quick start","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync/lip-sync-quick-start","siteSpaceId":"sitesp_wqN6M","description":"Add the Convai Face Sync component and Convai animation classes to a MetaHuman character and hear lip-synced speech in Play In Editor.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Lip sync"}]},{"id":"lsZCsc7Ypsg79ozXB0fr","title":"Face Sync component reference","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync/face-sync-component-reference","siteSpaceId":"sitesp_wqN6M","description":"Property reference for the Convai Face Sync component and all six lip-sync mode values with rig compatibility guidance for MetaHuman, CC4, CC5, and custom rigs.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Lip sync"}]},{"id":"ShOSJ5HqZshB5R4ioXln","title":"Face Sync AnimGraph node reference","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync/face-sync-animgraph-node-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for all properties of the Convai Face Sync AnimGraph node — apply mode, face alphas, smoothing, starvation blending, and blendshape mapping.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Lip sync"}]},{"id":"ZuNnaqm1ldGai22u0MPD","title":"Record and replay lip sync","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync/record-and-replay-lip-sync","siteSpaceId":"sitesp_wqN6M","description":"Capture a live lip-sync sequence during a Convai conversation and replay it later in cutscenes, cached responses, or offline previews without re-streaming.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Lip sync"}]},{"id":"n5M1eapXfiR0tOlawpbm","title":"Lip sync usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync/lip-sync-usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Configure lip sync for common scenarios: Add vs Override blending, tuning smoothing, mixing with body animation, and remapping blendshapes to a custom rig.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Lip sync"}]},{"id":"OrGmrNEAMlVbk4NSYCL3","title":"Troubleshoot lip sync","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync/troubleshoot-lip-sync","siteSpaceId":"sitesp_wqN6M","description":"Diagnose and fix lip sync issues in the Convai Unreal Engine plugin — no mouth movement, frame starvation, wrong blendshape map, and rig mismatch.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Lip sync"}]},{"id":"2OW0dOqVCY8obz8ud9x2","title":"Advanced topics","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/advanced-topics","siteSpaceId":"sitesp_wqN6M","description":"Find production authentication, security, and integration guides for the Convai Unreal Engine plugin beyond the core setup path.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"}]},{"id":"gCewWm6yF4QDWKLcH5rn","title":"Use personal access tokens","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/advanced-topics/personal-access-token","siteSpaceId":"sitesp_wqN6M","description":"Generate a short-lived token on your backend and pass it to the Unreal plugin so production builds do not ship a real API key.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Advanced topics"}]},{"id":"YJZ9npCu6kBrPvgWNPcz","title":"Blueprint reference","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference","siteSpaceId":"sitesp_wqN6M","description":"Find verified Blueprint component, utility, audio, and shared data references for the Convai Unreal Engine plugin runtime workflow.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"}]},{"id":"0VDwXeI6AzMabnJyekSQ","title":"Convai Chatbot Component","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference/convai-chatbot-component","siteSpaceId":"sitesp_wqN6M","description":"Reference for the AI character component — every Blueprint-visible property, function, and event exposed by the Convai Chatbot Component.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Blueprint reference"}]},{"id":"qPgHSr8R4sd5rplgr5u4","title":"Convai Player Component","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference/convai-player-component","siteSpaceId":"sitesp_wqN6M","description":"Reference for the player conversation component — every Blueprint-visible property, function, and event exposed by the Convai Player Component.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Blueprint reference"}]},{"id":"DkhdClgCqO2tHqAGtVFi","title":"Convai Object Component","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference/convai-object-component","siteSpaceId":"sitesp_wqN6M","description":"Reference for the object tagging component — every Blueprint-visible property, function, and event exposed by the Convai Object Component.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Blueprint reference"}]},{"id":"6BNXkLsA5NhP4cLsdovV","title":"Microphone and audio capture","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference/microphone-and-audio-capture","siteSpaceId":"sitesp_wqN6M","description":"Reference for microphone device enumeration, selection, and volume on the Convai Player Component, the audio capture component, and Android permissions.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Blueprint reference"}]},{"id":"SZgrn5ikGQTQteegD5Hr","title":"Convai utility functions","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference/convai-utility-functions","siteSpaceId":"sitesp_wqN6M","description":"Find cross-cutting Blueprint helper nodes for look-at queries, component lookup, audio utilities, settings, diagnostics, and command-line flags.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Blueprint reference"}]},{"id":"gyOnm5SFuaK37xai5UZx","title":"Data types and enums","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference/data-types-and-enums","siteSpaceId":"sitesp_wqN6M","description":"Reference for Blueprint-exposed structs and enums in the Convai Unreal Engine plugin, including object entries, action types, emotions, and connection states.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Blueprint reference"}]},{"id":"dfPAsmC4gI49gaBgUn6h","title":"The Convai editor window","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/editor-window","siteSpaceId":"sitesp_wqN6M","description":"Open the Convai editor window, understand its main sections, and find account, update, support, and log export workflows.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"}]},{"id":"4loiR0UybR6vGeWAAZWs","title":"Sign in and manage your account","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/editor-window/sign-in-and-manage-your-account","siteSpaceId":"sitesp_wqN6M","description":"Connect your Convai account through the editor window, sign out to switch accounts, and review plan, quota, and usage details inside Unreal Editor.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"The Convai editor window"}]},{"id":"VFZLJxq2P7nVfIJDWiVU","title":"Browse samples and content","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/editor-window/browse-samples-and-content","siteSpaceId":"sitesp_wqN6M","description":"Check the current Samples area in the Convai Editor window and understand how sample projects will be surfaced in future updates.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"The Convai editor window"}]},{"id":"r1y21YG8W9pILVbbKTX7","title":"Export diagnostic logs","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/editor-window/export-diagnostic-logs","siteSpaceId":"sitesp_wqN6M","description":"Export Convai diagnostics from Unreal Editor and attach the generated log package to a Convai Developer Forum support request.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"The Convai editor window"}]},{"id":"RoMMd8QlITNHZ4C7DbG4","title":"Troubleshooting","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/troubleshooting","siteSpaceId":"sitesp_wqN6M","description":"Find fixes for installation, API key, audio, lip sync, and connection problems in the Convai Unreal Engine plugin, plus log export and diagnostic guidance.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"}]},{"id":"hAqxIeXv5sv60SseRsHZ","title":"Installation and plugin issues","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/troubleshooting/installation-and-plugin-issues","siteSpaceId":"sitesp_wqN6M","description":"Fix plugin-not-found errors, module load failures, Blueprint-only project limitations, and Android packaging errors in the Convai Unreal Engine plugin.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Troubleshooting"}]},{"id":"vjpN4AOUQxqogF37p0pC","title":"Connection and API key issues","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/troubleshooting/connection-and-api-key-issues","siteSpaceId":"sitesp_wqN6M","description":"Fix authentication failures, missing API key errors, session timeout, and firewall problems in the Convai Unreal Engine plugin.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Troubleshooting"}]},{"id":"dLpMCOKrWYMkRx1BXob8","title":"Audio and microphone issues","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/troubleshooting/audio-and-microphone-issues","siteSpaceId":"sitesp_wqN6M","description":"Fix audio capture failures, wrong microphone device, Android permission errors, and audio playback problems in the Convai Unreal Engine plugin.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Troubleshooting"}]},{"id":"I0ObYlUKKH4xrA1bmEGA","title":"Lip sync and animation issues","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/troubleshooting/lip-sync-and-animation-issues","siteSpaceId":"sitesp_wqN6M","description":"Fix missing mouth movement, wrong blendshape curves, frame starvation, and packaged build animation failures in the Convai Unreal Engine plugin.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Troubleshooting"}]},{"id":"pZV8WWWMb3ZTg1Gyagbc","title":"Diagnostics and log export","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/troubleshooting/diagnostics-and-log-export","siteSpaceId":"sitesp_wqN6M","description":"Reference for Convai log categories, verbosity levels, configuration defaults, Blueprint diagnostic nodes, and log file export for the Unreal Engine plugin.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Troubleshooting"}]},{"id":"Ufgfxad0qAjE4Lb97w0c","title":"Web Plugins","pathname":"/api-docs/plugins-and-integrations/web-plugins","siteSpaceId":"sitesp_wqN6M","description":"Integrate Convai AI with your website. Follow our Web plugin documentation for seamless setup.","breadcrumbs":[{"label":"Plugins & Integrations"}]},{"id":"bg0KbmaczTTieGzr3iU7","title":"Convai Web SDK","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk","siteSpaceId":"sitesp_wqN6M","description":"Explore the Convai Web SDK — Fast, low-latency, voice-first AI character interaction for the browser","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"}]},{"id":"QARm23s6FuiamQWrYu2J","title":"React","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/react","siteSpaceId":"sitesp_wqN6M","icon":"react","description":"Learn how to install, configure, and integrate the Convai Web SDK (@convai/web-sdk) to bring low-latency conversational AI, voice interaction, and optional video into your web applications.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"}]},{"id":"GQ2YU7yGQqbMXjFYj2Pd","title":"useConvaiClient Hook","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/react/useconvaiclient-hook","siteSpaceId":"sitesp_wqN6M","description":"useConvaiClient manages all Convai connection logic, audio/video pipelines, and message flows.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"React","icon":"react"}]},{"id":"VVA0bI3FaMJjHAXp7Ce4","title":"ConvaiWidget","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/react/convaiwidget","siteSpaceId":"sitesp_wqN6M","description":"ConvaiWidget is an all-in-one interface for voice, text, video, and screen sharing.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"React","icon":"react"}]},{"id":"BsYjAXPL7ouWHomF7333","title":"Real-time Lipsync","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/react/real-time-lipsync","siteSpaceId":"sitesp_wqN6M","description":"Integrate real-time facial animation in your React applications.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"React","icon":"react"}]},{"id":"pnBdTq1ZprIrW02nBrkE","title":"Custom UI & Advanced Usage","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/react/custom-ui-and-advanced-usage","siteSpaceId":"sitesp_wqN6M","description":"Build your own UI while using Convai’s audio pipelines and message system.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"React","icon":"react"}]},{"id":"69dkBZG1to4kDHLmJYeP","title":"Audio Visualizer (Optional)","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/react/audio-visualizer-optional","siteSpaceId":"sitesp_wqN6M","description":"You can create real-time visualizations from the bot’s audio using Web Audio + the WebRTC room.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"React","icon":"react"}]},{"id":"mskfPzpQqd1cn7uDGJGm","title":"Vanilla Typescript","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript","siteSpaceId":"sitesp_wqN6M","icon":"js","description":"Complete guide for using @convai/web-sdk with vanilla TypeScript applications (no React or framework required). Use the ConvaiClient class directly, wire up events, and build your own UI.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"}]},{"id":"hoQvlTU9Xdyx4zRfPNAo","title":"ConvaiClient (Core API)","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/convaiclient-core-api","siteSpaceId":"sitesp_wqN6M","description":"ConvaiClient is the main class for managing Convai in vanilla TypeScript.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"Vanilla Typescript","icon":"js"}]},{"id":"MXjYUMCl5Jq7hr0wdRLg","title":"Events & Message Handling","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/events-and-message-handling","siteSpaceId":"sitesp_wqN6M","description":"ConvaiClient provides a strongly typed event system. Use client.on(event, handler) to subscribe.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"Vanilla Typescript","icon":"js"}]},{"id":"skNItzZaOkTbepJMsmUF","title":"Real-time Lipsync","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/real-time-lipsync","siteSpaceId":"sitesp_wqN6M","description":"Integrate real-time facial animation in vanilla JavaScript/TypeScript applications.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"Vanilla Typescript","icon":"js"}]},{"id":"XcLdxS5Xkd0vnutCN9a5","title":"Building a Custom UI (TypeScript)","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/building-a-custom-ui-typescript","siteSpaceId":"sitesp_wqN6M","description":"This page shows how to wire up a simple DOM-based chat UI using vanilla TypeScript.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"Vanilla Typescript","icon":"js"}]},{"id":"Ao6AKyD9m1Dhix32kGFx","title":"Best Practices & Type Definitions","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/best-practices-and-type-definitions","siteSpaceId":"sitesp_wqN6M","description":"A summary of recommended patterns and the main TypeScript types for quick reference.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"Vanilla Typescript","icon":"js"}]},{"id":"zryHbFTZ6NP3reRcdOj3","title":"Mappings Reference","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/mappings-reference","siteSpaceId":"sitesp_wqN6M","description":"","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"Vanilla Typescript","icon":"js"}]},{"id":"IsbUg2Vo0tvBQTliqShZ","title":"Quickstart","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/quickstart","siteSpaceId":"sitesp_wqN6M","icon":"forward-fast","description":"Get a Convai character speaking in your app in under five minutes.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"}]},{"id":"CtmoIx5N2jgYRITcb48k","title":"Lipsync & Blendshape","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/lipsync-and-blendshape","siteSpaceId":"sitesp_wqN6M","icon":"head-side-speak","description":"Drive real-time facial animation on 3D characters using blendshape data streamed alongside the bot's audio.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"}]},{"id":"TAz5xoB9ykfQi3tP2LRX","title":"Actions","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/actions","siteSpaceId":"sitesp_wqN6M","icon":"person-running","description":"Actions let the character decide what to do in your scene. You declare the available affordances at connect time; the character decides when and what to do based on the conversation.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"}]},{"id":"brSoliFuVGCEifdBfwhR","title":"Emotions","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/emotions","siteSpaceId":"sitesp_wqN6M","icon":"face-smile-plus","description":"Enable emotion detection to receive the character's emotional state during a conversation.Enable emotion detection to receive the character's emotional state alongside each response.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"}]},{"id":"sFpT256I5RmNHTSEwNSV","title":"Dynamic Context","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/dynamic-context","siteSpaceId":"sitesp_wqN6M","icon":"connectdevelop","description":"Inject real-time context into the character's understanding — game state, user preferences, scene changes — without reconnecting.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"}]},{"id":"WyjROD93MGIykd6sRYNa","title":"Long Term Memory","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/long-term-memory","siteSpaceId":"sitesp_wqN6M","icon":"brain","description":"Convai can remember things about your users across sessions. When you provide an `endUserId`, the character automatically builds and recalls long-term memories.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"}]},{"id":"L89pCRRDKa1Dt7pFtuFn","title":"Auth Tokens","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/auth-tokens","siteSpaceId":"sitesp_wqN6M","icon":"fingerprint","description":"For production apps, use a short-lived auth token instead of embedding your Convai API key in client-side code. The API key stays on your server; the client receives a token that expires after 1 hour.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"}]},{"id":"QOOOI31YjB7Tih8ktqsx","title":"Error Handling","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/error-handling","siteSpaceId":"sitesp_wqN6M","icon":"cloud-xmark","description":"The SDK surfaces errors through four channels. Each has a different scope and payload — knowing which one to use for a given scenario is the key to reliable apps.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"}]},{"id":"MiNDmyWrgUbQ50cb2Qvq","title":"WebSocket Transport Layer","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/websocket-transport-layer","siteSpaceId":"sitesp_wqN6M","icon":"webhook","description":"The SDK defaults to WebRTC for real-time voice conversations. In environments where WebRTC is unavailable, you can opt in to a WebSocket-based transport instead.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"}]},{"id":"i6rUAK1CuEI8BPWN76eT","title":"Event Reference","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/event-reference","siteSpaceId":"sitesp_wqN6M","icon":"arrow-up-small-big","description":"Subscribe with `client.on(event, callback)`. The return value is an unsubscribe function.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"}]},{"id":"n9v4tFFO4pRJ6O541ZRa","title":"PlayCanvas Plugin","pathname":"/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin","siteSpaceId":"sitesp_wqN6M","description":"PlayCanvas template for Convai integration.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"}]},{"id":"QgtCmdlCRV50DHC1iEtC","title":"Adding External Script","pathname":"/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin/adding-external-script","siteSpaceId":"sitesp_wqN6M","description":"Adding External Script - PlayCanvas Plugin Guide for Convai integration.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"PlayCanvas Plugin"}]},{"id":"Fk34BucslC2wJcI0XFFW","title":"First Person View","pathname":"/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin/first-person-view","siteSpaceId":"sitesp_wqN6M","description":"First Person View - PlayCanvas Plugin Guide for Convai integration.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"PlayCanvas Plugin"}]},{"id":"QpyJz01hLP2wvlL4upOz","title":"Adding characters to scene","pathname":"/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin/adding-characters-to-scene","siteSpaceId":"sitesp_wqN6M","description":"Adding Characters to Scene - PlayCanvas Plugin Guide for Convai integration.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"PlayCanvas Plugin"}]},{"id":"cE5ZZSi57PuSNgUL4Xpu","title":"Character Animations","pathname":"/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin/character-animations","siteSpaceId":"sitesp_wqN6M","description":"Add character animations in PlayCanvas with Convai. Enhance your web projects with interactive AI.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"PlayCanvas Plugin"}]},{"id":"cxJUrJf4fgW8f1YGTzYv","title":"Convai Integration","pathname":"/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin/convai-integration","siteSpaceId":"sitesp_wqN6M","description":"Convai Integration - PlayCanvas Plugin Guide for seamless integration.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"PlayCanvas Plugin"}]},{"id":"Ep4ijjZn9V9P2RKuPGF0","title":"Chat Overlay","pathname":"/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin/chat-overlay","siteSpaceId":"sitesp_wqN6M","description":"Chat Overlay - PlayCanvas Plugin Guide for Convai integration.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"PlayCanvas Plugin"}]},{"id":"Kc2Von4OI1yH7YuY9OIh","title":"Narrative Design Guide","pathname":"/api-docs/plugins-and-integrations/web-plugins/narrative-design-guide","siteSpaceId":"sitesp_wqN6M","description":"Narrative Design - Narrative based NPCs with convai on web.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"}]},{"id":"D6uP7zLp4pbknqrkdSsa","title":"Narrative Design Triggers","pathname":"/api-docs/plugins-and-integrations/web-plugins/narrative-design-guide/narrative-design-triggers","siteSpaceId":"sitesp_wqN6M","description":"","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Narrative Design Guide"}]},{"id":"Qkt6MfVHhjdzZdrdSr9X","title":"Narrative Design Keys","pathname":"/api-docs/plugins-and-integrations/web-plugins/narrative-design-guide/narrative-design-keys","siteSpaceId":"sitesp_wqN6M","description":"This guide shows how to dynamically pass variables to Narrative Design section and triggers","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Narrative Design Guide"}]},{"id":"xSv83YrJNeitsFOaOxgm","title":"GLB/FBX animations for Convai","pathname":"/api-docs/plugins-and-integrations/web-plugins/glb-fbx-animations-for-convai","siteSpaceId":"sitesp_wqN6M","description":"Learn to integrate GLB and FBX animations into Convai's web plugin for dynamic character actions.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"}]},{"id":"WOPfcFOkzv1ZgtzuZceM","title":"Modding Framework","pathname":"/api-docs/plugins-and-integrations/modding-framework","siteSpaceId":"sitesp_wqN6M","description":"Convai introduces a Modding Framework, enabling easy integration of AI-driven NPCs into games across engines like Unreal, Unity, and more.","breadcrumbs":[{"label":"Plugins & Integrations"}]},{"id":"GH02p9AZOVvnhbp1Sb4E","title":"Modding Cyberpunk 2077","pathname":"/api-docs/plugins-and-integrations/modding-framework/modding-cyberpunk-2077","siteSpaceId":"sitesp_wqN6M","description":"This guide will show you how to make Mods that add Convai's features to Cyberpunk 2077","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Modding Framework"}]},{"id":"UISZJcESbADnVXDFGLET","title":"Other Integrations","pathname":"/api-docs/plugins-and-integrations/other-integrations","siteSpaceId":"sitesp_wqN6M","description":"","breadcrumbs":[{"label":"Plugins & Integrations"}]},{"id":"GqV13lmDXJ8bTbW3cmZV","title":"Third-Party API Integrations","pathname":"/api-docs/plugins-and-integrations/other-integrations/third-party-api-integrations","siteSpaceId":"sitesp_wqN6M","description":"Integrate external APIs like ElevenLabs to enhance your applications with advanced features.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Other Integrations"}]},{"id":"8dkGWxai0jzPFeE7OVza","title":"ElevenLabs API Integration","pathname":"/api-docs/plugins-and-integrations/other-integrations/third-party-api-integrations/elevenlabs-api-integration","siteSpaceId":"sitesp_wqN6M","description":"This is a guide on how to integrate your ElevenLabs voices with Convai characters","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Other Integrations"},{"label":"Third-Party API Integrations"}]},{"id":"mCC3cioDPzGqMj6BUUat","title":"Convai Pixel Streaming Embed","pathname":"/api-docs/plugins-and-integrations/convai-pixel-streaming-embed","siteSpaceId":"sitesp_wqN6M","description":"","breadcrumbs":[{"label":"Plugins & Integrations"}]},{"id":"Iwsgfz11iH7bumaekCAn","title":"Whitelisting & Publishing an Experience","pathname":"/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/whitelisting-and-publishing-an-experience","siteSpaceId":"sitesp_wqN6M","icon":"chalkboard","description":"Learn how to publish your scene and whitelist domains to embed Convai experiences securely in your web application.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Pixel Streaming Embed"}]},{"id":"HYyLcups49ZlTYkAC5N6","title":"React Typescript","pathname":"/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/react-typescript","siteSpaceId":"sitesp_wqN6M","icon":"react","description":"Set up and integrate Convai's Pixel Streaming component in your React TypeScript app using @convai/experience-embed.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Pixel Streaming Embed"}]},{"id":"l8vv3zd6ARamfWWoZHLp","title":"ReactJS (JavaScript)","pathname":"/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/reactjs-javascript","siteSpaceId":"sitesp_wqN6M","icon":"react","description":"Integrate Convai's Pixel Streaming into your React JavaScript app using the @convai/experience-embed component.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Pixel Streaming Embed"}]},{"id":"Bl1WM6LpsANKMtp0LQOW","title":"Vanilla JavaScript (ES Modules)","pathname":"/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/vanilla-javascript-es-modules","siteSpaceId":"sitesp_wqN6M","icon":"js","description":"Use Convai's Pixel Streaming client directly in browser-based JavaScript apps with native ES module support.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Pixel Streaming Embed"}]},{"id":"MhibeeodX75C0pjpQiDH","title":"CDN (UMD Script)","pathname":"/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/cdn-umd-script","siteSpaceId":"sitesp_wqN6M","icon":"js","description":"Integrate Convai's Pixel Streaming into your web app using the UMD build directly from a CDN","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Pixel Streaming Embed"}]},{"id":"SKht31jhLhAvwhNt1BBj","title":"On Premise Deployment","pathname":"/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/on-premise-deployment","siteSpaceId":"sitesp_wqN6M","icon":"building","description":"Configure Convai’s Pixel Streaming client to connect with your own backend and streaming servers for on-premise or self-hosted deployments.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Pixel Streaming Embed"}]},{"id":"MWe8NjQDMtLGGeNG14mq","title":"API Reference","pathname":"/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/api-reference","siteSpaceId":"sitesp_wqN6M","icon":"webhook","description":"Explore the available props, options, and methods for using Convai's Pixel Streaming client across React, Vanilla JS, TypeScript, and CDN setups.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Pixel Streaming Embed"}]},{"id":"aHV8dG6zd7DRJsjbazzV","title":"Asset Uploader","pathname":"/api-docs/plugins-and-integrations/asset-uploader","siteSpaceId":"sitesp_wqN6M","description":"Upload Metahumans, Reallusion characters, and scenes from Unreal Engine to Convai Sim and Avatar Studio using the Convai Asset Uploader tool.","breadcrumbs":[{"label":"Plugins & Integrations"}]},{"id":"s3lrIqucxPSGo95OOgM0","title":"Core API Reference","pathname":"/api-docs/api-reference/core-api-reference","siteSpaceId":"sitesp_wqN6M","description":"Explore Convai’s Core APIs, divided into Character Crafting and Interaction APIs, to create, customize, and interact with intelligent AI characters.","breadcrumbs":[{"label":"API Reference"}]},{"id":"gsTUYbL4ZFKCtOINokQj","title":"Character Crafting APIs","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis","siteSpaceId":"sitesp_wqN6M","description":"Create and configure AI characters with Convai’s Character Crafting APIs to define their personality, behavior, knowledge and more.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"}]},{"id":"XWE3BRSoU4D0tOAIAYF9","title":"Character Base API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/character-api","siteSpaceId":"sitesp_wqN6M","description":"All the relevant APIs needed to create your own intelligent AI characters with Convai.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"FFi1yUiXmETgoUw75AHX","title":"Backstory API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/backstory-api","siteSpaceId":"sitesp_wqN6M","description":"Learn how to use the Backstory API to create and manage character backstories, adding depth and personality to your NPCs.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"UOtHPa6ISx9iKUY1oY8f","title":"Mindview API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/mindview-api","siteSpaceId":"sitesp_wqN6M","description":"Learn how to use the Backstory API to create and manage character backstories, adding depth and personality to your NPCs.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"G8p6SIjsyhuaiIN7rkWz","title":"Core AI Settings API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/core-ai-settings-api","siteSpaceId":"sitesp_wqN6M","description":"All the relevant APIs needed to modify Core AI setting of your Convai Character.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"oCIidcCW4TDhTMwOM7W8","title":"Narrative Design API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/narrative-design-api","siteSpaceId":"sitesp_wqN6M","description":"The page list all the APIs needed to interact Narrative Design","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"3ggYWwe3Bv6K0A4KMVjn","title":"Knowledge Bank API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/knowledge-bank-api","siteSpaceId":"sitesp_wqN6M","description":"All the relevant APIs needed to interact with Knowledge Bank for you AI characters with Convai.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"w9NkMyt9Xl0jW2J3XPzO","title":"Action API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/action-api","siteSpaceId":"sitesp_wqN6M","description":"This page describes the Action API and how to use it.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"5Wcbc7O4hgMexjJCzSIt","title":"Chat History API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/chat-history-api","siteSpaceId":"sitesp_wqN6M","description":"All the relevant APIs needed to interact with Chat History of a session or character.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"XWKGoRyiqLL5CSNGM93v","title":"Evaluation API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/evaluation-api","siteSpaceId":"sitesp_wqN6M","description":"API to evaluate a conversation transcript based on user defined attributes (e.g. clarity of responses, courtesy, listening skills, and more).","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"MteKvBX7fweeVkU90Ry4","title":"Language List API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/language-list-api","siteSpaceId":"sitesp_wqN6M","description":"API to retrieve the full list of languages, both public and private, available to a user.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"PfsvJRo5OzlyGVrnZG06","title":"Voice List API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/voice-list-api","siteSpaceId":"sitesp_wqN6M","description":"API to retrieve the full list of voices, both public and private, available to a user.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"oO9thYF55EFX4iuE7zxC","title":"Character List API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/character-list-api","siteSpaceId":"sitesp_wqN6M","description":"API to retrieve the list of characters, created by a user.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"fne9do28bEO2Kg1iO5GS","title":"Live APIs (Beta)","pathname":"/api-docs/api-reference/core-api-reference/live-apis-beta","siteSpaceId":"sitesp_wqN6M","description":"Enable real-time, low-latency interaction with Convai AI characters through WebRTC-based Live APIs that support text, audio, and dynamic contextual communication.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"}]},{"id":"KRZRHxk7U8Q3yHwi9YFj","title":"Connect API","pathname":"/api-docs/api-reference/core-api-reference/live-apis-beta/connect-api","siteSpaceId":"sitesp_wqN6M","description":"Establish a live chatbot session for your Convai character, enabling users to connect via audio or video and maintain conversational context.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Live APIs (Beta)"}]},{"id":"8d9VYXokFuzhWLEylqwu","title":"Metrics","pathname":"/api-docs/api-reference/core-api-reference/live-apis-beta/metrics","siteSpaceId":"sitesp_wqN6M","description":"This page explains the metrics sent to clients over the WebRTC data channel.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Live APIs (Beta)"}]},{"id":"Zc962pHlSz8gkDgP6twF","title":"Audio Data (via data channel)","pathname":"/api-docs/api-reference/core-api-reference/live-apis-beta/audio-data-via-data-channel","siteSpaceId":"sitesp_wqN6M","description":"This page explains the metrics sent to clients over the WebRTC data channel.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Live APIs (Beta)"}]},{"id":"sSGFU83mQqghMh4MsRmp","title":"Message Glossary","pathname":"/api-docs/api-reference/core-api-reference/live-apis-beta/message-glossary","siteSpaceId":"sitesp_wqN6M","description":"Complete glossary of all message types available in Convai's Live APIs for real-time communication between clients and the server.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Live APIs (Beta)"}]},{"id":"wSmBAKZXKPsKEwIbphpj","title":"Client-to-server messages","pathname":"/api-docs/api-reference/core-api-reference/live-apis-beta/client-to-server-messages","siteSpaceId":"sitesp_wqN6M","description":"Reference for all messages a client sends to Convai's Live API server over the WebRTC data channel, including payloads, fields, and response details.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Live APIs (Beta)"}]},{"id":"HoQ5XhrSyrgJpxu9Dw4R","title":"Server-to-client messages","pathname":"/api-docs/api-reference/core-api-reference/live-apis-beta/server-to-client-messages","siteSpaceId":"sitesp_wqN6M","description":"Complete reference for all messages Convai sends to the client over a WebRTC data channel in Live APIs, including fields, types, and recommended actions.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Live APIs (Beta)"}]},{"id":"hIPRKZO2HDe3YYFi3g7J","title":"Interaction APIs","pathname":"/api-docs/api-reference/core-api-reference/interaction-apis","siteSpaceId":"sitesp_wqN6M","description":"Enable real-time interaction with AI characters using Convai’s Interaction APIs for natural text and voice-based communication.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"}]},{"id":"NOI4Ph3RXtXVmdFcNVoU","title":"Interaction API","pathname":"/api-docs/api-reference/core-api-reference/interaction-apis/interaction-api","siteSpaceId":"sitesp_wqN6M","description":"This page details on how you can interact with Character.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Interaction APIs"}]},{"id":"6f135ff60f109a9e3d7c93fea1aad129de678828","title":"欢迎","pathname":"/api-docs/zh","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"从这里开始，使用 Convai 创建、自定义、测试并分享交互式 AI 角色，涵盖 Playground、无代码体验、插件与集成，以及 API 参考。"},{"id":"3ddadf6aef4518e6a47bf57746bc1c930d8ada1c","title":"开始使用","pathname":"/api-docs/zh/convai-you-le-chang/get-started","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai Playground 入门第一步的引导概览，包括导航、角色创建、测试以及关键全局控制。","breadcrumbs":[{"label":"Convai 游乐场"}]},{"id":"6c3ae92c5b619c9daf08d1610b3d8f83941f7fd1","title":"仪表板概览","pathname":"/api-docs/zh/convai-you-le-chang/get-started/dashboard-overview","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解如何导航并使用 Convai Playground 仪表板，以高效管理角色、体验和模拟。","breadcrumbs":[{"label":"Convai 游乐场"},{"label":"开始使用"}]},{"id":"9d0648d563c3c90d538e52769c207ece07cfa734","title":"创建新角色","pathname":"/api-docs/zh/convai-you-le-chang/get-started/creating-a-new-character","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解如何在 Convai Playground 中创建并自定义一个新的 AI 角色，包括描述、头像、声音和语言设置。","breadcrumbs":[{"label":"Convai 游乐场"},{"label":"开始使用"}]},{"id":"d2e6d58722d7a0bb69032003bfd62cd90652e945","title":"测试角色","pathname":"/api-docs/zh/convai-you-le-chang/get-started/testing-a-character","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解在 Convai Playground 中测试 AI 角色的不同方式，包括文本聊天、语音输入以及带头像的视频通话。","breadcrumbs":[{"label":"Convai 游乐场"},{"label":"开始使用"}]},{"id":"b58ddec701ace47683fa122d7d87fc82ca32acbd","title":"全局角色控制","pathname":"/api-docs/zh/convai-you-le-chang/get-started/global-character-controls","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"一份适用于 Convai Playground 中所有角色页面的共享工具栏控制参考，包括版本管理、更新和角色设置。","breadcrumbs":[{"label":"Convai 游乐场"},{"label":"开始使用"}]},{"id":"9a32b39467a0f489a95113573658ff7ff8c6673d","title":"角色版本管理","pathname":"/api-docs/zh/convai-you-le-chang/get-started/character-versioning","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"管理角色的多个版本，并按需在它们之间切换。","breadcrumbs":[{"label":"Convai 游乐场"},{"label":"开始使用"}]},{"id":"8270737ea01160ec13124c1396e30d590fa5cf88","title":"使用语音模式交互","pathname":"/api-docs/zh/convai-you-le-chang/get-started/interact-in-voice-mode","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用语音模式与您的 Convai 角色进行实时、低延迟的语音对话，实现自然、免手操作的交互。","breadcrumbs":[{"label":"Convai 游乐场"},{"label":"开始使用"}]},{"id":"8da3b49d5f4fcbb4d881a706a3b666489d4c7c7a","title":"角色自定义","pathname":"/api-docs/zh/convai-you-le-chang/character-customization","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解如何优化 AI 角色的个性、外观、知识和行为，以创建一致且引人入胜的交互。","breadcrumbs":[{"label":"Convai 游乐场"}]},{"id":"fb9189d47cf610f35aad8659514f1f245625c6d4","title":"角色描述","pathname":"/api-docs/zh/convai-you-le-chang/character-customization/character-description","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解如何在 Convai Playground 中使用角色描述页面来定义角色的身份、说话风格和独特特征。","breadcrumbs":[{"label":"Convai 游乐场"},{"label":"角色自定义"}]},{"id":"9b91b60cf0a344b26f8736b512b0c9c54e05e365","title":"Avatar Studio","pathname":"/api-docs/zh/convai-you-le-chang/character-customization/avatar-section","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解如何使用 Avatar Studio 在 Convai Playground 中访问并自定义角色的头像。","breadcrumbs":[{"label":"Convai 游乐场"},{"label":"角色自定义"}]},{"id":"82227f72ca96afab32d1b36eb1030f723fc92d40","title":"语言与语音","pathname":"/api-docs/zh/convai-you-le-chang/character-customization/language-and-speech","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解如何在 Convai Playground 中为你的 AI 角色配置语言、声音、自定义发音和词语识别。","breadcrumbs":[{"label":"Convai 游乐场"},{"label":"角色自定义"}]},{"id":"fc5ee3f87db5832224309e209e9414c77416a6aa","title":"知识库","pathname":"/api-docs/zh/convai-you-le-chang/character-customization/knowledge-bank","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解如何使用 Knowledge Bank 上传、管理并将知识文件连接到你的 AI 角色。","breadcrumbs":[{"label":"Convai 游乐场"},{"label":"角色自定义"}]},{"id":"77f16a3d1bd78431fb224a2d4f85b5c53ce4e7f4","title":"性格特征","pathname":"/api-docs/zh/convai-you-le-chang/character-customization/personality-traits","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解如何使用预设或手动调整特征来自定义 AI 角色的性格。","breadcrumbs":[{"label":"Convai 游乐场"},{"label":"角色自定义"}]},{"id":"3902616748bbe45ac5deb138f57de133b09cc322","title":"核心 AI 设置","pathname":"/api-docs/zh/convai-you-le-chang/character-customization/core-ai-settings","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解如何为你的 AI 角色配置审核、基础模型选择和温度参数。","breadcrumbs":[{"label":"Convai 游乐场"},{"label":"角色自定义"}]},{"id":"d255c317455ccb689552565ac194b12bd993b49e","title":"护栏","pathname":"/api-docs/zh/convai-you-le-chang/character-customization/guardrails","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"护栏选项卡是一个安全与控制界面，旨在限制并引导角色的 AI 行为。它允许创作者定义对话的伦理和主题边界。","breadcrumbs":[{"label":"Convai 游乐场"},{"label":"角色自定义"}]},{"id":"f7a43893ebc2e4f005faf9a3cafc7c755a381798","title":"心理状态","pathname":"/api-docs/zh/convai-you-le-chang/character-customization/state-of-mind","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解“心理状态”功能如何在对话过程中实时可视化你的 AI 角色的情绪状态。","breadcrumbs":[{"label":"Convai 游乐场"},{"label":"角色自定义"}]},{"id":"b7c28cd67554b10ad62e2e4407395a1b1c4ec65e","title":"记忆","pathname":"/api-docs/zh/convai-you-le-chang/character-customization/memory","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解如何使用记忆功能来回顾过去的会话、管理对话历史，并为角色启用长期记忆。","breadcrumbs":[{"label":"Convai 游乐场"},{"label":"角色自定义"}]},{"id":"12a793c25c010da0895131ee69fbe23a78ebf7df","title":"Mindview","pathname":"/api-docs/zh/convai-you-le-chang/character-customization/mindview","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解如何使用 Mindview 功能来查看当前或之前会话与交互中发送给 LLM 的实际提示词。","breadcrumbs":[{"label":"Convai 游乐场"},{"label":"角色自定义"}]},{"id":"55f4d0a125ab988f4603436fa20ceb69b527078d","title":"叙事设计 | Playground","pathname":"/api-docs/zh/convai-you-le-chang/character-customization/narrative-design","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用章节、决策和触发器构建以目标为导向的对话流程，在不依赖僵硬对话树的情况下推动故事发展。","breadcrumbs":[{"label":"Convai 游乐场"},{"label":"角色自定义"}]},{"id":"35a651a7ec0db43442e55c78416b30d4088df26c","title":"外部 API","pathname":"/api-docs/zh/convai-you-le-chang/character-customization/external-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解如何集成和配置 External API 功能，使你的角色能够访问实时信息、创建任务并与第三方平台交互。","breadcrumbs":[{"label":"Convai 游乐场"},{"label":"角色自定义"}]},{"id":"bd6c17b299278bbe9717031b2d904513f0a1b8ea","title":"发布","pathname":"/api-docs/zh/convai-you-le-chang/character-customization/publish","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解如何将你的 Convai 体验发布并分享给公众、选定用户，或嵌入到你自己的网站中。","breadcrumbs":[{"label":"Convai 游乐场"},{"label":"角色自定义"}]},{"id":"3ba9f518c07e0a87b9e36b8d6c50c2afb849bcdd","title":"Avatar Studio 体验","pathname":"/api-docs/zh/wu-dai-ma-ti-yan/avatar-studio-experiences","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"直接在浏览器中创建智能 3D AI 头像——无需下载、无需代码、完全可自定义。","breadcrumbs":[{"label":"无代码体验"}]},{"id":"dff36a62c79d27f2e915c3c67a004ad142e173aa","title":"自定义你的头像","pathname":"/api-docs/zh/wu-dai-ma-ti-yan/avatar-studio-experiences/customizing-your-avatar","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解如何使用 Avatar Studio 配置器从外观和行为上个性化你的 Convai 头像。","breadcrumbs":[{"label":"无代码体验"},{"label":"Avatar Studio 体验"}]},{"id":"2eec60cad685ce0fd0431ef63921f9d76e5adc82","title":"配置头像","pathname":"/api-docs/zh/wu-dai-ma-ti-yan/avatar-studio-experiences/customizing-your-avatar/configure-avatar","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解如何在 Avatar Studio 中选择、自定义或上传头像。","breadcrumbs":[{"label":"无代码体验"},{"label":"Avatar Studio 体验"},{"label":"自定义你的头像"}]},{"id":"08d64510deae0f0a9e7b3a8cafa1c15aa507b85e","title":"上传头像","pathname":"/api-docs/zh/wu-dai-ma-ti-yan/avatar-studio-experiences/customizing-your-avatar/configure-avatar/uploading-avatars","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"","breadcrumbs":[{"label":"无代码体验"},{"label":"Avatar Studio 体验"},{"label":"自定义你的头像"},{"label":"配置头像"}]},{"id":"69cb60fe0b9585cb40eca5a1c91e3a0e96d346ef","title":"Metahuman 头像","pathname":"/api-docs/zh/wu-dai-ma-ti-yan/avatar-studio-experiences/customizing-your-avatar/configure-avatar/uploading-avatars/metahuman-avatars","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用 Convai Asset Uploader 将 Unreal Engine 中的自定义 Metahuman 角色上传到 Avatar Studio。","breadcrumbs":[{"label":"无代码体验"},{"label":"Avatar Studio 体验"},{"label":"自定义你的头像"},{"label":"配置头像"},{"label":"上传头像"}]},{"id":"3069faf39cce4edbd0215d51e68dfd2c35d9b04c","title":"Reallusion 头像","pathname":"/api-docs/zh/wu-dai-ma-ti-yan/avatar-studio-experiences/customizing-your-avatar/configure-avatar/uploading-avatars/reallusion-avatars","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用 Convai Asset Uploader 将 Unreal Engine 中的自定义 Reallusion 角色上传到 Avatar Studio。","breadcrumbs":[{"label":"无代码体验"},{"label":"Avatar Studio 体验"},{"label":"自定义你的头像"},{"label":"配置头像"},{"label":"上传头像"}]},{"id":"7017373e50705228a25583a56312772765beed75","title":"面部滤镜","pathname":"/api-docs/zh/wu-dai-ma-ti-yan/avatar-studio-experiences/customizing-your-avatar/face-filter","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用 Face Filter 功能，让你的头像根据照片看起来像某个特定的人。","breadcrumbs":[{"label":"无代码体验"},{"label":"Avatar Studio 体验"},{"label":"自定义你的头像"}]},{"id":"717ec649db58a97d1c116add9b16ecc4355ae4b7","title":"环境","pathname":"/api-docs/zh/wu-dai-ma-ti-yan/avatar-studio-experiences/customizing-your-avatar/environment","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"从沉浸式 3D 环境和纯色环境中进行选择，为你的头像放置合适的场景。","breadcrumbs":[{"label":"无代码体验"},{"label":"Avatar Studio 体验"},{"label":"自定义你的头像"}]},{"id":"9a854a2626cd6617406cf7011d20e9d74ee13182","title":"灯光调整","pathname":"/api-docs/zh/wu-dai-ma-ti-yan/avatar-studio-experiences/customizing-your-avatar/lighting-adjustments","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"","breadcrumbs":[{"label":"无代码体验"},{"label":"Avatar Studio 体验"},{"label":"自定义你的头像"}]},{"id":"a99454e1cd982580b2ea03503364c73ddd0200ba","title":"动画与表情设置","pathname":"/api-docs/zh/wu-dai-ma-ti-yan/avatar-studio-experiences/customizing-your-avatar/animation-and-expression-settings","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"通过面部与身体动画、情绪以及智能动作，自定义头像的表现力。","breadcrumbs":[{"label":"无代码体验"},{"label":"Avatar Studio 体验"},{"label":"自定义你的头像"}]},{"id":"914b1154df781399e64e28338efa104383a545a4","title":"界面配置","pathname":"/api-docs/zh/wu-dai-ma-ti-yan/avatar-studio-experiences/customizing-your-avatar/interface-configuration","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"根据你的设备、场景和品牌需求，定制头像体验的视觉与功能界面。","breadcrumbs":[{"label":"无代码体验"},{"label":"Avatar Studio 体验"},{"label":"自定义你的头像"}]},{"id":"30f61bbae4f14dac8883675027b135332e532c74","title":"体验设置","pathname":"/api-docs/zh/wu-dai-ma-ti-yan/avatar-studio-experiences/customizing-your-avatar/experience-settings","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"控制空闲会话处理、欢迎交互、麦克风行为和输入处理时序，以微调你的头像体验。","breadcrumbs":[{"label":"无代码体验"},{"label":"Avatar Studio 体验"},{"label":"自定义你的头像"}]},{"id":"e73c5e970a5526f874202d547b7c060665a0d62e","title":"发布 Avatar Studio 体验","pathname":"/api-docs/zh/wu-dai-ma-ti-yan/avatar-studio-experiences/customizing-your-avatar/publishing-an-experience","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解如何发布并分享你自定义的头像体验，以便在网页、信息亭、应用等场景中使用。","breadcrumbs":[{"label":"无代码体验"},{"label":"Avatar Studio 体验"},{"label":"自定义你的头像"}]},{"id":"96cc4c4fdbe90a5da34809971891e0bd7836bd69","title":"Convai Sim 体验","pathname":"/api-docs/zh/wu-dai-ma-ti-yan/convai-sim-experiences","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"直接从浏览器创建由 AI 驱动的头像，并将其部署到交互式 3D 环境中。","breadcrumbs":[{"label":"无代码体验"}]},{"id":"3fb0c045c8c8d711550fad03c688fee08a390b6c","title":"使用 Convai Sim 创建你的 AI 模拟","pathname":"/api-docs/zh/wu-dai-ma-ti-yan/convai-sim-experiences/creating-your-ai-simulation-with-convai-sim","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"通过使用 Convai Sim 将你的 Convai 角色放入 3D 交互式环境中，让它们栩栩如生。","breadcrumbs":[{"label":"无代码体验"},{"label":"Convai Sim 体验"}]},{"id":"3fb84686d8c241a8b940793c315b93739f4b3f23","title":"头像自定义","pathname":"/api-docs/zh/wu-dai-ma-ti-yan/convai-sim-experiences/avatar-customization","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"在你的 3D 模拟场景中微调已部署头像的外观、大小和位置。","breadcrumbs":[{"label":"无代码体验"},{"label":"Convai Sim 体验"}]},{"id":"7621721bb73d0af404b5ec72ed667af1a1d4b772","title":"导游","pathname":"/api-docs/zh/wu-dai-ma-ti-yan/convai-sim-experiences/tour-guide","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用 Convai Sim 内置的导览规划工具，将你的 AI 头像变成交互式导游。","breadcrumbs":[{"label":"无代码体验"},{"label":"Convai Sim 体验"}]},{"id":"2afd43c8b238cf984dbb32fffecaae7d7c132c2f","title":"发布 Convai Sim 体验","pathname":"/api-docs/zh/wu-dai-ma-ti-yan/convai-sim-experiences/publishing-an-experience","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解如何完成并发布你使用 Convai Sim 创建的 AI 模拟或导游体验。","breadcrumbs":[{"label":"无代码体验"},{"label":"Convai Sim 体验"}]},{"id":"61e662fd00486df309596ec84442b4293fb7ec38","title":"Convai XR 动画捕捉应用","pathname":"/api-docs/zh/wu-dai-ma-ti-yan/convai-xr-animation-capture-app","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用 Meta Quest 在 VR 中捕捉动画并为 AI 头像制作动画——无需动捕服。","breadcrumbs":[{"label":"无代码体验"}]},{"id":"a8ca34e2bbeb639b27887f21d063fdc21e79800e","title":"Convai XR 动画捕捉应用设置","pathname":"/api-docs/zh/wu-dai-ma-ti-yan/convai-xr-animation-capture-app/convai-xr-animation-capture-app-setup","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解如何在 Meta Quest 头显上安装并连接 Convai XR Animation Capture App，以开始在 VR 中录制头像动画。","breadcrumbs":[{"label":"无代码体验"},{"label":"Convai XR 动画捕捉应用"}]},{"id":"f7e2dbe108d524921e5f35236dd9811255db013a","title":"为 AI 头像创建动画","pathname":"/api-docs/zh/wu-dai-ma-ti-yan/convai-xr-animation-capture-app/creating-animations-for-ai-avatars","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用 Meta Quest 头显捕捉逼真的动画，让你的 AI 头像活起来——无需动捕服。","breadcrumbs":[{"label":"无代码体验"},{"label":"Convai XR 动画捕捉应用"}]},{"id":"20afa40933a7777f08f1fe5a7f96d23369af5f89","title":"将你录制的动画添加到 Unity 中的 AI 头像","pathname":"/api-docs/zh/wu-dai-ma-ti-yan/convai-xr-animation-capture-app/adding-your-recorded-animations-to-ai-avatars-inside-unity","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解如何导入在 VR 中录制的动画并将其应用到 Unity 中的 AI 头像。","breadcrumbs":[{"label":"无代码体验"},{"label":"Convai XR 动画捕捉应用"}]},{"id":"b2cc3c7d3566dc93d513f57afe9d014930891db7","title":"Convai Unity SDK","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"将实时 AI 角色添加到 Unity 培训模拟、交互式体验和游戏中——支持语音、情感、动作和持久记忆。","breadcrumbs":[{"label":"插件与集成"}]},{"id":"e1b58f4b7b487b6896c74198b666a3fa66d13506","title":"Convai Unity SDK 概览","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/overview","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找关于什么是 Convai Unity SDK、其四层架构如何组织，以及该包附带哪些功能模块的说明。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"}]},{"id":"5d4a64e01d8bbface45a1ab11ca7f85cb75a77ef","title":"什么是 Convai Unity SDK","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/overview/what-is-the-convai-unity-sdk","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"适用于 Unity 的实时对话式 AI 角色——语音管线、可选功能模块、支持的平台和最低要求。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"Convai Unity SDK 概览"}]},{"id":"5dbc3bfc03953952863c095fdc681a101736b9d2","title":"Convai Unity SDK 架构","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/overview/convai-unity-sdk-architecture","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 Convai Unity SDK 的四层架构——Runtime、Room、Agent 和 Module——以及各层的职责。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"Convai Unity SDK 概览"}]},{"id":"c8899f56d4e857b17f25df9ab7da1ed0213d1d5f","title":"功能地图","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/overview/feature-map","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"按使用场景索引，为任何开发目标找到合适的 Convai Unity SDK 功能、模块、指南或参考页面。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"Convai Unity SDK 概览"}]},{"id":"61cfb72bb1467fd3d8cfd00b7d7b8ce11d90740c","title":"发行说明","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/overview/release-notes","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai Unity SDK 的发行说明——当前版本亮点、先前发行说明、错误修复以及每次发布的迁移指南。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"Convai Unity SDK 概览"}]},{"id":"55576a48120f0ea393eac65ad3f16a76f2c8b45b","title":"兼容性与要求","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/compatibility-and-requirements","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"在安装 Convai Unity SDK 之前，找到你所需的 Unity 版本、渲染管线、平台和网络要求。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"}]},{"id":"cd8899e2abe48dfa45ad6d5c845fd73dfed1fdd9","title":"Unity 版本和渲染管线","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/compatibility-and-requirements/unity-versions-and-render-pipelines","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai Unity SDK 环境要求参考，包括最低 Unity 版本、所需包依赖项和渲染管线支持。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"兼容性与要求"}]},{"id":"d9f64c1a3c295b98fd7638d4cc75e01943fa23bc","title":"平台支持矩阵","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/compatibility-and-requirements/platform-support-matrix","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai Unity SDK 平台支持参考，包括 Windows、macOS、Android、iOS、Meta Quest 和 WebGL 上的功能可用性。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"兼容性与要求"}]},{"id":"70605859c41efad8e54d545f6c11bf507c578f33","title":"网络和 API 要求","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/compatibility-and-requirements/network-and-api-requirements","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai Unity SDK 网络访问参考，包括 Convai 和 LiveKit 主机、防火墙规则、身份验证以及基于日志的连接检查。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"兼容性与要求"}]},{"id":"5ea68df21c8a54f95779af92056a9ab831531be5","title":"开始使用","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/getting-started","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"从安装 Convai Unity SDK 到在场景中验证一个可用的对话式 AI 角色的逐步路径。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"}]},{"id":"61ac8f81d06838cca23d34c8e77b51e38e8affa5","title":"前提条件","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/getting-started/prerequisites","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai Unity SDK 的系统要求、Unity 版本、所需包和账户先决条件。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"开始使用"}]},{"id":"f1f8700aca8f1ecef5696ae3f482c57ceae1064c","title":"安装 Convai Unity SDK","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/getting-started/installation","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"通过 Package Manager 或 Asset Store 将 Convai Unity SDK 添加到你的 Unity 2023.1+ 项目中。两种方式安装的包相同。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"开始使用"}]},{"id":"3a95f57092cf5e9062d0377485e90f72b444fbd3","title":"配置 API 密钥","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/getting-started/configure-api-key","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"在 SDK Settings 窗口中输入并验证你的 Convai API 密钥，以便你的 Unity 项目进行身份验证并与 Convai 角色通信。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"开始使用"}]},{"id":"339e02ef9174c5dbcb43ce3f1d3e39f9753fd9ae","title":"导入并运行示例场景","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/getting-started/import-and-run-sample-scenes","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"导入随附的示例场景，并在构建你自己的场景之前验证 SDK 已正确安装并连接。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"开始使用"}]},{"id":"e9f6a66a2fa7574cb77509cf3bffb7e711540c85","title":"场景组件参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/getting-started/scene-components","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 ConvaiManager、ConvaiRoomManager、ConvaiCharacter 和 ConvaiPlayer 的作用，以及它们如何相互依赖。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"开始使用"}]},{"id":"2c636c36fad522854df1a097c056f4a12f1444ae","title":"构建自定义场景","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/getting-started/build-a-custom-scene","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用 Setup Required Components 命令向新的 Unity 场景添加所需的 Convai 组件，并配置你的第一个角色。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"开始使用"}]},{"id":"21a0b0c11649e9125ef5195167e66c3a2caaadf1","title":"验证你的设置","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/getting-started/validate-your-setup","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"运行场景验证工具，确认所有必需组件都已存在、已连接并正确配置。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"开始使用"}]},{"id":"26b817b7abe1379d0e73ce3dc01f1e053df39b56","title":"配置对话输入模式","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/getting-started/configure-conversation-input-mode","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"在免手语音激活和按键说话之间进行选择，并为你的项目配置触发键或按钮。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"开始使用"}]},{"id":"dc31c15bb8798169a403a964c726a9122812a736","title":"配置角色音频","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/getting-started/configure-character-audio","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"配置每个角色和整个项目的语音音量、空间音频和音频反馈，并在脚本中通过静音与取消静音调用控制播放。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"开始使用"}]},{"id":"17d06dd6ce948cddecd226cb498bd300a3508ab9","title":"配置麦克风","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/getting-started/configure-microphone","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"在运行时选择一个活动麦克风设备，设置项目级默认值，并为 Android、iOS 和 WebGL 构建配置平台权限。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"开始使用"}]},{"id":"674d9ab1d00b5f445771b7fa3360d5d499e8dee2","title":"添加聊天 UI","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/getting-started/add-chat-ui","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"添加随附的聊天转录预制体，以在角色交互期间在屏幕上显示滚动的对话历史。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"开始使用"}]},{"id":"ed9168a8079f978e6efcf4613ab9296537de8035","title":"添加口型同步","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/getting-started/add-lip-sync","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"将 Convai 音频输出连接到角色的面部 blendshape，同步嘴部动作与语音，并调整播放延迟。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"开始使用"}]},{"id":"60064eabc10799fef78f5bfba5ab16e07ed98015","title":"配置文件与映射","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/getting-started/add-lip-sync/profiles-and-mappings","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"参考控制 Convai blendshape 数据如何到达角色面部网格，以及何时创建自定义配置文件和映射的 profile 与 map 资源。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"开始使用"},{"label":"添加口型同步"}]},{"id":"23f7f0807dc9d3c6490dd0b0704dfd8092cd998e","title":"创建口型同步配置文件","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/getting-started/add-lip-sync/create-a-lip-sync-profile","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"创建 ConvaiLipSyncProfile 资源，为三种内置配置文件之外的 blendshape 格式定义自定义传输格式标识符。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"开始使用"},{"label":"添加口型同步"}]},{"id":"0808b43e9ba988a5156bb5fb55261f1f67638b57","title":"创建自定义口型同步映射","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/getting-started/add-lip-sync/create-a-custom-blendshape-map","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"创建一个口型同步映射，将传入的 blendshape 通道路由到角色网格，并可针对每个通道调整权重与夹紧。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"开始使用"},{"label":"添加口型同步"}]},{"id":"d8c18409ae9c4e08b59f112c685f31eedd8cba20","title":"AI 编码助手","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/ai-coding-assistant","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找通过 Convai 的支持 SDK 的 MCP 工具将 AI 编码代理连接到 Unity 的指南，包括设置、受支持的代理和故障排除。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"}]},{"id":"fef78cf340cc23d3c5966ea9c7099beadba8f247","title":"AI 编码助手快速入门","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/ai-coding-assistant/quick-start","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"打开 AI Coding Setup，接受 Unity MCP 条款，安装某个编码代理的说明，并验证 Convai 的 MCP 工具已准备就绪。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"AI 编码助手"}]},{"id":"ec47f18f1ec454c3afecbec3a73f8ab46981f55c","title":"受支持的编码代理","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/ai-coding-assistant/supported-coding-agents","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai Unity SDK 支持的编码代理参考，包括每个代理对应的精确说明文件路径和安装行为。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"AI 编码助手"}]},{"id":"2556d68ab00a9475a0e5c6ca8c0541b3d69dc561","title":"MCP 工具参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/ai-coding-assistant/mcp-tools-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"适用于编码代理的每个 Convai MCP 工具参考，包括默认启用状态和场景修改行为。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"AI 编码助手"}]},{"id":"19bff3d08fa0ba480410597a8a790b68a4f73b14","title":"排查 AI 编码助手设置问题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/ai-coding-assistant/troubleshooting","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"诊断并修复 Convai Unity SDK 中的 Unity MCP 桥重新连接、工具注册表刷新、过期工具拒绝以及 Unity AI Assistant 安装失败。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"AI 编码助手"}]},{"id":"b20dffbec401e06e9fe4168f409ab42a87fa327b","title":"核心概念","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/core-concepts","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 Convai Unity SDK 在运行时的工作方式说明——连接管理、会话状态、轮次切换和事件驱动的场景响应。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"}]},{"id":"4cf766d486eec86e65f9c3e4e1a71435373ac7ec","title":"运行时架构","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/core-concepts/runtime-architecture","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 Convai Unity SDK 的四层运行时——每一层负责什么、哪些组件可替换，以及 RuntimeState 转换如何管理。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"核心概念"}]},{"id":"1b034b7638b343540a3b205274bd08beaff9d15e","title":"会话生命周期","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/core-concepts/session-lifecycle","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 ConvaiCharacter 会话如何在各个状态之间转换、会话 ID 存储在哪里，以及如何配置重连和对话恢复行为。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"核心概念"}]},{"id":"251e0bf7030a5f742a1182e15529c0604e3ee150","title":"轮流发言模式","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/core-concepts/turn-taking-modes","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"TurnTakingOptions、SmartTurnSettings 和 PushToTalkPolicy 的参考——用于免手语音检测和按键说话模式的字段说明。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"核心概念"}]},{"id":"9e1663ddbf1fca5a96f17b81e99da40d8aee52e5","title":"语音活动检测","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/core-concepts/voice-activity-detection","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 Convai Unity SDK 如何在连接时仅一次解析用户的语音活动检测设置，使用 Convai 的默认值或你的自定义值。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"核心概念"}]},{"id":"0bd691fc4d8a06b0dbafd0f28b11f39be6f57f9a","title":"事件系统","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/core-concepts/event-system","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai 事件中继组件参考，包括可用事件、负载字段和用于场景逻辑的订阅模式。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"核心概念"}]},{"id":"8c561f7c198c46628ed5818040fdaa9af3397caf","title":"功能","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"}]},{"id":"48542e3f43c9fa4320574cae5c541c172f781a1d","title":"角色动作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/character-actions","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找用于 Convai 角色动作系统的快速入门指南、执行器参考、调度器配置、脚本 API 和使用示例。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"}]},{"id":"53aa8db086c9806f093f80741862dfe3316e77d8","title":"角色动作如何工作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/character-actions/how-character-actions-work","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 Convai 角色动作流水线——后端如何选择动作、Unity 如何解析目标，以及需要哪些组件。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"角色动作"}]},{"id":"7f0d213ddc809cfd39ab2bc41492ddf8e54b6c19","title":"角色动作快速入门","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/character-actions/quick-start","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"完全通过 Inspector 为你的 NPC 配置一个可工作的 Move To 动作，无需脚本，并确认它在 Play Mode 中运行。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"角色动作"}]},{"id":"111bca064ba7041a987662d038af4d71d58a32cd","title":"配置角色动作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/character-actions/configuring-actions","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"配置 Convai NPC 可使用的动作、对象和角色，然后在活动会话期间更新这些可供性。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"角色动作"}]},{"id":"4001c6ae3c6d4603942748007a37a67812bb7e9a","title":"在运行时更新角色动作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/character-actions/update-actions-at-runtime","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"在会话中发送动作配置补丁，跟踪其更新 ID，并在假定更改已生效前确认后端已确认。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"角色动作"}]},{"id":"f592d9dc3ad261e175159690b86cdd4b50bb4d81","title":"动作执行器","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/character-actions/action-executors","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"七个动作执行器组件的参考——注视、事件、NavMesh 移动、动画触发，以及复合拾取/放置执行器。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"角色动作"}]},{"id":"c5598abd0ddd72fa75a0989ad602a5b4d12e16d7","title":"编写自定义动作执行器","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/character-actions/writing-custom-executors","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"通过编写自己的执行器组件，将自定义移动、库存、UI 或物理行为连接到 Convai 动作流水线。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"角色动作"}]},{"id":"6e3c85bad169c9c2c755b38be39008ef3ce023cf","title":"调度器与批处理策略","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/character-actions/dispatcher-and-batch-policies","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"配置调度器的批处理策略、失败策略、语音门控超时以及角色动作执行的生命周期事件。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"角色动作"}]},{"id":"5b02ee57da9de48585f7ea92aa9e94714547d80a","title":"注意力与引用锚定","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/character-actions/attention-and-reference-grounding","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"在运行时更新 NPC 关注焦点，以便 Convai 将诸如“捡起那个”或“去那里”之类的模糊玩家引用解析为正确注册的场景对象。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"角色动作"}]},{"id":"0341126fa4c492311dab4fb6aca6d0c64191016b","title":"角色动作脚本参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/character-actions/actions-scripting-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai 角色动作系统的 API 参考——调度器类型、执行器接口、配置类、调用对象、结果类型和枚举。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"角色动作"}]},{"id":"0e9ccbf7f8fa10ad65f6395315d82ba64412791c","title":"角色动作示例","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/character-actions/usage-examples","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai 角色动作系统的渐进式示例——Inspector 设置、事件订阅、脚本化批量注入以及与语音同步的时序。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"角色动作"}]},{"id":"1398e3302b345ef93934a0e6c93b4d8e576ab00e","title":"排查角色动作问题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/character-actions/debugging-and-troubleshooting","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用两个调试工具诊断角色动作流水线和运行时状态问题，并提供常见故障的完整症状、原因与修复参考。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"角色动作"}]},{"id":"eb13f9c057b5d7a65a7d8338048c0f7def05d5cf","title":"动态上下文","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/dynamic-context","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找通过动态上下文中继、脚本 API 和同步世界对象属性将实时场景状态发送给 Convai 角色的指南。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"}]},{"id":"ea4c263729dd22d672acffa78f03bba30e097c52","title":"动态上下文如何工作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/dynamic-context/how-dynamic-context-works","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 Dynamic Context 如何跟踪场景状态和事件、批量更新，以及报告确认和令牌反馈。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"动态上下文"}]},{"id":"aad74412c9dc416577acffb5b0f1b8be3c9ad61d","title":"动态上下文快速入门","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/dynamic-context/dynamic-context-quick-start","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"向 NPC 添加 Dynamic Context Relay 组件，从 UI 按钮发送跟踪更新，并确认角色引用了它。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"动态上下文"}]},{"id":"743bcc7de155496cbbf02a52a5577aee99f28aab","title":"Relay 组件参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/dynamic-context/relay-component-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Dynamic Context relay 组件参考，涵盖其 Inspector 字段、公共方法、事件以及角色解析行为。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"动态上下文"}]},{"id":"133014bac66e10680112ab87148615bc885d33d7","title":"连接时的静态上下文","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/dynamic-context/static-context-at-connection-time","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"配置角色在对话开始时一次性接收的固定场景事实，区别于对话进行中发送的更新。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"动态上下文"}]},{"id":"bb1aef3496a2be08987c770aa7b8072e7d8c5cd6","title":"同步行为与时序","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/dynamic-context/sync-behavior-and-timing","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 SDK 如何在发送之前批量处理动态上下文更新，以及 Convai 如何确认动作和注意力变化。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"动态上下文"}]},{"id":"5c3f9bcc544ac6f441fe54139ac1c670eeb5c958","title":"动态上下文脚本 API","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/dynamic-context/dynamic-context-scripting-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai Unity SDK 动态上下文脚本接口参考，包括每个方法、respond 模式枚举和 attention 对象 API。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"动态上下文"}]},{"id":"493c8451db0d99cc31b81e26c17158c645622f0e","title":"动态上下文使用示例","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/dynamic-context/dynamic-context-usage-examples","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"五个 Dynamic Context 示例展示了由中继驱动的触发器、批量更新、事件日志、紧急转换以及同步的世界对象上下文。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"动态上下文"}]},{"id":"531d80b1af7cb4aba63c4979e0a4c0f8e029bc95","title":"排查动态上下文问题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/dynamic-context/troubleshoot-dynamic-context","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"修复 Convai Unity SDK 中常见的动态上下文问题，包括更新遗漏、响应延迟以及无法清除所有内容的重置行为。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"动态上下文"}]},{"id":"4fce72c6ad15ed3dd08bc857832b3067da875c10","title":"情绪","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/emotion","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找为 Convai 角色添加情绪响应式面部动画的指南——从快速设置到脚本 API 和故障排除。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"}]},{"id":"a169ddd3c944e6f42f2701922ad7b55a03ac789a","title":"情绪系统如何工作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/emotion/how-the-emotion-system-works","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解情绪管线——Convai 如何发送情绪信号、SDK 如何解析并平滑这些信号，以及应放置哪些组件及其位置。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"情绪"}]},{"id":"e4e5139a33824d66acc5af79e26ea948910fdcd0","title":"情绪快速入门","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/emotion/quick-start","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"在 Convai NPC 上构建一个可运行的情绪管线——挂载 Emotion Controller、分配随附的示例配置文件，并在播放模式下验证表情。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"情绪"}]},{"id":"5a9247365092d958f2d539ae98bdfe69f72df091","title":"情绪配置文件","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/emotion/emotion-profile","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"ConvaiEmotionProfile 参考，包括平滑速度、微脉冲设置、中性切换以及输出绑定配置。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"情绪"}]},{"id":"931fe5969b6c7b83aac82771a8aedc0f94f896d1","title":"情绪输出绑定","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/emotion/output-bindings","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"EmotionSlotBinding 及两种绑定类型的参考——字段范围、权重计算、isMouthShape 路由以及预构建的槽工厂。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"情绪"}]},{"id":"830c8a41ce176512408273566b88a4c868c56a59","title":"情绪分类体系","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/emotion/emotion-taxonomy","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"EmotionTaxonomyAsset 参考，包括内置的 Plutchik 集、服务器别名解析以及自定义分类体系编写。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"情绪"}]},{"id":"39d161d99d04e6ca98725c740d134ccb5eac9e73","title":"情绪脚本 API","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/emotion/scripting-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"情绪脚本接口参考——ConvaiEmotionController、EmotionReading、覆盖与锁定方法、C# 事件以及 IEmotionStateSource。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"情绪"}]},{"id":"6c46f45b25431c91dffb50ae4e5dd2ea5cc7ef50","title":"情绪示例","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/emotion/usage-examples","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"六个完整场景，涵盖危险覆盖、锁定表情、困境分支、分析日志、无代码 UI 连接以及 Editor 编写。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"情绪"}]},{"id":"65ec9decd2473b72bc06bf3c946f3008c8528dda","title":"排查情绪问题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/emotion/troubleshooting-and-diagnostics","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"修复 Convai Unity SDK 中常见的情绪管线故障——从缺失输出和静默回退到 LipSync 冲突和锁定表情。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"情绪"}]},{"id":"619185ebc41c18d7fc15c71b6aaa2a22367ff0a6","title":"长期记忆","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/long-term-memory","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找所有长期记忆指南——为角色启用记忆、管理用户身份、使用记忆 API，以及访问脚本参考。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"}]},{"id":"cb4d859b279841fc234bec92056ed917a73b519b","title":"长期记忆如何工作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/long-term-memory/how-long-term-memory-works","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解长期记忆的会话生命周期、记忆如何按用户和角色进行范围划分，以及事实如何被提取、去重和注入。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"长期记忆"}]},{"id":"d051c20fa3bb87461147abd07ac16642c7956362","title":"长期记忆快速入门","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/long-term-memory/quick-start","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"为 Convai 角色启用长期记忆，并在三步之内于 Unity Editor 中验证跨会话回忆。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"长期记忆"}]},{"id":"b54beab8714c42a31356b3abe240c02692f3d79b","title":"为角色配置记忆","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/long-term-memory/configure-memory-for-a-character","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"可通过 Convai 仪表板或 CharacterService 脚本 API 为每个角色开启或关闭长期记忆，并了解全局范围的影响。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"长期记忆"}]},{"id":"c12fc9539ece3543a049cf5c334655c9bb0a6a3c","title":"终端用户身份","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/long-term-memory/end-user-identity","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 SDK 如何为长期记忆范围确定用户身份，以及如何实现自定义、基于身份验证的身份提供程序。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"长期记忆"}]},{"id":"49cef55d22f33c0ffdf4893701cd5a6686bd7590","title":"管理终端用户记录","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/long-term-memory/end-user-management","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"通过 Convai Configuration Window 或 EndUsersService 脚本 API 浏览和管理终端用户记录——涵盖编辑器工具、全部四种方法和分页。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"长期记忆"}]},{"id":"0b7e1084a14c3bcf13fec179ad83b458f07ecff4","title":"记忆管理 API","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/long-term-memory/memory-management-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用 ConvaiRestClient.Memory 为用户-角色对列出、添加、检索和删除记忆记录——包括设置、全部五种方法、响应类型和错误处理。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"长期记忆"}]},{"id":"9c55a31cd790424665e521972bff5affc2dbe7f9","title":"长期记忆脚本参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/long-term-memory/long-term-memory-scripting-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"ConvaiRestClient.Memory 和 ConvaiRestClient.EndUsers 的完整 API 参考——全部方法签名、参数、返回类型、身份接口和数据模型。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"长期记忆"}]},{"id":"d41fbdd4f21a090aa6d7e39be7a7eb215d0435c2","title":"长期记忆使用示例","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/long-term-memory/usage-examples","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Unity 中四种完整的长期记忆模式——零配置持久化、经过身份验证的身份、记忆初始化和记忆重置。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"长期记忆"}]},{"id":"7a63a06da6d31beb01ce563b8e8b3398f3436122","title":"排查长期记忆问题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/long-term-memory/troubleshooting-and-diagnostics","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"诊断长期记忆为何未能持久化，验证终端用户身份在会话间的稳定性，并解决 Memory Management API 的 HTTP 错误。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"长期记忆"}]},{"id":"892f091d719fc0313f9c15cd06a5133939efee0e","title":"叙事设计","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/narrative-design","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找在 Convai Unity SDK 中设置、配置、脚本编写和排查 Narrative Design 系统问题的指南。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"}]},{"id":"8c61052d425664c56d66ff00e148451aeaa62bb1","title":"叙事设计如何工作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/narrative-design/how-narrative-design-works","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 Narrative Design 管线——章节、触发器和模板键如何在运行时连接以推进故事图。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"叙事设计"}]},{"id":"d4b9246d641fe591e1b8652c55ef5e59554dc6af","title":"叙事设计快速入门","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/narrative-design/quick-start","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"向 Convai 角色添加 Narrative Design Manager 和碰撞触发器，并在播放模式下确认章节变化——无需代码。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"叙事设计"}]},{"id":"59d31b624a51d8790cd9e50732a32794dcfd69f1","title":"配置叙事设计管理器","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/narrative-design/setting-up-the-narrative-design-manager","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"在角色上添加并配置 ConvaiNarrativeDesignManager，从 Convai 同步章节，并在 Inspector 中连接每个章节的 Unity Events。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"叙事设计"}]},{"id":"87ddb3e30dd1b009eb7bf39b583b5a654f486dbb","title":"配置叙事设计触发器","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/narrative-design/setting-up-narrative-design-triggers","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"配置 ConvaiNarrativeDesignTrigger，以使用碰撞、接近、基于时间或手动激活模式推进叙事图。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"叙事设计"}]},{"id":"630c1743293b81e62f2237b571dcf928c0d73285","title":"配置叙事模板键","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/narrative-design/template-keys-dynamic-narrative-variables","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"设置叙事模板键，以便 Convai 角色能够在其目标中引用运行时值——玩家姓名、场景参数或会话状态。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"叙事设计"}]},{"id":"e2aeb655628e9664d3a8c2993eb219a88fcfeef0","title":"叙事设计脚本参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/narrative-design/scripting-narrative-design","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"用于从代码控制角色叙事流程的参考，涵盖章节事件、触发器调用、脚本化语音和数据获取。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"叙事设计"}]},{"id":"5a4803abb898897932fbc643bd96c9e58ef4d96c","title":"叙事设计使用示例","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/narrative-design/usage-examples","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"四个经过验证的 Narrative Design 示例，从单一触发器的欢迎流程到带动态反馈的自适应多章节场景。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"叙事设计"}]},{"id":"bd435d6564aabc01fda5fe6b7c130cf0ffeb1c36","title":"排查叙事设计问题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/narrative-design/troubleshooting-and-diagnostics","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用内置验证和诊断工具解决触发器状态失败、Inspector 配置错误、获取错误和队列超时问题。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"叙事设计"}]},{"id":"3e23af730226f449644f6a9c60f206a69124eb0e","title":"场景元数据","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/scene-metadata","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找场景元数据的指南、组件参考和示例——该功能让 Convai 角色能够感知你 Unity 场景中的对象。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"}]},{"id":"df7e8b09abcd66c8464d199cbe2d609cb6a389a8","title":"场景元数据如何工作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/scene-metadata/how-scene-metadata-works","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解场景对象元数据的注册和传递流程，并学习何时使用 Scene Metadata 而非 Dynamic Context。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"场景元数据"}]},{"id":"6870c01843dd57c3ac7ecac3bfb3a6790f115e1b","title":"场景元数据快速入门","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/scene-metadata/quick-start","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"为 Unity 场景添加对象感知，使 Convai 角色从连接的那一刻起就能在对话中引用命名对象。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"场景元数据"}]},{"id":"b55fe13afe8f10f3ca27eec09be22c5bd975a884","title":"场景元数据组件参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/scene-metadata/component-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"描述场景对象给 Convai 的两个组件的参考，并暴露其实时跟踪状态，包括 Inspector 字段和生命周期。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"场景元数据"}]},{"id":"553ff838d38639ef80a27f8380dc466768470562","title":"场景元数据脚本 API","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/scene-metadata/scripting-api-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Scene Metadata 的类的完整 C# 参考，涵盖对象属性、跟踪属性更新、注册表查询和手动发送触发器。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"场景元数据"}]},{"id":"16c5aa93667aec71180b560b3408b114f488e893","title":"场景元数据使用示例","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/scene-metadata/usage-examples","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"医疗培训、工业演练、博物馆导览、运行时对象更新和跟踪属性状态的完整 Scene Metadata 配置。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"场景元数据"}]},{"id":"f6f3f3d88a3636afea1b0c8774162c2014fba780","title":"排查场景元数据问题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/scene-metadata/troubleshooting-and-diagnostics","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"修复场景元数据问题，包括空负载、缺少收集日志、依赖注入失败以及 AI 角色忽略场景对象。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"场景元数据"}]},{"id":"b40605131fc22d0b4a7a0e62e0e97c744ec19d0e","title":"视觉","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/vision","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找在 Unity 中为 Convai 角色添加实时场景视觉的指南，包括帧源、发布策略、脚本编写和故障排除。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"}]},{"id":"6ebd5ccda4df347e0fb3db3967023f01c8054427","title":"视觉如何工作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/vision/how-vision-works","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 Vision 流水线架构，包括帧源、发布策略、到 Convai 的 WebRTC 轨道以及动态视觉上下文如何融入其中。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"视觉"}]},{"id":"4290d3b5bc8fff8787b36689dbdf110d6ebc4c11","title":"动态视觉上下文","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/vision/dynamic-vision-context","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"动态视觉上下文类型参考，用于配置由后端驱动的摄像头帧采样以及每条通道的 respond-mode 默认值。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"视觉"}]},{"id":"8688e51bd7c568104d68e6f3c42a8d7ef8b881e8","title":"视觉快速入门","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/vision/quick-start","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"将 Vision 添加到现有 Convai 场景中，使角色能够看到并响应实时摄像头输入，使用 SDK 的自动组件设置。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"视觉"}]},{"id":"3c41ddceb11fc2af6b830a08a48c437b590c8882","title":"视觉帧源","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/vision/frame-sources","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"CameraVisionFrameSource、WebcamVisionFrameSource 和 QuestVisionFrameSource 的参考，包括 Inspector 字段、捕获预设和平台支持。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"视觉"}]},{"id":"b15c237537e3521d8e360ca90de5e9b15be340ec","title":"发布策略","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/vision/publishing-and-policies","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Vision 发布策略参考，包括 FPS 和码率预算、运行时控制方法、自动发布行为以及 WebGL 特定行为。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"视觉"}]},{"id":"885a0e6676256e7738207107695532701ef9b1ec","title":"Vision 调试预览","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/vision/debug-preview","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用 Unity 编辑器调试工具验证视觉摄像头画面，并确认视觉状态请求和触发器已到达 Convai。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"视觉"}]},{"id":"cb7758289bc48a93210bce51933fd819fd05e245","title":"自定义帧源","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/vision/custom-frame-sources","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"实现 IVisionFrameSource 以向 Convai 发布自定义视频流水线，包括 Y 翻转要求、生命周期状态模式和自动发现规则。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"视觉"}]},{"id":"9ee175b12da238182d707abd778abdc3a8706c80","title":"Vision 脚本 API","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/vision/scripting-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai Unity SDK Vision 脚本 API 参考，包括发布控制、运行时状态查询、按需触发器和 respond 模式事件。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"视觉"}]},{"id":"c296dab9e1d439fdd895aa80e239915e6c1d0943","title":"视觉使用示例","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/vision/usage-examples","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找常见 Vision 设置的代码模式，包括安全训练、摄像头选择、注视激活、按需触发器和 WebGL 部署。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"视觉"}]},{"id":"86612bc613c5a299a468b71b3fb8a40e625ee1fe","title":"排查视觉问题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/features/vision/troubleshooting-and-diagnostics","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用结构化检查清单和决策树，在 Unity 中修复 Vision 发布失败、空白画面、权限错误和平台特定问题。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"功能"},{"label":"视觉"}]},{"id":"0466e7dae37120ba674c5b7d476fc08aade362e3","title":"实用工具","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/utilities","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"可选的演示模块，可增强角色动画、眼神追踪和头部运动——完全在 Unity 中运行，不会向 Convai 发送任何数据。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"}]},{"id":"4855debc1a41a36a77ffcd2af49d786a7ffa1236","title":"对话动画","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/utilities/dialogue-animation","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用池化的剪辑库和 AnimatorOverrideController，根据对话状态和情绪驱动身体与头部的手势动画——无需逐剪辑的 Animator 状态。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"实用工具"}]},{"id":"da0a7ca0f3dd37ca93606601ab594c12136f816a","title":"对话动画如何工作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/utilities/dialogue-animation/how-dialogue-animation-works","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 Dialogue Animation 如何选择剪辑、驱动四层 Animator 栈，以及如何利用情绪和对话状态为 AI 角色制作动画。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"实用工具"},{"label":"对话动画"}]},{"id":"cf0343f3a0b58d2e8e0e7f1a0c9eee9a6c5ecd1d","title":"对话动画快速入门","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/utilities/dialogue-animation/quick-start","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"将 ConvaiDialogueAnimationController 添加到角色上，分配库和运行时配置，并在播放模式下验证手势动画。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"实用工具"},{"label":"对话动画"}]},{"id":"0f3cbc0e4633317c448740563d0c38854e7725ee","title":"动画库与配置文件","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/utilities/dialogue-animation/animation-libraries-and-profiles","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"所有 Dialogue Animation ScriptableObject 资源的完整字段参考——库、剪辑条目、运行时配置和随附配置文件。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"实用工具"},{"label":"对话动画"}]},{"id":"9e00cc9c176681b9489a9cd12ee13917fd6f11ea","title":"Animator Controller 要求","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/utilities/dialogue-animation/animator-controller-requirements","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Dialogue Animation Animator Controller 合同——所需图层结构、状态名称、占位剪辑名称和 DialogueAnimatorContract 字段。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"实用工具"},{"label":"对话动画"}]},{"id":"547a1c8f364d8b30d06385d1f1f82837227e6c82","title":"构建兼容的 Animator Controller","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/utilities/dialogue-animation/animator-controller-setup","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"从零构建一个兼容的四层 Animator Controller，以便 Dialogue Animation 模块在运行时注入并替换手势剪辑。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"实用工具"},{"label":"对话动画"}]},{"id":"b57405f03c1f45cc9e305ce32db7cbe06e914f5b","title":"对话动画使用示例","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/utilities/dialogue-animation/usage-examples","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"四个递进示例——从仅 Inspector 设置到运行时库切换——涵盖培训、医疗、企业和自适应评估场景。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"实用工具"},{"label":"对话动画"}]},{"id":"9be0dcfc097dc8444409730b1036b4a2f70ec112","title":"对话动画脚本 API","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/utilities/dialogue-animation/scripting-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"ConvaiDialogueAnimationController 的运行时脚本参考——在运行时切换库和配置，并读取当前图层权重和剪辑选择状态。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"实用工具"},{"label":"对话动画"}]},{"id":"0701ede6b3c4cdf57154ba57ba35ff6bd82a86bf","title":"对话动画故障排除","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/utilities/dialogue-animation/troubleshooting","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"针对静默说话层、缺失动画、剪辑跳变、图层索引错误和语音能量问题的症状驱动修复方法。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"实用工具"},{"label":"对话动画"}]},{"id":"ef7ab7a7a63bf2b7dbe5e891064030f0baab789b","title":"注视与注意力","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/utilities/gaze-and-attention","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"用于自然眼部和头部行为的双系统管线——Attention 选择关注目标，Gaze 驱动程序化眼动跟踪、头部旋转、扫视和眨眼。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"实用工具"}]},{"id":"b0c29a6e702559f60d0915358a514f0948309c80","title":"注视与注意力如何工作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/utilities/gaze-and-attention/how-gaze-and-attention-works","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解双层管线，其中 Attention 选择关注目标，而 Gaze 驱动程序化眼动跟踪、头部旋转和扫视。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"实用工具"},{"label":"注视与注意力"}]},{"id":"3c4829453494907d523e48c550daa2fe2aac5a4e","title":"注视与注意力快速入门","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/utilities/gaze-and-attention/quick-start","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"向角色添加 ConvaiAttentionController、ConvaiEyeGazeActuator 和 ConvaiHeadLookActuator，分配配置文件，并在播放模式下验证眼睛和头部跟踪。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"实用工具"},{"label":"注视与注意力"}]},{"id":"5b881c94bd2adefe8b932f255cffe05f31b8cd93","title":"注意力与注视配置文件","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/utilities/gaze-and-attention/profiles-and-tuning","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"四个 gaze profile ScriptableObject 的完整字段参考——注意力时序、注视协调、眼部行为和头部旋转。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"实用工具"},{"label":"注视与注意力"}]},{"id":"a207c4438cb0378f687867334e1e2e2b5d8c75bb","title":"注视与注意力使用示例","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/utilities/gaze-and-attention/usage-examples","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Gaze & Attention 配置的四个递进示例——从基本 Inspector 设置到自定义 IFocusTargetProvider 实现以及注意力配置文件调优。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"实用工具"},{"label":"注视与注意力"}]},{"id":"5a9422b007899ae59891f1bd5d95035da644a167","title":"注视与注意力脚本 API","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/utilities/gaze-and-attention/scripting-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"ConvaiAttentionController、AttentionReading、IFocusTargetProvider、ConvaiGazeCoordinator 和 GazeIntent 的运行时脚本参考。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"实用工具"},{"label":"注视与注意力"}]},{"id":"bd1a14b7112ed8774594e9ba50650f3d5c339af2","title":"注视与注意力故障排除","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/utilities/gaze-and-attention/troubleshooting","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"修复最常见的 13 个 Gaze & Attention 问题——静止眼睛、僵硬头部、眼睑裁切、注意力不指向目标以及焦点提供器冲突。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"实用工具"},{"label":"注视与注意力"}]},{"id":"2b8bcd9f29dcc2b30d5e7e6151d3dfdd57b6ed76","title":"UI 与展示","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/ui-and-presentation","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"可选的场景级 UI，用于显示转录文本、展示通知，并为用户提供运行时设置面板——只添加你的项目所需内容。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"}]},{"id":"49fed70bb2b468bcc6348096af1fc53fdb0656ce","title":"转录 UI","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/ui-and-presentation/transcript-ui","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 Convai Unity SDK 如何区分持久聊天历史与与语音对齐的字幕，以及哪个内置组件显示哪一种。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"UI 与展示"}]},{"id":"b846767a1ed5a04b3cfb93646c3c8472baf91067","title":"转录历史与查询","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/ui-and-presentation/transcript-ui/transcript-history-and-queries","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"从代码中读取当前对话轮次时间线，随着实时轮次变化发生响应，并将会话历史导出为文本、Markdown 或 JSON。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"UI 与展示"},{"label":"转录 UI"}]},{"id":"6695eb978b08dbf5023b367d38af0912574c4f52","title":"聊天和字幕模式","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/ui-and-presentation/transcript-ui/chat-and-subtitle-modes","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"在场景中添加滚动聊天历史、实时字幕，或两者都添加，并配置每种转录显示的外观与行为。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"UI 与展示"},{"label":"转录 UI"}]},{"id":"1e289d6d26e0f600f68032dc64a489bc29fe1a00","title":"通知系统","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/ui-and-presentation/notification-system","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"添加吐司式提醒，可自动显示会话错误通知，并允许你通过 ScriptableObject 通知资源从代码触发自定义场景内提醒。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"UI 与展示"}]},{"id":"caa7ca5d0d83b53a1e0bc946efa57288e237a693","title":"通知系统参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/ui-and-presentation/notification-system/notification-system-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"SONotification、SONotificationGroup、UINotificationController 和 SONotificationErrorMap 的参考——字段、方法和配置选项。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"UI 与展示"},{"label":"通知系统"}]},{"id":"dddf624ca0ae7ec32afa0c9e601f2cb7c7ab2b6a","title":"设置面板","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/ui-and-presentation/settings-panel","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"添加一个运行时设置面板，让用户调整麦克风、转录可见性和通知偏好，或以编程方式访问相同设置。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"UI 与展示"}]},{"id":"583ee1c9e51b46cec2adb2388e0ffd644e8ef169","title":"运行时设置 API","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/ui-and-presentation/settings-panel/runtime-settings-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"IConvaiRuntimeSettingsService 参考——从代码读取当前设置、应用补丁、响应更改并重置为默认值。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"UI 与展示"},{"label":"设置面板"}]},{"id":"5f60eaa8d444f5ee8a995392852da827736d3b54","title":"自定义 UI 组件","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/ui-and-presentation/customizing-ui-components","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"通过角色可见性过滤器或替换预制体来重设样式或替换内置的转录、通知和设置 UI。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"UI 与展示"}]},{"id":"0c50993bf7f808e1095d4063ea417f6a0f9fed5e","title":"脚本参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/scripting-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai Unity SDK 的 C# 脚本 API 参考——事件、转录文本、音频控制和异步操作模式。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"}]},{"id":"6f90d2d448d0f65990aa0f30d6e9fd76263eea2e","title":"会话事件","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/scripting-reference/session-events","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"通过 relay 组件或 `ConvaiEvents` C# 事件中心，参考会话事件——连接状态、错误、空闲警告和参与者变更。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"脚本参考"}]},{"id":"d5d0bda9517e2ebcad589dcd94370c3d5b9a2130","title":"角色事件","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/scripting-reference/character-events","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"通过 relay 组件或 `ConvaiEvents` C# 事件中心，参考角色事件——语音、情绪、转录、轮次生命周期和动作。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"脚本参考"}]},{"id":"1a33f148fac3ddf7352a86abb1f67ce91973142c","title":"转录 API","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/scripting-reference/transcript-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用转录门面从 Unity 脚本查询转录轮次、订阅实时变化、读取字幕并导出会话历史。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"脚本参考"}]},{"id":"0b05353dc271e9a67f022bad20df0f61e55c2176","title":"角色和玩家 API","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/scripting-reference/character-and-player-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"ConvaiCharacter 和 ConvaiPlayer 参考，包括用于会话控制、语音、音频和注意力的属性、方法和事件。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"脚本参考"}]},{"id":"837e187dde6ef107490d678933eda069ab0635b1","title":"ConvaiManager API","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/scripting-reference/convaimanager-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"ConvaiManager 的脚本参考——用于连接控制、门面访问、对话所有权和服务发现的 SDK 入口点。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"脚本参考"}]},{"id":"bb7cdb69415400d0bfcff2641441af4bd4480284","title":"音频 API","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/scripting-reference/audio-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"ConvaiAudio 的脚本参考——麦克风静音、按角色的音频控制、音频播放解锁以及监听状态管理。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"脚本参考"}]},{"id":"15b65578023dcda7a39e06f4214cfae613ce3123","title":"操作和流类型","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/scripting-reference/operation-and-stream-types","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"IConvaiOperation<T>、IConvaiStream<T>、ConvaiError 和 Unit 的类型参考——所有 Convai SDK 脚本 API 中使用的异步原语。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"脚本参考"}]},{"id":"66f1c88f2864611c5d967825822213f8fa8fa8fa","title":"异步模式","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/scripting-reference/async-patterns","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用 async/await、协程、链式调用、进度跟踪、取消和流来处理 IConvaiOperation<T> 和 IConvaiStream<T>。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"脚本参考"}]},{"id":"c548f38700d19163b7037cf3152f210077f0967b","title":"平台指南","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/platform-guides","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"将 Convai Unity SDK 部署到任何受支持的平台——涵盖在发布前 WebGL、iOS、Android 和 XR 头显上需要额外配置的内容。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"}]},{"id":"923aca1b2f7320da4795f5202c3cf1d2932cb523","title":"Windows、macOS 和 Linux","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/platform-guides/windows-macos-and-linux","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Windows、macOS 和 Linux 构建无需额外的 SDK 配置——包括 Vision、空间音频和屏幕共享在内的所有功能在标准设置后即可工作。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"平台指南"}]},{"id":"6cfceeb85df8a63f5076c12cd7b38b5a932ed4e8","title":"WebGL","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/platform-guides/webgl","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"为 WebGL 配置并验证 Convai Unity SDK——涵盖 HTTPS 要求、浏览器音频手势处理、Vision 画布捕获以及已知的 LipSync 漂移缺陷。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"平台指南"}]},{"id":"a05c31e79a2f905396785b4f77b4554fc046528d","title":"iOS 和 Android","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/platform-guides/ios-and-android","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"为 iOS 和 Android 构建声明麦克风和摄像头权限——如果遗漏，iOS 会崩溃，Android 会静默失败。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"平台指南"}]},{"id":"eaa8f2e135526b94c0bfa16f39b4e7f1cc91ca79","title":"XR 头显","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/platform-guides/xr-headsets","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找在 XR 头显上部署 Convai Unity SDK 的指南，包括 Meta Quest Vision 透视设置和自定义 XR 帧源实现。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"平台指南"}]},{"id":"8f003ceeea888b21021a2b6aeef5efbbfe5a03cd","title":"Meta Quest Vision 设置","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/platform-guides/meta-quest-vision","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"配置 QuestVisionFrameSource，将 Meta Quest 透视摄像头流式传输到 Quest 3 和 3S 构建中的 Convai 角色。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"平台指南"}]},{"id":"88133ee9286cf8e79d37845227b72f2a4be61b4b","title":"自定义并扩展 SDK","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/advanced-topics","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"替换 SDK 提供程序、使用自定义模块扩展运行时，并借助内置遥测诊断延迟——适用于默认设置不足的部署场景。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"}]},{"id":"b6e1d5b82a92f7950701bd2576065db6c0349005","title":"凭据、身份与存储","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/advanced-topics/custom-providers","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"用适合你的部署环境的自定义实现，替换 SDK 的默认凭据、身份和持久化提供程序。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"自定义并扩展 SDK"}]},{"id":"fdc49f930fecd7fb00d337f46a900594f8f26fb5","title":"自定义凭据提供程序","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/advanced-topics/custom-providers/custom-credential-provider","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"覆盖 SDK 的默认凭据来源，从环境变量、密钥保管库或任何运行时解析的凭据存储中提供 API 密钥。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"自定义并扩展 SDK"},{"label":"凭据、身份与存储"}]},{"id":"4f9746367744635226a122f62cd5fa9abd892214","title":"自定义身份提供程序","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/advanced-topics/custom-providers/custom-identity-provider","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"实现自定义的终端用户身份提供程序，将 Convai 的记忆和 MAU 跟踪与你自己的身份验证系统、学习者记录或信息亭登录流程关联。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"自定义并扩展 SDK"},{"label":"凭据、身份与存储"}]},{"id":"2e48fc65c96962e4ad153649c1ead0353c2ca940","title":"自定义持久化提供程序","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/advanced-topics/custom-providers/custom-persistence-provider","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"通过实现 IKeyValueStore 或 IPersistenceProvider，将 PlayerPrefs 会话存储替换为云后端、加密文件存储或内存实现。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"自定义并扩展 SDK"},{"label":"凭据、身份与存储"}]},{"id":"39c79b51732b2441a1b8ec0d5d75288e27e81e91","title":"个人访问令牌","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/advanced-topics/custom-providers/personal-access-token","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"从你的后端生成短期令牌，使真实 API 密钥永远不会随 Unity 构建一起发布，从而消除客户端应用中的凭据暴露风险。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"自定义并扩展 SDK"},{"label":"凭据、身份与存储"}]},{"id":"007b237f8ee6f8a26b307152ee716a33905cd6da","title":"运行时模块系统","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/advanced-topics/extending-the-sdk","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 Convai 运行时模块系统，包括何时使用自定义模块、模块生命周期状态，以及哪些 SDK 扩展点可安全使用。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"自定义并扩展 SDK"}]},{"id":"c94f3576730a705ef8d7adec01d712a12612b542","title":"实现自定义模块","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/advanced-topics/implement-a-custom-module","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"实现 `IConvaiModule` 以添加随 SDK 启动、访问运行时服务并响应领域事件的自定义运行时行为。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"自定义并扩展 SDK"}]},{"id":"fef9ce3a50abea0da1b1bc0e993c3308a067a94a","title":"日志、指标和重试策略","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/advanced-topics/performance-and-optimization","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"按子系统配置 SDK 日志详细级别，将日志路由到自定义目标，读取 RTVI 管线延迟指标，并调整连接重试策略。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"自定义并扩展 SDK"}]},{"id":"aed151614a7019028126be07590213a17602a2f2","title":"故障排除","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/troubleshooting","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找 Convai Unity SDK 中安装错误、API 问题、音频故障和调试工具的故障排除指南。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"}]},{"id":"e10ea397187f53bca813a256eac60d9e5c816b9a","title":"安装和包问题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/troubleshooting/installation-and-package-issues","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"通过分步修复来解决 Convai Unity SDK 导入失败、缺少依赖项、程序集错误和启动引导器警告。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"故障排除"}]},{"id":"07c0ce6cfe225bcb17f8209c5187483d2497d1a4","title":"连接和 API 问题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/troubleshooting/connection-and-api-issues","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"解读 Convai 会话错误代码，读取 ConvaiRoomManager 诊断信息，并解决身份验证、传输和速率限制失败。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"故障排除"}]},{"id":"748d5aef4b035086919756d0ceedf7f3497a0117","title":"音频和麦克风问题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/troubleshooting/audio-and-microphone-issues","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"修复所有 Convai Unity SDK 平台上的麦克风输入故障和角色语音播放问题，包括 Android、iOS 和 WebGL。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"故障排除"}]},{"id":"41fb22d336940f24c4bfbf2655c6122580016b9b","title":"调试工具参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unity-sdk/troubleshooting/debug-tools-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai SDK 调试工具参考，包括日志配置、ConvaiActionDebugProbe、会话诊断和客户端延迟指标。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unity SDK"},{"label":"故障排除"}]},{"id":"ce8768c6b5b2e87ea2438e5ffe644bb14d0f85ee","title":"Convai Unreal Engine 插件","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找 Convai Unreal Engine 插件的安装指南、功能文档、Blueprint 参考和故障排除页面。","breadcrumbs":[{"label":"插件与集成"}]},{"id":"ef9c025d624fb7a7ea50155c9296da1e2034da53","title":"Convai Unreal Engine 插件概览","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/overview","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找关于什么是 Convai Unreal Engine 插件、其四个模块和运行时组件如何组织，以及每个版本有哪些变化的说明。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"}]},{"id":"cc24f3efcd97e1aad244208204220bfb8a89c7c3","title":"什么是 Convai Unreal Engine 插件","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/overview/what-is-the-convai-unreal-engine-plugin","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 Convai Unreal Engine 插件为项目增加了什么：Blueprint 组件、实时语音管线以及可选的功能附加模块。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"Convai Unreal Engine 插件概览"}]},{"id":"27197a3dc9f39c8dc152420a719cf1ad8e9a6be2","title":"插件架构","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/overview/plugin-architecture","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 Convai Unreal Engine 插件的四个模块、运行时组件、会话代理和子系统路由模型。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"Convai Unreal Engine 插件概览"}]},{"id":"4551a191a6c59cb019973be9f8a2775cdb4a257a","title":"功能地图","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/overview/feature-map","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"按使用场景索引，为任何开发目标找到合适的 Convai Unreal Engine 插件功能、指南或参考页面。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"Convai Unreal Engine 插件概览"}]},{"id":"ea99d09674a19c50a2bf2809d589cb0148590782","title":"发行说明","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/overview/release-notes","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai Unreal Engine 插件的版本历史和重要变更，涵盖公开的 4.x 测试版发布和完整的 3.x 历史。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"Convai Unreal Engine 插件概览"}]},{"id":"c0b1130cf155d2cf91b5a9d03994277bafb81c6f","title":"兼容性与要求","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/compatibility-and-requirements","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找 Convai Unreal Engine 插件的 Unreal Engine 版本支持、平台目标、角色骨架兼容性和网络要求。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"}]},{"id":"79992cadc87a282de88001754b9e93a529f2ebe9","title":"Unreal Engine 版本","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/compatibility-and-requirements/unreal-engine-versions","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai Unreal Engine 插件版本支持参考，包括每个 UE 版本的模块可用性、加载阶段和各版本设置说明。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"兼容性与要求"}]},{"id":"79f6f23bac71c8822aa787c002f3f94e5f1a95ee","title":"Unreal Engine 平台支持矩阵","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/compatibility-and-requirements/unreal-engine-platform-support-matrix","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai Unreal Engine 插件平台支持参考，包括构建目标、引擎插件依赖项和 Android 麦克风访问。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"兼容性与要求"}]},{"id":"c2fbcade4761ad52378cc3fbb5beb1bfdb78d879","title":"角色骨架支持","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/compatibility-and-requirements/character-rig-support","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"哪些角色骨骼适用于 Convai Unreal Engine 插件、每种需要什么设置，以及在哪里可以找到对应骨骼的专用设置指南。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"兼容性与要求"}]},{"id":"4b0adccfe599095ddce0cd91a25e2fc306475dff","title":"网络和 API 要求","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/compatibility-and-requirements/network-and-api-requirements","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai Unreal Engine 插件网络访问参考，包括 Convai 和 LiveKit 主机、防火墙规则、身份验证以及会话日志检查。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"兼容性与要求"}]},{"id":"fb3a2bacc1ba8d2d274717ebd7a3ac02e56aabb8","title":"开始使用","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"安装 Convai Unreal Engine 插件，配置你的 API 密钥，并放置第一个会说话的角色——按顺序遵循核心路径以最快获得结果。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"}]},{"id":"a8bb2a08932b50633f711d4a8438fe78aaad0e53","title":"前提条件","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/prerequisites","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"在将 Convai Unreal Engine 插件安装到项目中之前，请先验证引擎版本、账户、平台和网络要求。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"开始使用"}]},{"id":"1e7f8ff5f6dd180c804dba754f19c21a745be07f","title":"安装 Convai 插件","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/install-the-convai-plugin","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"从 Fab 或 GitHub Releases 安装 Convai Unreal Engine 插件，在项目中启用它，然后重启 Unreal Editor。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"开始使用"}]},{"id":"d6af0b14fc209017d2d18543ad38076bb0efe8f6","title":"配置你的 API 密钥","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/configure-your-api-key","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"通过 Convai 编辑器窗口登录以存储你的 API 密钥，并允许插件向 Convai 发送经过身份验证的请求。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"开始使用"}]},{"id":"98b41781157f6eec98a195dad1b57f66765cf380","title":"场景组件参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/scene-components-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai Chatbot、Player、Object 和 Face Sync 组件参考——它们的字段、运行时属性，以及它们在场景中的连接方式。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"开始使用"}]},{"id":"47cd8b5064f2e1f1738f08d50b1097ad47ed212c","title":"添加你的第一个 Convai 角色","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/add-your-first-convai-character","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"在 Unreal Engine 中通过添加 Chatbot 和 Player 组件、设置 Character ID，并在播放模式下测试，构建一个会说话的 Convai 角色。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"开始使用"}]},{"id":"f0a9565e073a000fe0ed7df2961660e00793150b","title":"设置 MetaHuman 角色","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/set-up-a-metahuman-character","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"向 MetaHuman 添加 Convai Chatbot 和 Face Sync 组件，分配 Convai 动画类，并为 MetaHuman blendshapes 配置口型同步。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"开始使用"}]},{"id":"d29e5c59616e0066f5596223946116f5c08bc90d","title":"设置 Reallusion（CC）角色","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/set-up-a-reallusion-cc-character","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"导出 Reallusion CC5 头像，将其导入 Unreal Engine，配置 Convai 组件，并添加 Reallusion 动画 Blueprint 以实现口型同步。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"开始使用"}]},{"id":"ddab80eff30a95a57bb3cec04bc4566233e30263","title":"配置麦克风","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/configure-the-microphone","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"选择采集设备，调整音量，并处理 Android 麦克风权限，以便玩家语音能够正确传达到 Convai 角色。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"开始使用"}]},{"id":"2f681ae01ba11fe882d6b331cca0444e0a06402d","title":"配置角色音频","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/configure-character-audio","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"调整角色语音播放音量，启用空间音频衰减，并在 Convai Chatbot 组件上配置中断淡出时长。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"开始使用"}]},{"id":"9b983ed32e78e3fecceef1f1ca84663abe05edca","title":"配置对话输入","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/configure-conversation-input","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"在按键通话与免提语音采集模式之间切换，调整 VAD 设置，并在没有麦克风时向角色发送文本消息。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"开始使用"}]},{"id":"16dba40249f8c38f0e33f50c10a68569851148b6","title":"添加聊天 UI","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/add-the-chat-ui","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"将内置聊天叠加层添加到场景中，在界面样式之间切换，将 3D 场景内小部件附加到角色，或用自定义小部件替换它。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"开始使用"}]},{"id":"1f909841a8dc37e6adc6461224d8b1968155a87c","title":"验证你的设置","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/getting-started/validate-your-setup","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"运行插件、组件、音频和 API 密钥检查清单，以在添加功能前确认你的 Convai Unreal Engine 设置正常工作。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"开始使用"}]},{"id":"d4d67f0a1b2a7584ab386f8d7585472886dfd1d6","title":"核心概念","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/core-concepts","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 Convai Unreal Engine 插件的组件模型、每个组件的归属方式以及它们在运行时如何协同工作。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"}]},{"id":"0a71bb8fce84999367c663a06434475b944f88da","title":"运行时架构","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/core-concepts/runtime-architecture","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 Convai Chatbot、Player、Object、Face Sync 组件与 Convai Subsystem 之间的角色、归属关系和关联。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"核心概念"}]},{"id":"a8878427b216a80d6b385f1a342c440aa9b398c9","title":"会话生命周期","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/core-concepts/session-lifecycle","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 Convai 会话如何开始和停止、连接状态的含义，以及哪些 Blueprint 节点会监控全局连接。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"核心概念"}]},{"id":"422d78b3fb4f61a00785b876137cbfde618d7baa","title":"对话流程","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/core-concepts/conversation-flow","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解语音输入、播放状态、转录事件、动作队列执行、叙事触发以及中断处理。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"核心概念"}]},{"id":"ddcceab71734a05a1e99c8599b42f364e146005e","title":"事件系统","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/core-concepts/event-system","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"按类别整理的 Convai 组件和子系统上的核心运行时 Blueprint 委托参考，并包含时序细节。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"核心概念"}]},{"id":"73868092346b12dc2f5857d5bfc4ca5240a4410e","title":"功能","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找所有 Convai Unreal Engine 插件功能的指南——口型同步、角色动作、叙事设计、长期记忆、视觉等。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"}]},{"id":"46d3b8351132c46e6470ee20811d82cf5cae7051","title":"角色动作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/character-actions","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找 Convai Unreal Engine 角色动作系统的指南、参考和示例——从快速入门到 Blueprint API 参考。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"}]},{"id":"ff7bceb97bf09634f482eda883836953606d574f","title":"角色动作如何工作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/character-actions/how-character-actions-work","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 Convai 角色动作如何从会话设置，进入排队的 Blueprint 处理器执行，再到完成报告。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"角色动作"}]},{"id":"e40e8b0853ec91418830a025e7b0c9acccd8d371","title":"角色动作快速入门","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/character-actions/character-actions-quick-start","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"启用角色动作，设置 Pawn 移动和导航，注册场景对象，并在播放模式下验证默认移动动作。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"角色动作"}]},{"id":"9d759a9e65c274645e91b88390d8bb2c4762bd80","title":"配置动作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/character-actions/configuring-actions","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"定义动作集合，启用角色动作，并注册环境对象和角色，以便 Convai 可以引用它们。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"角色动作"}]},{"id":"d1aaea82f339a27b3ce67918aa343caebba0762c","title":"内置动作处理器","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/character-actions/built-in-action-handlers","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"参考四个默认 Convai 角色动作的处理器模式，包括参数、完成规则和 Blueprint 流程。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"角色动作"}]},{"id":"4034933484ffa13478584311631f11ea8d503bb4","title":"构建自定义动作处理器","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/character-actions/building-custom-action-handlers","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"添加自定义动作模板，使用编辑器实用工具搭建 Blueprint 处理器，并报告完成以便队列继续推进。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"角色动作"}]},{"id":"e29ff52f0d30b08b7f190e5b10f7b84aa21c7ff4","title":"参数化动作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/character-actions/parameterized-actions","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"声明类型化动作参数，并在 Blueprint 处理器中读取已解析的值，适用于文本、引用、选择和动画。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"角色动作"}]},{"id":"4708b5833bcb3c0d451ce191750fc5274326e217","title":"注意力与引用锚定","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/character-actions/attention-and-reference-grounding","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 Convai Unreal Engine 插件如何解析代词引用和注意力目标，以便角色理解玩家指的是哪个对象。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"角色动作"}]},{"id":"8e18d509947b40274dca96b384f432486348198f","title":"动作 Blueprint 参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/character-actions/actions-blueprint-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Unreal Engine 中驱动 Convai 角色动作的 Blueprint 结构体、枚举、事件和队列函数参考。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"角色动作"}]},{"id":"667b43e0827e11f62e187182ca1631dcc064fb61","title":"角色动作示例","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/character-actions/character-actions-examples","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai Unreal Engine 插件中用于导航到已注册对象、跟随角色以及使用参数化动作的端到端动作示例。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"角色动作"}]},{"id":"8c96d39684a8203fb0c40d8bcb7467ca8267e3c9","title":"排查角色动作问题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/character-actions/troubleshoot-character-actions","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"修复 Convai Unreal Engine 插件中角色动作未触发、移动失败、引用问题和队列卡住等问题。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"角色动作"}]},{"id":"f1aab12e2433cc2eba9f8b33106fed6d232fe3de","title":"动态上下文","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/dynamic-context","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找通过 Blueprint 节点向 Convai 角色推送实时状态和事件，并在关卡中验证上下文感知响应的指南。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"}]},{"id":"8ef7dcd046dad07f4afcb544f96d3beda6feb0ad","title":"动态上下文如何工作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/dynamic-context/how-dynamic-context-works","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解动态上下文如何跟踪运行时状态、批处理事件、选择响应行为并为 Convai 组装载荷。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"动态上下文"}]},{"id":"602e67296ec3ed2b843879adb48efa844ab06ec3","title":"动态上下文快速入门","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/dynamic-context/dynamic-context-quick-start","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"通过 Blueprint 向已连接的 Convai 角色推送状态属性和上下文事件，并验证更新已到达上下文管道。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"动态上下文"}]},{"id":"0761980ed92c19c95c0b88fe44d1ee3c9c409818","title":"连接时的静态上下文","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/dynamic-context/static-context-at-connection-time","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解哪些已验证连接数据会在会话开始时固定，以及实时上下文更新如何使用独立的运行时消息。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"动态上下文"}]},{"id":"752c51862623321d86861772e63c55db752c58da","title":"同步行为与时序","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/dynamic-context/sync-behavior-and-timing","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解动态上下文载荷如何在去抖后刷新、离线排队如何工作，以及何时立即刷新会绕过批处理。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"动态上下文"}]},{"id":"a80705d8480f2f63dc8b84ea2e437c9dac45b7c5","title":"动态上下文 Blueprint 参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/dynamic-context/dynamic-context-blueprint-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"参考在实时会话期间从 Unreal 角色向 Convai 发送运行时状态、事件、重置和时序更新的 Blueprint 控件。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"动态上下文"}]},{"id":"4c32f5b1e84d192a1af40b32548e3cf5f7f90478","title":"动态上下文使用示例","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/dynamic-context/dynamic-context-usage-examples","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"训练模拟中的生命值跟踪、上下文事件、区域切换、状态移除和动态上下文重置的 Blueprint 示例。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"动态上下文"}]},{"id":"b420c88b0fe545f2bdf932b279270d9c5974103c","title":"排查动态上下文问题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/dynamic-context/troubleshoot-dynamic-context","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"修复动态上下文更新到达过晚、触发意外响应，或在刷新或重新连接后看似被忽略的问题。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"动态上下文"}]},{"id":"dac8d878741e85925d7a212fef1afa2b99e74a9d","title":"情绪","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/emotion","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找用于让 AI 角色表情与对话同步的指南——从快速 Blueprint 设置到完整参考和故障排查。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"}]},{"id":"c3081281b873e1a1b00439a147d3db6877743003","title":"情绪系统如何工作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/emotion/how-the-emotion-system-works","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 Convai 如何按每个情绪的分数传递情绪状态，服务器缩放如何映射到分数值，以及偏移和锁定控件的作用。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"情绪"}]},{"id":"760d975e7440e1f0f9fb57d5477018161e976844","title":"情绪快速入门","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/emotion/emotion-quick-start","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"将 Convai 角色的情绪分数连接到其 Skeletal Mesh 上的 morph targets，使面部表情在对话中自动更新。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"情绪"}]},{"id":"9ac48061a03a0400ae6e1769df358c2fb2a82536","title":"情绪 Blueprint 参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/emotion/emotion-blueprint-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai Chatbot 组件上的情绪属性、函数、事件和枚举参考——包括类型、默认值和参数细节。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"情绪"}]},{"id":"83566839f3555aa1855858bb1bc0c20ed5a973cc","title":"情绪示例","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/emotion/emotion-examples","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"六个场景涵盖强制表情、过场锁定、按分数驱动的 VFX、偏移调整、中性重置以及 Animation Blueprint 混合姿势。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"情绪"}]},{"id":"e1b9621c0881a69a39466e1413b1623f73166c9b","title":"排查情绪问题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/emotion/troubleshoot-emotion","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"修复常见情绪问题——表情未出现、状态被意外锁定、morph target 不匹配，以及偏移更改没有可见效果。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"情绪"}]},{"id":"19f4740b1fd265f1b629850b246b7b0621411221","title":"长期记忆","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/long-term-memory","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找用于启用长期记忆、识别玩家、恢复会话以及排查 Unreal Engine 中回忆问题的指南。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"}]},{"id":"9df4cda7b4a29ebef0a84953231ee1b61e2d4c9f","title":"长期记忆如何工作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/long-term-memory/how-long-term-memory-works","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 Unreal 长期记忆如何使用角色设置、玩家身份和连接时参数来回忆之前的交互。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"长期记忆"}]},{"id":"ce3e385378b893a9b53a3930b98101901dc9d6d8","title":"长期记忆快速入门","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/long-term-memory/long-term-memory-quick-start","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"为 Unreal 角色设置长期记忆，分配稳定的玩家身份，并在 Play In Editor 会话之间确认回忆效果。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"长期记忆"}]},{"id":"02906b279025410eed0c91dd64f1012b0304b626","title":"为角色配置记忆","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/long-term-memory/configure-memory-for-a-character","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"为 Unreal 角色启用长期记忆，验证仪表板设置，并在需要时重置本地对话链接。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"长期记忆"}]},{"id":"49e163546e7059153712733c44aa93aee597bbbe","title":"终端用户身份","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/long-term-memory/end-user-identity","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"配置稳定的 Unreal 玩家身份，以便每个 Convai 角色在会话开始前为正确的用户加载记忆。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"长期记忆"}]},{"id":"490cd1c53fd291cb3dcb57f385b0eee013c3ae74","title":"说话者 ID 管理","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/long-term-memory/speaker-id-management","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"从 Unreal Blueprints 创建、列出和删除 Speaker ID 记录，使每个玩家都能在会话之间保持稳定的记忆身份。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"长期记忆"}]},{"id":"d52ddbffaafeb3f6c5f97016d40633bc7ea09f16","title":"LTM Blueprint 参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/long-term-memory/ltm-blueprint-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Unreal 长期记忆 Blueprint 节点、Speaker ID 数据、组件属性和启动期间使用的会话字段参考。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"长期记忆"}]},{"id":"fe714c4b4449c797215a2b49fe82fef8879c959a","title":"长期记忆使用示例","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/long-term-memory/long-term-memory-usage-examples","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"将 Unreal 长期记忆模式应用于回访学习者、共享设备、首次会话和全新开始重置流程。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"长期记忆"}]},{"id":"1207dad324341231dae358387602c84854559b9c","title":"排查长期记忆问题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/long-term-memory/troubleshoot-long-term-memory","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"诊断并修复 Unreal 角色的记忆禁用、玩家身份不稳定、说话者身份失败以及共享设备回忆问题。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"长期记忆"}]},{"id":"c50f2cbde2d775fd6a1147c0ab6bbcf15218f3a6","title":"叙事设计","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/narrative-design","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"通过从 Unreal Engine 调用叙事触发器、注入模板键并处理章节变更事件来驱动角色故事图。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"}]},{"id":"7df13f2b93b6b95a4cdb5669073a1869b071babe","title":"叙事设计如何工作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/narrative-design/how-narrative-design-works","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解叙事设计故事图、推进章节的运行时管道，以及触发器和模板键如何塑造角色行为。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"叙事设计"}]},{"id":"fc5915683cbb3a9ae3782e4de53c3288e9e3b7cc","title":"叙事设计快速入门","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/narrative-design/narrative-design-quick-start","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"从 Blueprint 调用一个命名叙事触发器，并通过在屏幕上打印新的章节 ID 来确认章节变更。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"叙事设计"}]},{"id":"ff19704aac20f7d6e4bf5c3214636ccbe4248151","title":"叙事触发器","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/narrative-design/narrative-triggers","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"在 Convai chatbot 组件上调用命名叙事触发器或动态上下文消息，以推进故事图并处理章节变更事件。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"叙事设计"}]},{"id":"453cd3ea71434b9c4a8a7da307779eeb39996f99","title":"模板键","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/narrative-design/template-keys","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"填充 chatbot 组件上的 Narrative Template Keys 映射，以便章节目标通过占位符替换引用实时游戏值。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"叙事设计"}]},{"id":"01a30a9c684189ac16deee8b6b420f60eb8252f8","title":"获取叙事数据","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/narrative-design/fetching-narrative-data","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"在运行时使用 Convai Fetch Narrative Sections 和 Convai Fetch Narrative Triggers 查询角色的叙事章节和触发器。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"叙事设计"}]},{"id":"579f95b35d1b473357f37588e6fc915a03231497","title":"叙事设计 Blueprint 参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/narrative-design/narrative-design-blueprint-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"叙事设计 API 中 UConvaiChatbotComponent 上的 Blueprint 函数、事件、属性和叙事结构体参考。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"叙事设计"}]},{"id":"78fce7020677f54bda05ede0262a6996390ed909","title":"叙事设计使用示例","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/narrative-design/narrative-design-usage-examples","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"用于线性场景推进、动态上下文事件、模板键注入和叙事设计中触发器名称验证的 Blueprint 示例。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"叙事设计"}]},{"id":"609986e3902c22d2027f232e5ffaaa507011c8a0","title":"排查叙事设计问题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/narrative-design/troubleshoot-narrative-design","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"诊断并修复叙事设计问题，包括缺失的章节事件、错误的过渡、被忽略的模板键以及获取失败。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"叙事设计"}]},{"id":"ae13b29a517504598ad569023c6483ae28a3af7b","title":"场景元数据","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/scene-metadata","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找用于让 Convai 角色了解 Unreal Engine 关卡中对象的指南、参考页和示例。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"}]},{"id":"a6fd7e3b5ee94be300d9c248743b197b93cc0c96","title":"场景元数据如何工作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/scene-metadata/how-scene-metadata-works","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解场景对象元数据如何在连接时、通过实时更新以及通过受跟踪属性更改传递给 Convai。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"场景元数据"}]},{"id":"0feb18e88feac4367d421728b98f739c505dcd5a","title":"场景元数据快速入门","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/scene-metadata/scene-metadata-quick-start","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用 Convai Object Component 为世界中的 Actor 添加标签，分配其名称和描述，并确认 Convai 角色可以在对话中引用它。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"场景元数据"}]},{"id":"5b34043c604b8f8fd8088c66f01ea7887fcd8846","title":"场景元数据组件参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/scene-metadata/scene-metadata-component-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai Object Component 的完整属性、函数和事件参考，包括对象身份、受跟踪属性、接近状态和凝视事件。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"场景元数据"}]},{"id":"4a8ee50a93a78b9b86484cb79897f6d0d6bde187","title":"在运行时管理环境","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/scene-metadata/managing-the-environment-at-runtime","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"适用于在活动游戏会话期间添加、移除和更新对象及角色的 chatbot 环境方法参考。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"场景元数据"}]},{"id":"7fc985238017f8bd9de6df276f318c98902cac03","title":"场景元数据使用示例","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/scene-metadata/scene-metadata-usage-examples","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"用于训练模拟、工业演练、军事基地以及 Unreal Engine 中运行时环境更新的完整场景元数据设置。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"场景元数据"}]},{"id":"35be910ed18e7f78411fd4d732770d70307e1434","title":"排查场景元数据问题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/scene-metadata/troubleshoot-scene-metadata","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"诊断并修复场景对象未被识别、环境数据过时以及受跟踪属性无法更新等常见问题。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"场景元数据"}]},{"id":"efe0ea28574973991aa04b83a3d8227caa960b67","title":"视觉","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/vision","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"在 Unreal Engine 中为 Convai 角色赋予场景视觉，使其能够在对话中对关卡中可见的内容做出响应。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"}]},{"id":"63feddf4b54afd4fe7308827bee6b2f213dde1b6","title":"视觉如何工作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/vision/how-vision-works","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 Unreal 视觉组件如何被发现、启动、限流以及在 Convai 会话期间用于发送场景帧。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"视觉"}]},{"id":"ffb5a5d9ba2394107ce64c0b07938a181186f763","title":"视觉快速入门","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/vision/vision-quick-start","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"为 Convai 角色 Blueprint 添加场景视觉，并验证捕获的帧会影响其在编辑器内播放中的响应。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"视觉"}]},{"id":"a5aa237a7b13fb2c8d46ff004c1de14a2c4cda2a","title":"视觉帧源","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/vision/vision-frame-sources","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"配置内置 Environment Webcam 帧源，创建其渲染目标，并在运行时选择活动视觉组件。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"视觉"}]},{"id":"afdaa73f8daaacc42144959e698d777a078e46d3","title":"自定义视觉组件","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/vision/custom-vision-components","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"为需要向 Convai chatbot 提供场景帧的自定义 Unreal 图像管线实现一个 C++ 帧源组件。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"视觉"}]},{"id":"ec5b9bfb145ddc8145050976e8e8db28d33fc076","title":"视觉 Blueprint 参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/vision/vision-blueprint-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Blueprint 可访问的视觉枚举、Environment Webcam 属性、webcam 节点、事件以及 Chatbot 集成功能参考。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"视觉"}]},{"id":"cf86fde91936bc6994c59ccac11271cc09e11fea","title":"视觉使用示例","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/vision/vision-usage-examples","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"应用 Unreal 视觉的常见 Blueprint 模式，包括自动启动采集、手动控制、FPS 调整和源切换。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"视觉"}]},{"id":"dd7a120c7a038befb7a1fe27de94e6b81d28e845","title":"排查视觉问题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/vision/troubleshoot-vision","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"修复常见的 Unreal 视觉问题，包括缺少视觉上下文、启动失败、空白渲染目标以及无效的源注册。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"视觉"}]},{"id":"4a5f4bca34572e7102d0b723f97623ed14ebc472","title":"凝视注意力","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/gaze-attention","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找凝视注意力系统的指南和参考，该系统允许玩家通过注视世界对象来引导 Convai 角色的关注。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"}]},{"id":"d8a57f062e27764c8ec780df8b4e07d5b4d4282b","title":"凝视注意力如何工作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/gaze-attention/how-gaze-attention-works","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解凝视追踪管线、注意力提升计时器、组件范围目标、高亮渲染以及注意力来源锁定规则。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"凝视注意力"}]},{"id":"c5d49eeda517161a96ea3016fa123bc1694b506f","title":"凝视注意力快速入门","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/gaze-attention/gaze-attention-quick-start","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"在 Convai Player Component 上启用凝视注意力，并验证当玩家看向一个已标记的世界对象时角色会作出响应。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"凝视注意力"}]},{"id":"797ae18ef94bcef2ec7816f079c7a35fb212a26c","title":"凝视注意力参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/gaze-attention/gaze-attention-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"凝视注意力系统的完整属性、事件、方法和类参考，包括所有默认值和版本特定行为。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"凝视注意力"}]},{"id":"2f301cf695f654f0b6dc66672ff9462854021237","title":"凝视注意力使用示例","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/gaze-attention/gaze-attention-usage-examples","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"用于凝视事件、自定义高亮效果、组件范围目标、手动注意力锁定以及构建自定义光标小部件的 Blueprint 示例。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"凝视注意力"}]},{"id":"ca4f4235151ab1fee69bb58487611f1c6ec30cc6","title":"排查凝视注意力问题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/gaze-attention/troubleshoot-gaze-attention","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"诊断并修复凝视注意力问题——对象不高亮、注意力从不提升、光标不出现以及组件范围凝视不匹配。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"凝视注意力"}]},{"id":"cc7d248786c91571b1e6761c7044cd749219d47a","title":"口型同步","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/lip-sync","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用预计算的 blendshape 数据和 Convai Face Sync AnimGraph 节点，让角色面部与 Convai 语音同步动画。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"}]},{"id":"713990439742181b882d6f2ca1521bb051a162be","title":"口型同步如何工作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/lip-sync/how-lip-sync-works","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解 Convai 如何随音频一起传递面部动画数据、支持的口型同步模式，以及 AnimGraph 节点如何应用它。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"口型同步"}]},{"id":"a955ed0c7ecc780f352ebf46bed957b352c86b62","title":"口型同步快速入门","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/lip-sync/lip-sync-quick-start","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"向 MetaHuman 角色添加 Convai Face Sync 组件和 Convai 动画类，并在编辑器内播放中听到口型同步语音。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"口型同步"}]},{"id":"8b7003d8fdf40c7b56b0fd2a54376bfc5105903c","title":"Face Sync 组件参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/lip-sync/face-sync-component-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai Face Sync 组件的属性参考，以及全部六种口型同步模式值，并附带针对 MetaHuman、CC4、CC5 和自定义骨骼的兼容性说明。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"口型同步"}]},{"id":"ed19695d8a46eb28447110735f1f0dfe84079492","title":"Face Sync AnimGraph 节点参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/lip-sync/face-sync-animgraph-node-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai Face Sync AnimGraph 节点所有属性的参考——应用模式、面部 alpha、平滑、饥饿混合和 blendshape 映射。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"口型同步"}]},{"id":"37d2872ffdb903e0d2cf86a4c12dfd99660c927f","title":"录制并回放口型同步","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/lip-sync/record-and-replay-lip-sync","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"在 Convai 对话期间捕获实时口型同步序列，并稍后在过场、缓存响应或离线预览中回放，而无需重新流式传输。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"口型同步"}]},{"id":"1d4e6a68b8b0634dd00381e03cb9447a556b758c","title":"口型同步使用示例","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/lip-sync/lip-sync-usage-examples","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"为常见场景配置口型同步：Add 与 Override 混合、平滑调优、与身体动画混合，以及将 blendshape 重映射到自定义骨骼。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"口型同步"}]},{"id":"b0b44be9f2ee8ca031b08c9677450b5f826a9c8c","title":"排查口型同步问题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/features/lip-sync/troubleshoot-lip-sync","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"诊断并修复 Convai Unreal Engine 插件中的口型同步问题——嘴部不动、帧饥饿、blendshape 映射错误以及骨骼不匹配。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"功能"},{"label":"口型同步"}]},{"id":"d5eed70628f2e340b85537ef7227b7f8cf81b816","title":"高级主题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/advanced-topics","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找超出核心设置路径之外的 Convai Unreal Engine 插件生产环境身份验证、安全性和集成指南。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"}]},{"id":"136ee5d4e230ae7a3080e60ffdf751abe96f1cb8","title":"使用个人访问令牌","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/advanced-topics/personal-access-token","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"在后端生成短期令牌并将其传递给 Unreal 插件，这样生产构建就不会随程序一起发布真实的 API 密钥。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"高级主题"}]},{"id":"26fe50d5079489485020bc3a2ecb408f1264666e","title":"Blueprint 参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/blueprint-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找 Convai Unreal Engine 插件运行时工作流的已验证 Blueprint 组件、实用工具、音频和共享数据参考。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"}]},{"id":"4a6e5ee0afdb709983f0b5685e8cf00febcf5282","title":"Convai Chatbot 组件","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/blueprint-reference/convai-chatbot-component","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"AI 角色组件参考——Convai Chatbot Component 暴露的每个 Blueprint 可见属性、函数和事件。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"Blueprint 参考"}]},{"id":"7882b4c0154c419a4eb6df2db3b2035b55cacb03","title":"Convai Player 组件","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/blueprint-reference/convai-player-component","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"玩家对话组件参考——Convai Player Component 暴露的每个 Blueprint 可见属性、函数和事件。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"Blueprint 参考"}]},{"id":"0d2b21389ed61f2a508324d6aaffcbf7a2e30487","title":"Convai Object 组件","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/blueprint-reference/convai-object-component","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"对象标记组件参考——Convai Object Component 暴露的每个 Blueprint 可见属性、函数和事件。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"Blueprint 参考"}]},{"id":"66c756b3aff92ca8b5e88b114dba034ef0b5618c","title":"麦克风与音频采集","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/blueprint-reference/microphone-and-audio-capture","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai Player Component、音频采集组件以及 Android 权限上的麦克风设备枚举、选择和音量参考。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"Blueprint 参考"}]},{"id":"54960e661fc090cc4ab31a059146f22c63a84ad3","title":"Convai 实用函数","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/blueprint-reference/convai-utility-functions","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找用于注视查询、组件查找、音频工具、设置、诊断和命令行标志的跨领域 Blueprint 帮助节点。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"Blueprint 参考"}]},{"id":"96e94ab984072449ee1b8486ef735cc01a5fccde","title":"数据类型与枚举","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/blueprint-reference/data-types-and-enums","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai Unreal Engine 插件中 Blueprint 暴露的结构体和枚举参考，包括对象条目、动作类型、情绪和连接状态。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"Blueprint 参考"}]},{"id":"e2e7f8bd503c5aafc00031c0b28f89d4c6f98f44","title":"Convai 编辑器窗口","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/editor-window","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"打开 Convai 编辑器窗口，了解其主要部分，并找到账户、更新、支持和日志导出工作流。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"}]},{"id":"c37da645d6c4d8ad630a1978e56024b32d84eaf9","title":"登录并管理你的账户","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/editor-window/sign-in-and-manage-your-account","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"通过编辑器窗口连接你的 Convai 账户，退出以切换账户，并在 Unreal Editor 中查看计划、配额和使用详情。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"Convai 编辑器窗口"}]},{"id":"510a0da18e9eb8892cbee08047525795b57725aa","title":"浏览示例与内容","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/editor-window/browse-samples-and-content","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查看 Convai Editor 窗口中的当前 Samples 区域，并了解示例项目将在未来更新中如何展示。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"Convai 编辑器窗口"}]},{"id":"79fd9d6c59b3b63b7cf2862389b38dcf2a4493be","title":"导出诊断日志","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/editor-window/export-diagnostic-logs","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"从 Unreal Editor 导出 Convai 诊断信息，并将生成的日志包附加到 Convai Developer Forum 支持请求中。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"Convai 编辑器窗口"}]},{"id":"2c318643919de48c794a1f4b6b1eb25b6e0ed166","title":"故障排除","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/troubleshooting","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"查找 Convai Unreal Engine 插件中的安装、API 密钥、音频、口型同步和连接问题的修复方法，以及日志导出和诊断指导。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"}]},{"id":"34f887e298987790d23b0121952c3cb99a98019f","title":"安装和插件问题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/troubleshooting/installation-and-plugin-issues","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"修复 Convai Unreal Engine 插件中插件未找到错误、模块加载失败、仅蓝图项目限制以及 Android 打包错误。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"故障排除"}]},{"id":"f1b3d71c37ea498f3d6d84fdf60594d3020ae6bf","title":"连接和 API 密钥问题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/troubleshooting/connection-and-api-key-issues","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"修复 Convai Unreal Engine 插件中的身份验证失败、缺少 API 密钥错误、会话超时和防火墙问题。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"故障排除"}]},{"id":"162be7d038eafe64dac814c14bb82a2b2ad8b2e3","title":"音频和麦克风问题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/troubleshooting/audio-and-microphone-issues","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"修复 Convai Unreal Engine 插件中的音频采集失败、错误的麦克风设备、Android 权限错误以及音频播放问题。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"故障排除"}]},{"id":"aade7c9244e67877d732705a3f1075d5958e0a22","title":"口型同步和动画问题","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/troubleshooting/lip-sync-and-animation-issues","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"修复 Convai Unreal Engine 插件中的嘴部不动、blendshape 曲线错误、帧饥饿以及打包构建动画失败问题。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"故障排除"}]},{"id":"76a35097e5aafc7db6e701235cba4c330c02ad3a","title":"诊断与日志导出","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-unreal-engine-plugin/troubleshooting/diagnostics-and-log-export","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai Unreal Engine 插件的日志类别、详细级别、配置默认值、Blueprint 诊断节点以及日志文件导出的参考。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Unreal Engine 插件"},{"label":"故障排除"}]},{"id":"3d133f881b9cb5d5595a6cc440533ff3c4ed09ff","title":"Web 插件","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"将 Convai AI 集成到你的网站中。按照我们的 Web 插件文档进行无缝设置。","breadcrumbs":[{"label":"插件与集成"}]},{"id":"95734e302f1d6699c396cc7bdcfcf38ef7839d02","title":"Convai Web SDK","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/convai-web-sdk","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"探索 Convai Web SDK——为浏览器提供快速、低延迟、以语音为先的 AI 角色交互","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"}]},{"id":"582066e7524392f36f74e9cf6ee977b3a11c8c00","title":"React","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/convai-web-sdk/react","siteSpaceId":"sitesp_LgR0b","lang":"zh","icon":"react","description":"了解如何安装、配置并集成 Convai Web SDK（@convai/web-sdk），为你的 Web 应用带来低延迟会话式 AI、语音交互和可选视频。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"Convai Web SDK"}]},{"id":"68959b8b127b7dad992c41de6f7e87cd945ce3e3","title":"useConvaiClient Hook","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/convai-web-sdk/react/useconvaiclient-hook","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"useConvaiClient 管理所有 Convai 连接逻辑、音频/视频管线和消息流。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"Convai Web SDK"},{"label":"React","icon":"react"}]},{"id":"eb896fafee38ed6296228fce9cc8190b93be03b8","title":"ConvaiWidget","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/convai-web-sdk/react/convaiwidget","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"ConvaiWidget 是一个集成了语音、文本、视频和屏幕共享的一体化界面。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"Convai Web SDK"},{"label":"React","icon":"react"}]},{"id":"22ae6f4a7ad0727295a752b42c53546668e69c5a","title":"实时口型同步","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/convai-web-sdk/react/real-time-lipsync","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"在你的 React 应用中集成实时面部动画。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"Convai Web SDK"},{"label":"React","icon":"react"}]},{"id":"a3978c3ff1ab0d126b04a15a7cc212776a8745d3","title":"自定义 UI 与高级用法","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/convai-web-sdk/react/custom-ui-and-advanced-usage","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"在使用 Convai 音频管线和消息系统的同时构建你自己的 UI。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"Convai Web SDK"},{"label":"React","icon":"react"}]},{"id":"40347340c726b64e9b42d20d133807f8d73d6014","title":"音频可视化器（可选）","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/convai-web-sdk/react/audio-visualizer-optional","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"你可以使用 Web Audio 和 WebRTC 房间从机器人音频创建实时可视化效果。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"Convai Web SDK"},{"label":"React","icon":"react"}]},{"id":"454c92abc7b09c6c632d94aa99c7adc9ccd49df0","title":"原生 TypeScript","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/convai-web-sdk/vanilla-typescript","siteSpaceId":"sitesp_LgR0b","lang":"zh","icon":"js","description":"使用 @convai/web-sdk 与原生 TypeScript 应用的完整指南（无需 React 或框架）。直接使用 ConvaiClient 类，连接事件并构建你自己的 UI。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"Convai Web SDK"}]},{"id":"f1fc7386520b3ebeeafa719a8d9efb554e1d7024","title":"ConvaiClient（核心 API）","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/convai-web-sdk/vanilla-typescript/convaiclient-core-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"ConvaiClient 是在原生 TypeScript 中管理 Convai 的主类。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"Convai Web SDK"},{"label":"原生 TypeScript","icon":"js"}]},{"id":"ffc5fb138ba8c77242a24832c33e0e453dfb2b0f","title":"事件与消息处理","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/convai-web-sdk/vanilla-typescript/events-and-message-handling","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"ConvaiClient 提供强类型事件系统。使用 client.on(event, handler) 订阅。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"Convai Web SDK"},{"label":"原生 TypeScript","icon":"js"}]},{"id":"e842433c402c6a1f2b7938d74b7fd4adf7da7152","title":"实时口型同步","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/convai-web-sdk/vanilla-typescript/real-time-lipsync","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"在原生 JavaScript/TypeScript 应用中集成实时面部动画。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"Convai Web SDK"},{"label":"原生 TypeScript","icon":"js"}]},{"id":"548c1fa63be041ce888c5b5dc2a5a0f245175f1a","title":"构建自定义 UI（TypeScript）","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/convai-web-sdk/vanilla-typescript/building-a-custom-ui-typescript","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"本页展示如何使用原生 TypeScript 搭建一个基于 DOM 的简单聊天 UI。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"Convai Web SDK"},{"label":"原生 TypeScript","icon":"js"}]},{"id":"dff296725774f9173a7391e28344f5f94cf35b60","title":"最佳实践与类型定义","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/convai-web-sdk/vanilla-typescript/best-practices-and-type-definitions","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"推荐模式与主要 TypeScript 类型的摘要，便于快速参考。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"Convai Web SDK"},{"label":"原生 TypeScript","icon":"js"}]},{"id":"4478f4a3cec9e37c9839b186fe7a71671f76fa3e","title":"映射参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/convai-web-sdk/vanilla-typescript/mappings-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"Convai Web SDK"},{"label":"原生 TypeScript","icon":"js"}]},{"id":"d0a340efaa03efbf9f48468574240155f5d5b4d8","title":"快速入门","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/convai-web-sdk/quickstart","siteSpaceId":"sitesp_LgR0b","lang":"zh","icon":"forward-fast","description":"让 Convai 角色在五分钟内在你的应用中开口说话。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"Convai Web SDK"}]},{"id":"29f9aac19fcc2f8cd08338eeb8c9340da2c133cf","title":"口型同步与 Blendshape","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/convai-web-sdk/lipsync-and-blendshape","siteSpaceId":"sitesp_LgR0b","lang":"zh","icon":"head-side-speak","description":"使用与机器人音频一同流式传输的 blendshape 数据，为 3D 角色驱动实时面部动画。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"Convai Web SDK"}]},{"id":"503cd2436973022c29d385f47025d13de33f428c","title":"动作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/convai-web-sdk/actions","siteSpaceId":"sitesp_LgR0b","lang":"zh","icon":"person-running","description":"动作让角色决定在场景中要做什么。你在连接时声明可用的交互能力；角色会根据对话决定何时以及做什么。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"Convai Web SDK"}]},{"id":"fbbbd0f0562949935efa193bf3c3c873cfe32e94","title":"情绪","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/convai-web-sdk/emotions","siteSpaceId":"sitesp_LgR0b","lang":"zh","icon":"face-smile-plus","description":"启用情绪检测，以在对话期间接收角色的情绪状态。启用情绪检测，以在每次响应时连同角色的情绪状态一起接收。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"Convai Web SDK"}]},{"id":"4c37a8e73c580fc9f3ebe503a43373bd3551a22e","title":"动态上下文","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/convai-web-sdk/dynamic-context","siteSpaceId":"sitesp_LgR0b","lang":"zh","icon":"connectdevelop","description":"将实时上下文注入角色的理解中——游戏状态、用户偏好、场景变化——无需重新连接。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"Convai Web SDK"}]},{"id":"4f33318cc644cad5dc970e09e48c72b8b29329f6","title":"长期记忆","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/convai-web-sdk/long-term-memory","siteSpaceId":"sitesp_LgR0b","lang":"zh","icon":"brain","description":"Convai 可以跨会话记住有关用户的信息。提供 `endUserId` 后，角色会自动构建并回忆长期记忆。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"Convai Web SDK"}]},{"id":"534e8cdc1d57114dcd7601d4455823f77a9ad2ef","title":"身份验证令牌","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/convai-web-sdk/auth-tokens","siteSpaceId":"sitesp_LgR0b","lang":"zh","icon":"fingerprint","description":"对于生产应用，请使用短期身份验证令牌，而不是在客户端代码中嵌入 Convai API 密钥。API 密钥保留在服务器上；客户端接收一个 1 小时后过期的令牌。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"Convai Web SDK"}]},{"id":"1ef8009eea712d4c41fd7a2a07e473a277395698","title":"错误处理","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/convai-web-sdk/error-handling","siteSpaceId":"sitesp_LgR0b","lang":"zh","icon":"cloud-xmark","description":"SDK 通过四个通道暴露错误。每个通道都有不同的范围和载荷——知道在给定场景中该使用哪一个是构建可靠应用的关键。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"Convai Web SDK"}]},{"id":"37f8f6ed66558d3e353b5ef0cbc277c4034fc718","title":"WebSocket 传输层","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/convai-web-sdk/websocket-transport-layer","siteSpaceId":"sitesp_LgR0b","lang":"zh","icon":"webhook","description":"SDK 默认使用 WebRTC 进行实时语音对话。在 WebRTC 不可用的环境中，你可以改用基于 WebSocket 的传输。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"Convai Web SDK"}]},{"id":"8c6e3631e7e7da5b3c9acf5a0019d7737dc79e19","title":"事件参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/convai-web-sdk/event-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","icon":"arrow-up-small-big","description":"使用 `client.on(event, callback)` 订阅。返回值是一个取消订阅函数。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"Convai Web SDK"}]},{"id":"8dea6fbbfd8c3da381853b3fffb18e3082c4e54c","title":"PlayCanvas 插件","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/playcanvas-plugin","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"用于 Convai 集成的 PlayCanvas 模板。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"}]},{"id":"bfc4b7db71f84084620166bd73455910620ca081","title":"添加外部脚本","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/playcanvas-plugin/adding-external-script","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"添加外部脚本 - Convai 集成的 PlayCanvas 插件指南。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"PlayCanvas 插件"}]},{"id":"6c5024561403e34aac6a8ab9080f746cc8bd86e7","title":"第一人称视角","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/playcanvas-plugin/first-person-view","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"第一人称视角 - Convai 集成的 PlayCanvas 插件指南。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"PlayCanvas 插件"}]},{"id":"0699b8c7debca52709a584a243dd642cc1365f63","title":"向场景中添加角色","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/playcanvas-plugin/adding-characters-to-scene","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"向场景中添加角色 - Convai 集成的 PlayCanvas 插件指南。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"PlayCanvas 插件"}]},{"id":"f5fa7452bbf00e83bf9916e338891bf5f1bc748a","title":"角色动画","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/playcanvas-plugin/character-animations","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用 Convai 在 PlayCanvas 中添加角色动画。通过交互式 AI 增强你的 Web 项目。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"PlayCanvas 插件"}]},{"id":"0230901d1cd83130228edb2c6a5cc1836f8b5d63","title":"Convai 集成","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/playcanvas-plugin/convai-integration","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai 集成 - 用于无缝集成的 PlayCanvas 插件指南。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"PlayCanvas 插件"}]},{"id":"aaa0b46bddca4d8d0e7e64be0b9f6defbf3da398","title":"聊天叠加层","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/playcanvas-plugin/chat-overlay","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"聊天叠加层 - 用于 Convai 集成的 PlayCanvas 插件指南。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"PlayCanvas 插件"}]},{"id":"aa7a8b1c97f34187c529046eb051c076a2e6cc51","title":"叙事设计指南","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/narrative-design-guide","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"叙事设计 - 基于叙事的 web 端 Convai NPC。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"}]},{"id":"ab1af6c6f7601faa64214d13e1e5e49b205ef772","title":"叙事设计触发器","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/narrative-design-guide/narrative-design-triggers","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"叙事设计指南"}]},{"id":"b08b5c7c4434cca045aacf304daaef6db8b9fb51","title":"叙事设计键","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/narrative-design-guide/narrative-design-keys","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"本指南展示如何将变量动态传递到叙事设计章节和触发器中","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"},{"label":"叙事设计指南"}]},{"id":"3acc9d52559821ee59ea29e06da78226d89ed542","title":"适用于 Convai 的 GLB/FBX 动画","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/web-plugins/glb-fbx-animations-for-convai","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"学习如何将 GLB 和 FBX 动画集成到 Convai 的 web 插件中，以实现动态角色动作。","breadcrumbs":[{"label":"插件与集成"},{"label":"Web 插件"}]},{"id":"c0d5d66c03dc68f83034f5e082f22a69941e42c9","title":"模组框架","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/modding-framework","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai 推出模组框架，支持在 Unreal、Unity 等多种引擎的游戏中轻松集成 AI 驱动的 NPC。","breadcrumbs":[{"label":"插件与集成"}]},{"id":"312167d612f50716eb2061f21cb543f43691d73d","title":"《赛博朋克 2077》模组制作","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/modding-framework/modding-cyberpunk-2077","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"本指南将展示如何制作为《赛博朋克 2077》添加 Convai 功能的模组","breadcrumbs":[{"label":"插件与集成"},{"label":"模组框架"}]},{"id":"d10bd82694da854567f455bfd84dfb6ef0689a40","title":"其他集成","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/other-integrations","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"","breadcrumbs":[{"label":"插件与集成"}]},{"id":"7959b08f7b2583621e369df08251f7868cebf50b","title":"第三方 API 集成","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/other-integrations/third-party-api-integrations","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"集成 ElevenLabs 等外部 API，以通过高级功能增强你的应用。","breadcrumbs":[{"label":"插件与集成"},{"label":"其他集成"}]},{"id":"4f65862d3a65c69af5bc09051c76752384ab9ffc","title":"ElevenLabs API 集成","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/other-integrations/third-party-api-integrations/elevenlabs-api-integration","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"这是关于如何将 ElevenLabs 语音与 Convai 角色集成的指南","breadcrumbs":[{"label":"插件与集成"},{"label":"其他集成"},{"label":"第三方 API 集成"}]},{"id":"e3b2574f41391a110a00219f0017e755c074458e","title":"Convai Pixel Streaming 嵌入","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-pixel-streaming-embed","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"","breadcrumbs":[{"label":"插件与集成"}]},{"id":"160b67ed81203fc1670d38b8323bb9e39264f2cb","title":"白名单设置与发布体验","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-pixel-streaming-embed/whitelisting-and-publishing-an-experience","siteSpaceId":"sitesp_LgR0b","lang":"zh","icon":"chalkboard","description":"了解如何发布你的场景并设置域名白名单，以便在你的 Web 应用中安全嵌入 Convai 体验。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Pixel Streaming 嵌入"}]},{"id":"f044cf72f92d03a24caabe7e8ecdaa28ab4823ca","title":"React TypeScript","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-pixel-streaming-embed/react-typescript","siteSpaceId":"sitesp_LgR0b","lang":"zh","icon":"react","description":"使用 @convai/experience-embed 在你的 React TypeScript 应用中设置并集成 Convai 的 Pixel Streaming 组件。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Pixel Streaming 嵌入"}]},{"id":"187be7fbee5dd6f1fa72a7cb208fa6a4578b32d8","title":"ReactJS（JavaScript）","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-pixel-streaming-embed/reactjs-javascript","siteSpaceId":"sitesp_LgR0b","lang":"zh","icon":"react","description":"使用 @convai/experience-embed 组件将 Convai 的 Pixel Streaming 集成到你的 React JavaScript 应用中。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Pixel Streaming 嵌入"}]},{"id":"2ee929ec767e1d00ab78c4c9e94458676bd7a970","title":"原生 JavaScript（ES 模块）","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-pixel-streaming-embed/vanilla-javascript-es-modules","siteSpaceId":"sitesp_LgR0b","lang":"zh","icon":"js","description":"在支持原生 ES 模块的浏览器 JavaScript 应用中直接使用 Convai 的 Pixel Streaming 客户端。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Pixel Streaming 嵌入"}]},{"id":"68922441d3a02dbe45f8a18c8887daf138b477cc","title":"CDN（UMD 脚本）","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-pixel-streaming-embed/cdn-umd-script","siteSpaceId":"sitesp_LgR0b","lang":"zh","icon":"js","description":"使用来自 CDN 的 UMD 构建版本，将 Convai 的 Pixel Streaming 直接集成到你的 Web 应用中。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Pixel Streaming 嵌入"}]},{"id":"fc26adab6d4c72826ab5e3d64952bc0cd8159c7d","title":"本地部署","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-pixel-streaming-embed/on-premise-deployment","siteSpaceId":"sitesp_LgR0b","lang":"zh","icon":"building","description":"配置 Convai 的 Pixel Streaming 客户端，以连接你自己的后端和流媒体服务器，用于本地或自托管部署。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Pixel Streaming 嵌入"}]},{"id":"87b57936662c69d8802f20f500191b181163cf02","title":"API 参考","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/convai-pixel-streaming-embed/api-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","icon":"webhook","description":"了解在 React、原生 JS、TypeScript 和 CDN 设置中使用 Convai 的 Pixel Streaming 客户端时可用的属性、选项和方法。","breadcrumbs":[{"label":"插件与集成"},{"label":"Convai Pixel Streaming 嵌入"}]},{"id":"775cb607c7c773c413bf4787a95748354073b3ea","title":"资源上传器","pathname":"/api-docs/zh/cha-jian-yu-ji-cheng/asset-uploader","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用 Convai Asset Uploader 工具将 Metahuman、Reallusion 角色和场景从 Unreal Engine 上传到 Convai Sim 和 Avatar Studio。","breadcrumbs":[{"label":"插件与集成"}]},{"id":"ac0bd8ac53768439ac93a54d95eb91f3d027ed53","title":"核心 API 参考","pathname":"/api-docs/zh/api-can-kao/core-api-reference","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"探索 Convai 的核心 API，分为角色创建和交互 API，用于创建、自定义并与智能 AI 角色交互。","breadcrumbs":[{"label":"API 参考"}]},{"id":"bd5cf9113ab647ed01a0058b5fc3a28316e06869","title":"角色创建 API","pathname":"/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用 Convai 的角色创建 API 创建并配置 AI 角色，以定义其个性、行为、知识等。","breadcrumbs":[{"label":"API 参考"},{"label":"核心 API 参考"}]},{"id":"dab4497e3350d6ecde15c3c9e5ad83e64bc21bc9","title":"角色基础 API","pathname":"/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/character-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用 Convai 创建你自己的智能 AI 角色所需的所有相关 API。","breadcrumbs":[{"label":"API 参考"},{"label":"核心 API 参考"},{"label":"角色创建 API"}]},{"id":"d469688f9d4ad68069e55312cfea61bb7a4d9f24","title":"背景故事 API","pathname":"/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/backstory-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解如何使用背景故事 API 创建和管理角色背景故事，为你的 NPC 增添深度与个性。","breadcrumbs":[{"label":"API 参考"},{"label":"核心 API 参考"},{"label":"角色创建 API"}]},{"id":"022b58fc84ede8ef62eb99e705ed732d009ab0be","title":"思维视图 API","pathname":"/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/mindview-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"了解如何使用背景故事 API 创建和管理角色背景故事，为你的 NPC 增添深度与个性。","breadcrumbs":[{"label":"API 参考"},{"label":"核心 API 参考"},{"label":"角色创建 API"}]},{"id":"ba1c2d733d1597fe6cbe6b30bbd302d5f1bf6fb1","title":"核心 AI 设置 API","pathname":"/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/core-ai-settings-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"修改 Convai 角色核心 AI 设置所需的所有相关 API。","breadcrumbs":[{"label":"API 参考"},{"label":"核心 API 参考"},{"label":"角色创建 API"}]},{"id":"188670c7a430f8bc1c5fbd90fa7d6e22f07d3474","title":"叙事设计 API","pathname":"/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/narrative-design-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"本页列出了与叙事设计交互所需的所有 API","breadcrumbs":[{"label":"API 参考"},{"label":"核心 API 参考"},{"label":"角色创建 API"}]},{"id":"7c5287afcd4e876cdd7ac8cac05b07b2529acb89","title":"知识库 API","pathname":"/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/knowledge-bank-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用 Convai 为你的 AI 角色与知识库交互所需的所有相关 API。","breadcrumbs":[{"label":"API 参考"},{"label":"核心 API 参考"},{"label":"角色创建 API"}]},{"id":"f8d44c79bf1e017f91e01dcd9fb7a3a708930589","title":"动作 API","pathname":"/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/action-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"本页介绍动作 API 及其使用方法。","breadcrumbs":[{"label":"API 参考"},{"label":"核心 API 参考"},{"label":"角色创建 API"}]},{"id":"ac8129adfcadd7218ac6e52bdc6388fefcf9351a","title":"聊天历史 API","pathname":"/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/chat-history-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"与会话或角色聊天历史交互所需的所有相关 API。","breadcrumbs":[{"label":"API 参考"},{"label":"核心 API 参考"},{"label":"角色创建 API"}]},{"id":"0bef86f48f506b7240afeae45c35ccdd06027c8e","title":"评估 API","pathname":"/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/evaluation-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"用于根据用户定义属性评估对话转录的 API（例如回复清晰度、礼貌程度、倾听能力等）。","breadcrumbs":[{"label":"API 参考"},{"label":"核心 API 参考"},{"label":"角色创建 API"}]},{"id":"fdfed88f59c6997bd47c6e08c93781d8de8d9d7d","title":"语言列表 API","pathname":"/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/language-list-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"用于检索用户可用的完整语言列表，包括公开和私有语言。","breadcrumbs":[{"label":"API 参考"},{"label":"核心 API 参考"},{"label":"角色创建 API"}]},{"id":"ca26d73f8d2e97a80021565ab030a9f12904f637","title":"语音列表 API","pathname":"/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/voice-list-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"用于检索用户可用的完整语音列表，包括公开和私有语音。","breadcrumbs":[{"label":"API 参考"},{"label":"核心 API 参考"},{"label":"角色创建 API"}]},{"id":"533981de37c51ca21e1526c104e6de84309a01a1","title":"角色列表 API","pathname":"/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/character-list-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"用于检索由用户创建的角色列表的 API。","breadcrumbs":[{"label":"API 参考"},{"label":"核心 API 参考"},{"label":"角色创建 API"}]},{"id":"e0a8ed2821b28ff6170dfa21cdc8eace267010ac","title":"实时 API（Beta）","pathname":"/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"通过基于 WebRTC 的实时 API 启用与 Convai AI 角色的实时、低延迟交互，支持文本、音频和动态上下文通信。","breadcrumbs":[{"label":"API 参考"},{"label":"核心 API 参考"}]},{"id":"70d752d330612b0fbf1290588e718236d6a18f0e","title":"连接 API","pathname":"/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/connect-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"为你的 Convai 角色建立实时聊天机器人会话，使用户能够通过音频或视频连接并保持对话上下文。","breadcrumbs":[{"label":"API 参考"},{"label":"核心 API 参考"},{"label":"实时 API（Beta）"}]},{"id":"3783a1143c09a1f4cf8ae28b1206fd89d39439d0","title":"指标","pathname":"/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/metrics","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"本页解释通过 WebRTC 数据通道发送给客户端的指标。","breadcrumbs":[{"label":"API 参考"},{"label":"核心 API 参考"},{"label":"实时 API（Beta）"}]},{"id":"29ba5f52bd1ff6aac10fb390cafb074f474ab066","title":"音频数据（通过数据通道）","pathname":"/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/audio-data-via-data-channel","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"本页解释通过 WebRTC 数据通道发送给客户端的指标。","breadcrumbs":[{"label":"API 参考"},{"label":"核心 API 参考"},{"label":"实时 API（Beta）"}]},{"id":"52997086a1139479d2cbe158e37133880276b547","title":"消息术语表","pathname":"/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/message-glossary","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai 实时 API 中所有可用于客户端与服务器之间实时通信的消息类型完整术语表。","breadcrumbs":[{"label":"API 参考"},{"label":"核心 API 参考"},{"label":"实时 API（Beta）"}]},{"id":"138cedadc568671d93b18cf90042de5055cbffd5","title":"客户端到服务器消息","pathname":"/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/client-to-server-messages","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"参考客户端通过 WebRTC 数据通道发送到 Convai 实时 API 服务器的所有消息，包括负载、字段和响应详情。","breadcrumbs":[{"label":"API 参考"},{"label":"核心 API 参考"},{"label":"实时 API（Beta）"}]},{"id":"59c52679f01490a61606cfcd7dd110c8f8fec77f","title":"服务器到客户端消息","pathname":"/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/server-to-client-messages","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"Convai 在实时 API 中通过 WebRTC 数据通道发送给客户端的所有消息的完整参考，包括字段、类型和推荐操作。","breadcrumbs":[{"label":"API 参考"},{"label":"核心 API 参考"},{"label":"实时 API（Beta）"}]},{"id":"ffe18fb0b07b794ff9577fd74da0e402cd3901fe","title":"交互 API","pathname":"/api-docs/zh/api-can-kao/core-api-reference/interaction-apis","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"使用 Convai 的交互 API 启用与 AI 角色的实时交互，实现自然的文本和语音通信。","breadcrumbs":[{"label":"API 参考"},{"label":"核心 API 参考"}]},{"id":"9f68825136f6ad3eb76c8a1fdee1f114238c1f07","title":"交互 API","pathname":"/api-docs/zh/api-can-kao/core-api-reference/interaction-apis/interaction-api","siteSpaceId":"sitesp_LgR0b","lang":"zh","description":"本页详细说明如何与角色交互。","breadcrumbs":[{"label":"API 参考"},{"label":"核心 API 参考"},{"label":"交互 API"}]}]}