> 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/unity-plugin-beta-overview/features/vision/quick-start.md). # Quick Start ## Your First Vision Setup This guide walks you through the minimum steps needed to get a Convai character receiving a live camera feed from your Unity scene. The SDK can add the required components for you automatically — follow the primary path below, or use the manual path if you dismissed the prompt or need a custom placement. {% hint style="info" %} **Prerequisites** * A Unity scene with a `ConvaiCharacter` component already set up and working (the character should respond to speech). * Your Convai API key is configured in **Tools → Convai → Configuration**. {% endhint %} {% stepper %} {% step %} **Set the Connection Type to Video** Select the `ConvaiRoomManager` GameObject in the Hierarchy. In the Inspector, set **Connection Type** to **Video**.
A dialog appears immediately: > **Convai Vision Setup** Connection Type is set to Video, but required vision components are missing. Add `ConvaiVisionPublisher` and `CameraVisionFrameSource` under this ConvaiRoomManager? Click **Add Components**.
The SDK creates a child GameObject named **ConvaiVisionRoot** under `ConvaiRoomManager` and adds both `ConvaiVisionPublisher` and `CameraVisionFrameSource` to it. No further component setup is required. {% hint style="info" %} If you clicked **Later** and need to add the components manually, see Manual Component Setup below. {% endhint %} {% endstep %} {% step %} **Assign a Camera (if not using Camera.main)** Select the **ConvaiVisionRoot** GameObject (under `ConvaiRoomManager`). On the `CameraVisionFrameSource` component, locate the **Target Camera** field. * If your scene has a `Camera` tagged **MainCamera**, leave the field blank — the component resolves it automatically at runtime. * If you want to capture a specific camera (an overhead view, a security camera, etc.), drag that camera into the **Target Camera** field now.
The default **Capture Preset** is **Balanced** (1280 × 720 at 15 fps), which suits most use cases. {% endstep %} {% step %} **Add Vision Debug Preview and Verify** On any scene GameObject, click **Add Component** → **Convai/Vision/Vision Debug Preview (Editor Only)**.
Press **Play**. An overlay appears in the Game view showing the live camera feed and a statistics panel. Once the room connects, the FPS counter increments and the frame count begins increasing — the character is now receiving visual context.
{% endstep %} {% endstepper %} {% hint style="success" %} **Success check** The Debug Preview overlay shows a live image and a non-zero FPS counter. Reading `ConvaiVisionPublisher.IsPublishing` from any script returns `true`. {% endhint %} {% hint style="warning" %} If the overlay stays blank or the FPS counter reads zero, verify that `ConvaiRoomManager.Connection Type` is set to **Video** and that the room has fully connected. See [Troubleshooting](/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/vision/troubleshooting-and-diagnostics.md) for a step-by-step diagnosis. {% endhint %} *** ## Manual Component Setup If you clicked **Later** on the dialog, or want to place the components on a specific GameObject, add them manually: 1. Select the target GameObject (any persistent scene object — typically on or near your NPC). 2. **Add Component** → search for **Convai Vision Publisher**. 3. On the same GameObject (or a child), **Add Component** → **Convai/Vision/Camera Vision Frame Source**. 4. Assign the **Target Camera** if not using `Camera.main`. 5. Leave the **Frame Source Component** field on `ConvaiVisionPublisher` blank — the publisher discovers `CameraVisionFrameSource` on the same GameObject at runtime. Assign it explicitly only if you have multiple frame sources in the scene.
*** ## What Just Happened When you clicked **Add Components** and pressed Play, the following occurred: 1. The SDK created a **ConvaiVisionRoot** child GameObject under `ConvaiRoomManager` and added `ConvaiVisionPublisher` and `CameraVisionFrameSource` to it. 2. `ConvaiRoomManager` established a **Video** connection to the Convai backend. 3. `ConvaiVisionPublisher` detected the active room and waited for the frame source to become ready. 4. `CameraVisionFrameSource` rendered the assigned camera (or `Camera.main`) into a `RenderTexture` and signalled that frames were available. 5. `VisionPublishCoordinator` applied the `AutoCompatible` publish policy — 10 fps, 750 kbps — and passed the texture to the video pipeline. 6. A video track named `"unity-scene"` was published to the Convai backend. `IsPublishing` became `true`. From this point the character receives the live scene camera feed alongside the audio conversation, processed together. ## What's Next * [Frame Sources](/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/vision/frame-sources.md) — Switch to a webcam source on desktop, configure mobile camera permissions, or set up Meta Quest passthrough. * [Publishing & Policies](/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/vision/publishing-and-policies.md) — Tune frame rate and bitrate, or switch to Manual policy for explicit control over when publishing starts. * [Debug Preview](/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/vision/debug-preview.md) — Customise the overlay position, size, and statistics display. * [Troubleshooting & Diagnostics](/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/vision/troubleshooting-and-diagnostics.md) — If anything is not working, start here. ## Conclusion You now have a working Vision setup. The SDK handles component placement and runtime wiring automatically — the character receives a live feed from your scene camera and can reason about what it sees. Explore the guides above to adapt this setup to your target platform and production requirements. --- # 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, and the optional `goal` query parameter: ``` GET https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/vision/quick-start.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.