Back to Details

stream-unity

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Stream Unity - docs orchestrator for Unity Engine

Stream Unity - Unity Engine 文档编排器

Chat and Video. There is no Stream Feeds SDK for Unity (
/activity-feeds/docs/unity
and 
https://getstream.io/cli/docs/activity-feeds-unity.md
both 404). If the user asks for activity feeds in Unity, say so up front and offer the alternatives (the REST/server API driven from your backend, or a platform SDK on a companion app) rather than inventing an API.
These are two separate SDKs, and almost nothing is shared. Different repos, different install mechanisms, different maturity, different supported platforms, different docs quality. There is no combined client, no shared 
AuthCredentials
type (
StreamChat.Libs.Auth.AuthCredentials
and 
StreamVideo.Libs.Auth.AuthCredentials
are distinct types in distinct assemblies), and connecting a user to one does not connect them to the other. Treat "add chat to my Unity call app" as two integrations that happen to share an API key.
ChatVideo
Repo
GetStream/stream-chat-unity
 (default branch 
develop
)
GetStream/stream-video-unity
 (default branch 
main
)
Latestv5.7.0 (stable, 5.x line)0.11.0 (pre-1.0 - the surface still moves)
Install
.unitypackage
from GitHub Releases, imported into 
Assets/
UPM package from a git URL
Entry point
StreamChatClient.CreateDefaultClient()
-> 
IStreamChatClient
StreamVideoClient.CreateDefaultClient()
-> 
IStreamVideoClient
Namespace
StreamChat.Core
StreamVideo.Core
PlatformsEverything Unity targets, WebGL includedAndroid (ARM64), iOS, Windows x64, macOS, Linux. No WebGL, no UWP
Pre-built UINone - a sample project, not componentsNone - a sample project, not components
Docs coverageGood: nearly every page carries real Unity C#Thin: 22 pages; several shipped capabilities have no page at all
Neither SDK ships reusable UI. Both ship a sample project you import and read, not a component library you drop in. Every chat bubble, channel row, participant tile, and call button in the user's game is code you write. Say this before promising a screen, and run 
ui.md
 when building one.
This skill orchestrates: it gates the request against product, platform, and feature support, routes to the exact docs page, fetches it live, and applies it - while carrying the Unity-specific knowledge the docs do not have (the client's hidden 
DontDestroyOnLoad
runner, the track-binding requirement, IL2CPP stripping, and the player settings that decide whether a build works on device at all).
Rules (read once per session): 
RULES.md
 - non-negotiable rules + Unity pitfalls. Read before writing any code.
Chat 和 Video。 Unity 没有 Stream Feeds SDK（
/activity-feeds/docs/unity
和 
https://getstream.io/cli/docs/activity-feeds-unity.md
均为 404）。如果用户询问 Unity 中的 activity feed，请立即说明，并提供替代方案（由后端调用 REST/server API，或在配套应用中使用 platform SDK），而不是虚构 API。
这是两个独立的 SDK，几乎没有任何共享内容。 它们使用不同的仓库、不同的安装机制、不同的成熟度、不同的受支持平台和不同质量的文档。不存在组合式 client，也不存在共享的 
AuthCredentials
类型（
StreamChat.Libs.Auth.AuthCredentials
和 
StreamVideo.Libs.Auth.AuthCredentials
是不同 assembly 中的不同类型），连接到其中一个并不会让用户连接到另一个。将“为我的 Unity call 应用添加 chat”视为两项碰巧共用同一 API key 的集成。
ChatVideo
仓库
GetStream/stream-chat-unity
（默认分支 
develop
）
GetStream/stream-video-unity
（默认分支 
main
）
最新版本v5.7.0（稳定版，5.x 系列）0.11.0（1.0 之前——API surface 仍可能变化）
安装从 GitHub Releases 获取 
.unitypackage
，导入 
Assets/
通过 git URL 安装 UPM package
入口
StreamChatClient.CreateDefaultClient()
-> 
IStreamChatClient
StreamVideoClient.CreateDefaultClient()
-> 
IStreamVideoClient
命名空间
StreamChat.Core
StreamVideo.Core
平台Unity 支持的所有目标平台，包括 WebGLAndroid（ARM64）、iOS、Windows x64、macOS、Linux。不支持 WebGL 和 UWP
预构建 UI无——只有示例项目，不是组件无——只有示例项目，不是组件
文档覆盖良好：几乎每个页面都包含真实的 Unity C# 代码较少：共 22 页；多个已发布的功能完全没有对应页面
两个 SDK 都不提供可复用 UI。 两者提供的是一个供你导入并阅读的 sample project，而不是可直接拖入的组件库。用户游戏中的每个 chat bubble、channel row、participant tile 和 call button 都需要自行编写代码。在承诺实现某个界面之前先说明这一点；构建界面时运行 
ui.md
。
此 skill 负责编排：根据产品、平台和功能支持情况对请求执行 gate，将请求路由到准确的文档页面，实时获取并应用文档，同时补充文档没有的 Unity 专属知识（client 隐藏的 
DontDestroyOnLoad
runner、track 绑定要求、IL2CPP stripping，以及决定构建能否在设备上运行的 player settings）。
规则（每个 session 读取一次）： 
RULES.md
——不可违反的规则与 Unity 陷阱。编写任何代码前先阅读。

