> For the complete documentation index, see [llms.txt](https://docs.convai.com/api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/compatibility-and-requirements/platform-support-matrix.md). # Platform support matrix The Convai Unity SDK runs on all major Unity deployment targets. Feature availability varies by platform — use the matrix below to confirm support before building for a specific target. ### Feature × platform matrix | Feature | Windows / macOS / Linux | Android | iOS | Meta Quest | WebGL | | -------------------------- | ----------------------- | ------------------------------ | -------------------------------------- | --------------------- | -------------------------------------- | | Voice conversation | ✅ Full | ✅ Full | ✅ Full | ✅ Full | ✅ Full | | Microphone capture | ✅ Full | ✅ Full | ✅ Full | ✅ Full | ✅ Full — HTTPS + user gesture required | | Remote audio playback | ✅ Unity `AudioSource` | ✅ Unity `AudioSource` | ✅ Unity `AudioSource` | ✅ Unity `AudioSource` | ⚠️ Browser-routed | | Lip sync | ✅ Full | ✅ Full | ✅ Full | ✅ Full | ⚠️ Known timing drift | | Spatial audio | ✅ Full | ✅ Full | ✅ Full | ✅ Full | ❌ Not supported | | Actions | ✅ Full | ✅ Full | ✅ Full | ✅ Full | ✅ Full | | Emotion | ✅ Full | ✅ Full | ✅ Full | ✅ Full | ✅ Full | | Long-Term Memory | ✅ Full | ✅ Full | ✅ Full | ✅ Full | ✅ Full | | Narrative Design | ✅ Full | ✅ Full | ✅ Full | ✅ Full | ✅ Full | | Dynamic Context | ✅ Full | ✅ Full | ✅ Full | ✅ Full | ✅ Full | | Vision — Camera | ✅ Full | ✅ Full | ✅ Full | ✅ Full | ⚠️ Canvas capture | | Vision — Webcam | ✅ Full | ⚠️ Runtime permission required | ⚠️ `NSCameraUsageDescription` required | ❌ Not applicable | ❌ Not supported | | Vision — Quest passthrough | ❌ Not supported | ❌ Not supported | ❌ Not supported | ✅ Full | ❌ Not supported | ### Platform-specific requirements {% tabs %} {% tab title="WebGL" %} WebGL is fully supported with the following constraints imposed by browser security policies: * **Microphone capture** requires HTTPS or `localhost`. HTTP deployments cannot access the microphone. Call `ConvaiManager.EnableAudioAndStartListening()` from a user gesture (button click) — do not start audio automatically on scene load. * **Remote audio playback** is routed through the browser's audio system, not Unity's `AudioSource`. Volume and spatialization controls on `AudioSource` components have no effect on WebGL. * **Vision — Camera** uses browser canvas capture (`CameraVisionFrameSource` is supported). * **Vision — Webcam** (`WebcamVisionFrameSource`) is not supported on WebGL — `AsyncGPUReadback` is unavailable in the browser runtime. Use `CameraVisionFrameSource` to stream the game canvas instead. * **Spatial audio** is not supported on WebGL. {% hint style="warning" %} WebGL has a known audio/lip-sync timing drift defect — audio and lip-sync data arrive correctly, but playback timing can drift in browser builds. This is a tracked defect, not a missing feature. Validate in your target browser before shipping. {% endhint %} {% hint style="info" %} Always validate WebGL builds in the actual hosting environment, especially if the build is embedded in an iframe. Add `allow="microphone"` to the iframe tag if you embed the build in a page you control. {% endhint %} For detailed WebGL setup, browser compatibility, and deployment steps, see the WebGL platform guide. {% content-ref url="/pages/7b2c74ff6faeac7d9557447799d0496b11e50783" %} [WebGL](/api-docs/plugins-and-integrations/convai-unity-sdk/platform-guides/webgl.md) {% endcontent-ref %} {% endtab %} {% tab title="Android" %} * **Microphone:** The SDK requests `RECORD_AUDIO` permission at runtime via `ConvaiPermissionService`. Declare the permission in your `AndroidManifest.xml` and handle both grant and denial cases in your app flow. * **Vision — Webcam:** `android.permission.CAMERA` is requested at runtime by `WebcamVisionFrameSource`. Handle permission grant and denial in your app flow. For Android build configuration, permission handling, and microphone setup, see the iOS and Android platform guide. {% content-ref url="/pages/32708cb5ab33fa2d1d0f91e747cc06da20220bc1" %} [iOS and Android](/api-docs/plugins-and-integrations/convai-unity-sdk/platform-guides/ios-and-android.md) {% endcontent-ref %} {% endtab %} {% tab title="iOS" %} * **Microphone:** `NSMicrophoneUsageDescription` must be set in **Player Settings → Other Settings → iOS → Microphone Usage Description**. Omitting this causes a crash on first microphone access. * **Vision — Webcam:** `NSCameraUsageDescription` must be set in **Player Settings → Other Settings → iOS → Camera Usage Description** if you use `WebcamVisionFrameSource`. On iOS, `WebcamVisionFrameSource` accesses the device camera via Unity's `WebCamTexture` API. * Define your app's behavior when the user denies microphone or camera permission, and when the app is interrupted or backgrounded during a conversation. For iOS build configuration, permission setup, and Info.plist requirements, see the iOS and Android platform guide. {% content-ref url="/pages/32708cb5ab33fa2d1d0f91e747cc06da20220bc1" %} [iOS and Android](/api-docs/plugins-and-integrations/convai-unity-sdk/platform-guides/ios-and-android.md) {% endcontent-ref %} {% endtab %} {% tab title="Meta Quest" %} Quest passthrough vision (`QuestVisionFrameSource`) is supported on **Quest 3 and Quest 3S only**. **Requirements:** * Meta XR SDK imported into your project * `PassthroughCameraAccess` component present in the scene The required passthrough camera permissions are declared automatically when Meta XR SDK is imported. On other Quest hardware or non-Quest platforms, `QuestVisionFrameSource` produces no frames. Use `CameraVisionFrameSource` or `WebcamVisionFrameSource` instead. `WebcamVisionFrameSource` is not applicable on Meta Quest because Quest does not expose a standard `WebCamTexture` device. For Meta Quest project setup, XR SDK configuration, and passthrough Vision integration, see the XR headsets platform guide. {% content-ref url="/pages/86442e40afdd1c7fd12eb8dc8331a0cc75827347" %} [XR headsets](/api-docs/plugins-and-integrations/convai-unity-sdk/platform-guides/xr-headsets.md) {% endcontent-ref %} {% endtab %} {% endtabs %} ### Next steps With platform constraints confirmed, review the network requirements for real-time SDK operation. {% content-ref url="/pages/451345facd5cd16f0b40e81f6f7a06784935c82b" %} [Network and API requirements](/api-docs/plugins-and-integrations/convai-unity-sdk/compatibility-and-requirements/network-and-api-requirements.md) {% endcontent-ref %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/compatibility-and-requirements/platform-support-matrix.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.