> 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/zh/cha-jian-yu-ji-cheng/convai-pixel-streaming-embed.md).

# Convai Pixel Streaming 嵌入

查找在网站中嵌入已发布的 Convai Pixel Streaming 体验的指南和 API 参考，支持 React、JavaScript 模块或 script 标签。

Convai Pixel Streaming Embed 可将已发布的 Avatar Studio 体验嵌入你自己的网站。 `@convai/experience-embed` 包会在页面的 iframe 中渲染从 Convai 流式传输的体验，并允许你的代码控制摄像头、音频、麦克风和聊天功能。当前版本为 <code class="expression">space.vars.experience\_embed\_version</code>.

首先发布体验并选择授权方式，然后按照适用于你的技术栈的指南进行操作。

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>发布并授权体验</strong><br>获取体验 ID，并通过身份验证令牌或加入允许列表的域名为嵌入内容授权。</td><td><a href="https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-pixel-streaming-embed/whitelisting-and-publishing-an-experience.md">发布并授权体验</a></td></tr><tr><td><strong>在 React TypeScript 应用中嵌入体验</strong><br>安装软件包、渲染体验，并通过自己的界面进行控制。</td><td><a href="https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-pixel-streaming-embed/react-typescript.md">在 React TypeScript 应用中嵌入体验</a></td></tr><tr><td><strong>在 React JavaScript 应用中嵌入体验</strong><br>在使用 JavaScript 编写的 React 应用中使用相同的组件。</td><td><a href="https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-pixel-streaming-embed/reactjs-javascript.md">在 React JavaScript 应用中嵌入体验</a></td></tr><tr><td><strong>使用 JavaScript 模块嵌入体验</strong><br>通过模块脚本使用不依赖框架的客户端，无需 React。</td><td><a href="https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-pixel-streaming-embed/vanilla-javascript-es-modules.md">使用 JavaScript 模块嵌入体验</a></td></tr><tr><td><strong>使用 script 标签嵌入体验</strong><br>在纯 HTML 页面中从 CDN 加载软件包，无需构建步骤。</td><td><a href="https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-pixel-streaming-embed/cdn-umd-script.md">使用脚本标签嵌入体验</a></td></tr><tr><td><strong>配置本地部署</strong><br>将嵌入内容指向你自己的会话服务和流媒体服务器。</td><td><a href="https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-pixel-streaming-embed/on-premise-deployment.md">配置本地部署</a></td></tr><tr><td><strong>Pixel Streaming Embed API 参考</strong><br>所有属性、选项、方法、回调和错误消息。</td><td><a href="https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-pixel-streaming-embed/api-reference.md">Pixel Streaming Embed API 参考</a></td></tr></tbody></table>


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.convai.com/api-docs/zh/cha-jian-yu-ji-cheng/convai-pixel-streaming-embed.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