Step 0: Three gates, before any code

Step 0：编写任何代码前的三个 gate

Resolve all three from the user's words plus a read-only probe. Each one can turn "here is the code" into "that is not possible", so none is optional and none belongs in a runtime failure later.
根据用户措辞和只读 probe 解决以下三个 gate。每一个都可能将“这里有代码”变成“无法实现”，因此全都不可省略，也都不能留到运行时失败后再处理。

Gate 1: product (and whether it exists for Unity)

Gate 1：产品（以及 Unity 是否支持）

AskAnswer
Chat / messaging / in-game text chatSupported. Chat SDK.
Video calls / audio calls / audio rooms / livestream broadcastSupported. Video SDK.
BothTwo installs, two clients, two connect calls. Do not try to unify them.
Activity feeds / timelines / follow graphNo Unity SDK. State it immediately; offer the server API path.
Moderation review queue / dashboard UINot an app surface. Moderation review happens in the Stream Dashboard; the SDKs expose only end-user actions (flag, mute, ban).
询问答案
Chat / messaging / 游戏内文字聊天支持。使用 Chat SDK。
Video call / audio call / audio room / livestream broadcast支持。使用 Video SDK。
两者都需要两次安装、两个 client、两次 connect 调用。不要尝试将它们统一。
Activity feed / timeline / follow graph没有 Unity SDK。 立即说明，并提供 server API 方案。
Moderation review queue / dashboard UI不是 app surface。Moderation review 在 Stream Dashboard 中进行；SDK 只提供终端用户操作（flag、mute、ban）。

Gate 2: Unity version and build target (the Video SDK is the constraint)

Gate 2：Unity 版本与构建目标（Video SDK 是限制条件）

Probe rather than ask:
bash
bash -c 'echo "=== UNITY VERSION ==="; cat ProjectSettings/ProjectVersion.txt 2>/dev/null; \
echo "=== UPM MANIFEST ==="; cat Packages/manifest.json 2>/dev/null; \
echo "=== STREAM CHAT PRESENT ==="; find . -maxdepth 5 -type d -name "StreamChat" -not -path "*/Library/*" 2>/dev/null; \
echo "=== STREAM VIDEO PRESENT ==="; grep -n "io.getstream.video" Packages/manifest.json 2>/dev/null; \
echo "=== SCRIPTING BACKEND / TARGET ==="; grep -nE "scriptingBackend|AndroidTargetArchitectures|apiCompatibilityLevel|managedStrippingLevel" ProjectSettings/ProjectSettings.asset 2>/dev/null | head -20'
SituationWhat to do
Unity 6 / 2023.1 / 2022.3 / 2021.3 / 2020.3Both SDKs supported.
Unity 2019.4 - 2020.2, Chat onlyChat supports it (the SDK advertises 2019.x). Video does not - its package declares 
"unity": "2020.3"
and its WebRTC fork the same.
Unity 2019.x - 2020.2, Video requestedHard stop for Video. Say it immediately: upgrade the editor, or ship Chat only.
Target is WebGL, Video requestedHard stop. Unity's WebRTC package does not support WebGL, so neither does the Video SDK. Chat does work on WebGL. Offer: Chat on WebGL plus a browser-based Video client, or drop WebGL.
Target is Android, Video requestedARM64 only. ARMv7 is unsupported and must be disabled. See 
platforms.md
.
Target is UWPVideo unsupported.
Target is a consoleChat only, and treat it as unverified - the SDK claims console support but publishes no per-console guidance.
Unity 6 plus Chat carries one hard version floor: Chat v5.4.0 fixed an IL2CPP build crash on Unity 
6000.0.x
(a 
KeyNotFoundException
in IL2CPP's vtable builder). Never pin Chat below v5.4.0 on Unity 6.
执行 probe，而不是直接询问：
bash
bash -c 'echo "=== UNITY VERSION ==="; cat ProjectSettings/ProjectVersion.txt 2>/dev/null; \
echo "=== UPM MANIFEST ==="; cat Packages/manifest.json 2>/dev/null; \
echo "=== STREAM CHAT PRESENT ==="; find . -maxdepth 5 -type d -name "StreamChat" -not -path "*/Library/*" 2>/dev/null; \
echo "=== STREAM VIDEO PRESENT ==="; grep -n "io.getstream.video" Packages/manifest.json 2>/dev/null; \
echo "=== SCRIPTING BACKEND / TARGET ==="; grep -nE "scriptingBackend|AndroidTargetArchitectures|apiCompatibilityLevel|managedStrippingLevel" ProjectSettings/ProjectSettings.asset 2>/dev/null | head -20'
情况处理方式
Unity 6 / 2023.1 / 2022.3 / 2021.3 / 2020.3两个 SDK 均支持。
Unity 2019.4 - 2020.2，仅使用 ChatChat 支持（SDK 声明支持 2019.x）。Video 不支持——其 package 声明 
"unity": "2020.3"
，其 WebRTC fork 也采用相同要求。
Unity 2019.x - 2020.2，需要 VideoVideo 坚决不支持。 立即说明：升级 editor，或仅交付 Chat。
目标平台为 WebGL，需要 Video坚决不支持。 Unity 的 WebRTC package 不支持 WebGL，因此 Video SDK 也不支持。Chat 可以在 WebGL 上运行。提供以下方案：WebGL 上使用 Chat 并搭配基于浏览器的 Video client，或放弃 WebGL。
目标平台为 Android，需要 Video仅支持 ARM64。不支持 ARMv7，必须禁用。见 
platforms.md
。
目标平台为 UWPVideo 不支持。
目标平台为 console仅支持 Chat，并视为未经验证——SDK 声称支持 console，但没有发布任何针对各 console 的指导。
Unity 6 搭配 Chat 时存在一个硬性版本下限：Chat v5.4.0 修复了 Unity 
6000.0.x
上的 IL2CPP 构建崩溃问题（IL2CPP 的 vtable builder 中会抛出 
KeyNotFoundException
）。在 Unity 6 上绝不要将 Chat 固定在 v5.4.0 以下。

Gate 3: feature support (say no in the plan, not in a compile error)

Gate 3：功能支持（在计划阶段说明不支持，而不是等到编译时报错）

Chat - not implemented client-side as of v5.7.0. If the request needs one of these, say so before writing code:
  • Guest and anonymous users (
    ConnectGuestUser
    / anonymous connect do not exist) - this blocks the usual read-only-spectator livestream pattern
  • Channel archiving, channel pinning (both are per-member fields with no client API)
  • Draft messages, message reminders and bookmarks, location sharing
  • User blocking (
    BlockUser
    / 
    UnblockUser
    / blocked-user list)
  • On-demand message translation (auto-translation on a channel does work)
  • Setting 
    invisible
    or a custom status at connect time (
    MarkInvisibleAsync
    after connect works)
  • Unread-mentions-per-channel count; pagination of reactions, watchers, and pinned messages via their dedicated endpoints
  • Client-level standalone file upload (channel-level 
    UploadFileAsync
    / 
    UploadImageAsync
    work)
  • Poll answers (text comments) and querying poll votes
Video - not implemented client-side as of 0.11.0:
  • Publishing your own screen share. You can receive a remote participant's 
    ScreenShareTrack
    ; there is no API to start sharing from Unity. The repo README's feature list says "Screensharing" and means the receive half.
  • Any incoming-call / ringing event. 
    call.ring
    is handled internally and never surfaced (the source literally reads 
    //StreamTodo: expose CallRinging event?
    ). 
    ring: true
    and 
    AcceptAsync
    / 
    RejectAsync
    exist, but the callee has no client-side signal that a call arrived - you need your own push handling.
  • Push device registration. 
    CreateDeviceAsync
    exists only on an 
    internal
    API and the low-level client is only reachable through an 
    internal
    interface. Register devices from your backend.
  • A public calling-state machine. 
    CallingState
    is internal; use 
    client.CallStarted
    / 
    CallLeaving
    / 
    CallEnded
    plus 
    client.ActiveCall
    .
  • Video-side chat integration, deeplinking, picture-in-picture, noise cancellation, transcription control, and HLS/RTMP viewer UI have no Unity docs page. 
    GoLiveAsync
    / 
    StopLiveAsync
    / 
    StartHLS
    / 
    StopHLS
    / 
    StartRecordingAsync
    / 
    StopRecordingAsync
    do ship on 
    IStreamCall
    - they are undocumented, not absent. Read the interface (rung 2 below) and say where you got it.
Anything server-side stays server-side for both SDKs: call types, channel types, permissions and roles, webhooks, push templates and providers, recording/transcription config, data retention, imports. The client never holds the API secret.
Chat——截至 v5.7.0，client 端尚未实现。 如果请求需要以下功能，请在编写代码之前说明：
  • Guest 和 anonymous user（不存在 
    ConnectGuestUser
    / anonymous connect）——这会阻断常见的只读 spectator livestream 模式
  • Channel archiving、channel pinning（两者都是 per-member field，没有 client API）
  • Draft message、message reminder 和 bookmark、location sharing
  • User blocking（
    BlockUser
    / 
    UnblockUser
    / blocked-user list）
  • 按需 message translation（channel 的 auto-translation 可以正常使用）
  • 在 connect 时设置 
    invisible
    或 custom status（connect 后调用 
    MarkInvisibleAsync
    可以实现）
  • 每个 channel 的 unread mention count；通过专用 endpoint 对 reactions、watchers 和 pinned messages 进行分页
  • Client 级独立 file upload（channel 级 
    UploadFileAsync
    / 
    UploadImageAsync
    可以使用）
  • Poll answer（文本评论）以及查询 poll vote
Video——截至 0.11.0，client 端尚未实现：
  • 发布自己的 screen share。 可以接收远程 participant 的 
    ScreenShareTrack
    ，但没有 API 可从 Unity 发起 screen share。仓库 README 的功能列表中写着“Screensharing”，指的是接收端能力。
  • 任何 incoming-call / ringing event。 
    call.ring
    在内部处理，永远不会对外暴露（源码中直接写着 
    //StreamTodo: expose CallRinging event?
    ）。
    ring: true
    和 
    AcceptAsync
    / 
    RejectAsync
    存在，但 callee 端没有 client-side signal 表明 call 已到达，需要自行实现 push handling。
  • Push device registration。 
    CreateDeviceAsync
    仅存在于 
    internal
    API 中，而底层 client 只能通过 
    internal
    interface 访问。应从后端注册 device。
  • 公开的 calling-state machine。
    CallingState
    是 internal；请使用 
    client.CallStarted
    / 
    CallLeaving
    / 
    CallEnded
    以及 
    client.ActiveCall
    。
  • Video-side chat integration、deeplinking、picture-in-picture、noise cancellation、transcription control 和 HLS/RTMP viewer UI 均没有 Unity 文档页面。
    GoLiveAsync
    / 
    StopLiveAsync
    / 
    StartHLS
    / 
    StopHLS
    / 
    StartRecordingAsync
    / 
    StopRecordingAsync
    确实由 
    IStreamCall
    提供——它们只是没有文档，并非不存在。请阅读 interface（下方第 2 级来源），并说明信息来源。
对于两个 SDK，任何 server-side 内容都应保留在 server side：call type、channel type、permission 和 role、webhook、push template 和 provider、recording/transcription config、data retention、import。client 永远不持有 API secret。

The docs convention - and the per-product coverage reality

文档约定——以及各产品的实际覆盖情况

Every Stream docs page has a Markdown twin: take the page URL, drop the trailing 
/
, add 
.md
.
https://getstream.io/chat/docs/unity/query-channels/   ->   https://getstream.io/chat/docs/unity/query-channels.md
https://getstream.io/video/docs/unity/basics/quickstart/ -> https://getstream.io/video/docs/unity/basics/quickstart.md
Always fetch the 
.md
variant - clean Markdown, verbatim code, no page chrome. Live indexes that list every page:
ProductLive index
Chat
https://getstream.io/cli/docs/chat-unity.md
Video
https://getstream.io/cli/docs/video-unity.md
The two trees fail in opposite directions, so the caveat is different per product.
每个 Stream 文档页面都有一个 Markdown twin：获取页面 URL，移除末尾的 
/
，然后添加 
.md
。
https://getstream.io/chat/docs/unity/query-channels/   ->   https://getstream.io/chat/docs/unity/query-channels.md
https://getstream.io/video/docs/unity/basics/quickstart/ -> https://getstream.io/video/docs/unity/basics/quickstart.md
始终获取 
.md
变体——内容是干净的 Markdown，代码保持原样，不包含页面框架。列出每个页面的实时索引：
产品实时索引
Chat
https://getstream.io/cli/docs/chat-unity.md
Video
https://getstream.io/cli/docs/video-unity.md
两棵文档树分别以不同方式存在问题，因此每个产品需要说明的注意事项也不同。

Chat: the code is real, but not every C# block is Unity C#

Chat：代码是真实的，但并非每个 C# block 都是 Unity C#

The Chat Unity tree is well maintained. Roughly 40 of its 53 pages carry a genuine Unity code tab, and where a feature is missing the page usually says so outright:
csharp
// This feature is not yet available in the Unity SDK.
The one trap is the fence label, and it is easy to miss because both say C#. These pages mix two different SDKs:
FenceWhich SDKUse it?
```csharp label="Unity"
The Unity client SDKYes. Copy verbatim.
```csharp label="C#"
The .NET server-side SDK (
using GetStream;
, 
new StreamClient(apiKey, apiSecret)
, 
chat.SendMessageAsync(...)
)		No. It needs the API secret and cannot run in a shipped game.
label="C#"
snippets are 
IStreamChannel
-shaped only by coincidence: 
chat.SendMessageAsync("channel-type", "channel-id", request)
looks close enough to 
channel.SendNewMessageAsync(request)
to paste by mistake, and then the fix is "add the API secret to the client", which is exactly wrong. Pages that are entirely server-side C# (
archiving-channels
, 
pinning-channels
, 
location-sharing
) document features the Unity SDK does not have at all - see Gate 3. Pages that are mixed (
send-message
, 
query-channels
, 
channel-members
, 
moderation
, 
message-delivery-and-read-status
) do have a Unity path; take the 
label="Unity"
block and ignore the rest.
message-delivery-and-read-status
is the sharpest case: read state is fully implemented (
channel.MarkChannelReadAsync
, 
channel.Read
, 
channel.MarkChannelAsUnreadAsync
, 
message.MarkMessageAsLastReadAsync
) and the page carries no Unity block at all. Get the API from the interface, not from the page's server-side C#.
Two more Chat-tree facts worth knowing before you fetch:
  • The CLI index is incomplete. 15 more paths resolve under 
    /chat/docs/unity/
    - but they 301-redirect to platform or Node docs (
    push-devices
    -> 
    /docs/platform/push-devices/
    , 
    chat-permission-policies
    -> 
    /chat/docs/node/...
    , 
    update-users
    -> 
    /docs/platform/users/
    ) and their 
    /chat/docs/unity/<page>.md
    twins 404. Fetch the 
    .md
    at the redirect target instead, and expect no Unity code there. 
    docs-map.md
     lists them with their real URLs.
  • The sample-project link in the docs is broken. The introduction page links 
    github.com/GetStream/stream-chat-unity/tree/main/...
    ; the repo has no 
    main
    branch    . Use 
    develop
    (or a version tag).
Chat Unity 文档树维护良好。其 53 个页面中约有 40 个包含真正的 Unity code tab；如果缺少某项功能，页面通常会直接说明：
csharp
// This feature is not yet available in the Unity SDK.
唯一的陷阱是 fence label，而且很容易忽略，因为两者都写着 C#。 以下页面混用了两个 SDK：
Fence对应 SDK是否使用？
```csharp label="Unity"
Unity client SDK是。 原样复制。
```csharp label="C#"
.NET server-side SDK（
using GetStream;
、
new StreamClient(apiKey, apiSecret)
、
chat.SendMessageAsync(...)
）		否。 它需要 API secret，无法在已发布的游戏中运行。
label="C#"
snippet 之所以看起来像 
IStreamChannel
，只是巧合：
chat.SendMessageAsync("channel-type", "channel-id", request)
与 
channel.SendNewMessageAsync(request)
很相似，容易被误粘贴；随后错误修复会变成“把 API secret 加到 client 中”，而这恰恰是错误的。完全属于 server-side 的 C# 页面（
archiving-channels
、
pinning-channels
、
location-sharing
）记录的功能在 Unity SDK 中根本不存在——见 Gate 3。混合页面的例子（
send-message
、
query-channels
、
channel-members
、
moderation
、
message-delivery-and-read-status
）确实包含 Unity 路径；请采用 
label="Unity"
block，并忽略其他内容。
message-delivery-and-read-status
是最值得注意的情况：read state 已完整实现（
channel.MarkChannelReadAsync
、
channel.Read
、
channel.MarkChannelAsUnreadAsync
、
message.MarkMessageAsLastReadAsync
），但该页面完全没有 Unity block。请从 interface 获取 API，而不是使用页面中的 server-side C#。
获取 Chat 文档树之前还需要了解两个事实：
  • CLI index 不完整。 
    /chat/docs/unity/
    下还有 15 个路径可以解析，但它们会 301 重定向到 platform 或 Node 文档（
    push-devices
    -> 
    /docs/platform/push-devices/
    ，
    chat-permission-policies
    -> 
    /chat/docs/node/...
    ，
    update-users
    -> 
    /docs/platform/users/
    ），相应的 
    /chat/docs/unity/<page>.md
    会返回 404。请改为获取重定向目标处的 
    .md
    ，并预期其中没有 Unity 代码。
    docs-map.md
     列出了这些页面及其真实 URL。
  • 文档中的 sample-project link 已失效。 Introduction page 链接到 
    github.com/GetStream/stream-chat-unity/tree/main/...
    ，但仓库没有 
    main
    分支。请改用 
    develop
    或某个 version tag。

Video: the code is trustworthy, the tree is just small

Video：代码可信，但文档树很小

All 22 Video Unity pages are Unity-first C# - there is no server-SDK mixing and no JavaScript. The problem is absence: no page covers going live, backstage, HLS, RTMP, recording control, ringing flows, or screen-share receive, even though most of those ship on 
IStreamCall
. When a Video request has no page, that is normal - go to rung 2 and read the interface.
Video Unity 的全部 22 个页面都以 Unity-first C# 为主——不存在 server SDK 代码混用，也不存在 JavaScript。问题在于缺失：没有页面介绍 going live、backstage、HLS、RTMP、recording control、ringing flow 或 screen-share receive，尽管其中大多数功能都已在 
IStreamCall
中提供。当 Video 请求没有对应页面时，这属于正常情况——请转到第 2 级来源并阅读 interface。

Source-of-truth ladder

Source-of-truth ladder

Walk it in order. Stop at the first rung that answers the question, and cite which rung you used.
RungSourceUse for
1The page's 
label="Unity"
block (Chat) or the page's C# (Video) - 
docs-map.md
 says which pages have one		Anything covered. Copy verbatim.
2SDK source in the project - 
Assets/.../StreamChat/Core/**
and 
Library/PackageCache/io.getstream.video*/Runtime/Core/**
, else 
raw.githubusercontent.com/GetStream/<repo>/<tag>/...
Exact signatures, defaults, nullability, what is 
public
vs 
internal
. The final authority.
3Shipped docs code samples - Chat: 
Assets/Plugins/StreamChat/Samples/*.cs
; Video: 
Packages/StreamVideo/DocsCodeSamples/**
Compiling versions of the snippets behind the docs pages. Often clearer than the page.
4Sample projects - Chat: 
Assets/Plugins/StreamChat/SampleProject/
; Video: 
Packages/StreamVideo/Samples~/VideoChat/
Real end-to-end wiring, including message-list pooling and participant-view spawning.
5Changelogs - Chat: 
Assets/Plugins/StreamChat/Changelog.txt
; Video: 
CHANGELOG.md
Behaviour and config that never reached the docs (see 
RULES.md
). Richer than the release notes.
Read from the version the project actually vendors - Chat is copied into 
Assets/
, Video is resolved into 
Library/PackageCache/
, so both are already on disk. Prefer them over GitHub 
develop
/
main
.
URL grounding: only fetch a page URL you got from 
docs-map.md
 or from a live index fetch in this conversation. Do not invent doc paths from memory.
按顺序检查。在第一个能够回答问题的层级停止，并说明使用了哪一级来源。
级别来源用途
1页面中的 
label="Unity"
block（Chat）或页面中的 C#（Video）——
docs-map.md
 标明哪些页面包含对应代码		所有已覆盖的功能。原样复制。
2项目中的 SDK source——
Assets/.../StreamChat/Core/**
和 
Library/PackageCache/io.getstream.video*/Runtime/Core/**
，否则使用 
raw.githubusercontent.com/GetStream/<repo>/<tag>/...
精确 signature、默认值、nullability，以及哪些成员是 
public
、哪些是 
internal
。最终权威来源。
3随包发布的文档代码示例——Chat：
Assets/Plugins/StreamChat/Samples/*.cs
；Video：
Packages/StreamVideo/DocsCodeSamples/**
文档页面背后可编译版本的 snippet。通常比页面本身更清晰。
4Sample project——Chat：
Assets/Plugins/StreamChat/SampleProject/
；Video：
Packages/StreamVideo/Samples~/VideoChat/
真实的端到端接线，包括 message-list pooling 和 participant-view spawning。
5Changelog——Chat：
Assets/Plugins/StreamChat/Changelog.txt
；Video：
CHANGELOG.md
从未进入文档的行为和配置（见 
RULES.md
）。通常比 release notes 更丰富。
应读取项目实际使用的版本——Chat 被复制到 
Assets/
中，Video 被解析到 
Library/PackageCache/
中，因此两者都已经位于本地磁盘。优先使用它们，而不是 GitHub 上的 
develop
/
main
。
URL grounding： 只获取来自 
docs-map.md
 或本次对话中实时索引的页面 URL。不要凭记忆虚构文档路径。

Step 1: Classify the request

Step 1：对请求进行分类

With the gates passed, pick the mode:
  • How-to / reference ("how do I query channels?", "what does 
    SetIncomingVideoEnabled
    do?") -> go straight to Docs lookup. No setup, no credentials.
  • Integrate ("add chat to my game", "put a video call in this project") -> run 
    setup.md
    , then Docs lookup per feature.
  • New project ("build me a Unity chat app") -> 
    setup.md
     then Docs lookup, scoped to the requested screens. If there is no Unity project (no 
    ProjectSettings/ProjectVersion.txt
    ), tell the user to create it in Unity Hub first - do not try to synthesize a Unity project tree by hand.
  • UI work ("show a channel list", "render the participants", "style the message bubbles", "add call controls") -> run 
    ui.md
    . Neither SDK ships components, so this is code you write; the runbook carries the prefab/pooling patterns, the track-binding contract, and the self-preview path that has no track.
  • Build / ship / run on device ("build for Android", "why is there no video on my phone?", "IL2CPP build crashes", "package for iOS") -> run 
    platforms.md
    . The player settings there are load-bearing, not polish: without them an Android Video build has no working WebRTC, an iOS build never gets camera permission, and an IL2CPP build can strip the SDK's serialization types.
  • Upgrade / migrate a version ("bump Chat to 5.7", "we're on 4.x") -> Chat 4.x -> 5.x is the enum-to-struct migration; read 
    migration-guide-to-5x.md
    from 
    docs-map.md
    . For Video, there is no migration guide - read 
    CHANGELOG.md
    between the two versions and say plainly that a pre-1.0 SDK can break API between minors.
通过三个 gate 后，选择模式：
  • How-to / reference（“如何查询 channel？”、
    SetIncomingVideoEnabled
    的作用是什么？）-> 直接进入 Docs lookup。无需 setup，也不需要 credentials。
  • Integrate（“为我的游戏添加 chat”、“在这个项目中加入 video call”）-> 运行 
    setup.md
    ，然后针对每项功能执行 Docs lookup。
  • New project（“为我构建一个 Unity chat app”）-> 先运行 
    setup.md
    ，再执行 Docs lookup，并限定在用户请求的界面范围内。如果不存在 Unity project（没有 
    ProjectSettings/ProjectVersion.txt
    ），请告诉用户先在 Unity Hub 中创建项目——不要尝试手工合成 Unity project tree。
  • UI work（“显示 channel list”、“渲染 participant”、“设置 message bubble 样式”、“添加 call control”）-> 运行 
    ui.md
    。两个 SDK 都不提供 component，因此需要自行编写代码；runbook 中包含 prefab/pooling 模式、track-binding contract，以及没有 track 的 self-preview path。
  • Build / ship / run on device（“构建 Android 版本”、“为什么手机上没有 video”、“IL2CPP 构建崩溃”、“打包 iOS”）-> 运行 
    platforms.md
    。其中的 player settings 至关重要，并非锦上添花：缺少这些设置，Android Video build 将无法使用 WebRTC，iOS build 永远无法获得 camera permission，IL2CPP build 还可能 strip SDK 的 serialization type。
  • Upgrade / migrate version（“将 Chat 升级到 5.7”、“我们还在 4.x”）-> Chat 4.x -> 5.x 是 enum-to-struct migration；从 
    docs-map.md
     读取 
    migration-guide-to-5x.md
    。Video 没有 migration guide——请对比两个版本之间的 
    CHANGELOG.md
    ，并明确说明 pre-1.0 SDK 的 API 可能在 minor version 之间发生破坏性变化。

Step 2: Docs lookup (every request ends here)

Step 2：Docs lookup（每个请求最终都执行此步骤）

  1. Open 
    docs-map.md
    . Find the row for the feature; it gives the exact 
    .md
    URL and what kind of code that page carries.
  2. If the feature is not in the map, fetch the live index for the product and pick from it.
  3. Fetch the 
    .md
    page(s)     with WebFetch. At most 3 per request; beyond that, hand the user the index URL.
  4. Use the Unity code verbatim, adapting only to the project's 
    MonoBehaviour
    and scene shape. If the page has no Unity block, drop to rung 2 and read the interface.
  5. Cite what you used: 
    Source: [Title](https://getstream.io/...)
    , or 
    Source: Assets/Plugins/StreamChat/Core/StatefulModels/IStreamChannel.cs
    for a source read. Never answer SDK specifics from training data - if you did not read it this conversation, read it now or say you could not find it.
  6. Apply best practices - one 
    QueryChannelsAsync
    then let the WebSocket keep state fresh; subscribe video only for participants actually on screen; connect once. See 
    RULES.md
     "Mindful API usage".
  1. 打开 
    docs-map.md
    。找到对应功能的行；其中会给出准确的 
    .md
    URL，以及该页面包含哪类代码。
  2. 如果 map 中没有该功能，获取对应产品的实时 index，并从中选择页面。
  3. 使用 WebFetch 获取 
    .md
    页面。每次请求最多获取 3 个；超过 3 个时，将 index URL 交给用户。
  4. 原样使用 Unity 代码，仅根据项目的 
    MonoBehaviour
    和 scene structure 进行调整。如果页面没有 Unity block，则降到第 2 级来源并阅读 interface。
  5. 说明使用过的来源： 
    Source: [Title](https://getstream.io/...)
    ，或 
    Source: Assets/Plugins/StreamChat/Core/StatefulModels/IStreamChannel.cs
    。不要根据训练数据回答 SDK 细节——如果本次对话中没有读取过相关内容，请立即读取，或者说明无法找到。
  6. 应用最佳实践——执行一次 
    QueryChannelsAsync
    ，随后让 WebSocket 保持状态更新；仅为屏幕上实际显示的 participant 订阅 video；只 connect 一次。见 
    RULES.md
     中的“Mindful API usage”。

What this skill carries

此 skill 包含的内容

The official docs cover the low-level clients well where they have Unity code, so this skill does not restate them. The curated, non-doc content is:
FileWhat it is
RULES.md
Non-negotiable rules + the Unity pitfalls that fail silently. Every rule is stated once, here.
setup.md
Version-pinned install for both SDKs (
.unitypackage
and UPM manifest), CLI credentials, and the verified minimal client wiring with correct lifecycle.
ui.md
Building the UI yourself - there are no components. Chat lists and composer on UGUI, participant views, the track-binding contract, self-preview, and subscription management.
platforms.md
Per-target player settings, IL2CPP and managed stripping, the Newtonsoft conflict, WebGL, Android/iOS/desktop, and what push does and does not do.
docs-map.md
Intent -> exact docs page for both products, annotated with what kind of code each page carries, plus the source fallback.
官方文档在包含 Unity 代码的部分很好地覆盖了底层 client，因此此 skill 不会重复这些内容。其整理的非文档内容包括：
文件内容
RULES.md
不可违反的规则，以及会静默失败的 Unity 陷阱。每条规则仅在此处陈述一次。
setup.md
两个 SDK 的版本固定安装方式（
.unitypackage
和 UPM manifest）、CLI credentials，以及经过验证且生命周期正确的最小 client 接线。
ui.md
自行构建 UI——不提供任何 component。包含基于 UGUI 的 Chat list 和 composer、participant view、track-binding contract、self-preview 和 subscription management。
platforms.md
各目标平台的 player settings、IL2CPP 和 managed stripping、Newtonsoft 冲突、WebGL、Android/iOS/desktop，以及 push 实际支持和不支持的能力。
docs-map.md
从用户意图映射到两个产品的准确文档页面，并标注每个页面包含哪类代码，同时提供 source fallback。

Support

支持

If the user asks for support or how to contact someone, direct them to getstream.io/contact. SDK gaps and feature requests go to the repo issues: Chat, Video.
如果用户询问支持方式或如何联系相关人员，请引导其访问 getstream.io/contact。SDK 功能缺口和功能请求请提交到仓库 issue：Chat、Video。