nimeet 文档中心
English

SDK 平台总览与能力矩阵

14 端 SDK 的接口规模、支持情况、跨端能力对照、Token 提供链与迁移建议。

Generated from the public API definitions

版本 v1.1.0 · 更新于 2026-10-26 · 修订 1

ni-meet 客户端 SDK 覆盖 16 个平台,所有平台共用一套产品语义和与声网 4.x 对齐的 API。API 参考中的类名、方法、参数、重载、事件与错误码由公开接口定义在构建时生成,文档与 SDK 包保持一致。

怎么选端

  1. 按你的技术栈选择平台,接口规模与可用性见下方「平台与接口规模」。
  2. 点平台名进入「快速开始与功能指南」,那里有前置条件、安装命令、获取 Token、入会链路、事件、错误处理与排障。
  3. 需要精确签名时进入同端「API 参考」,那是完整的方法、重载、属性、事件与枚举。

一致的接入模型

所有端遵循相同的接入模型:

  • 统一 API:类名、方法名、事件与错误码在各端保持一致,跨端迁移成本低。
  • 语义一致:连接状态机、事件顺序、重连退避、Token 续期、统计口径、错误映射、设备枚举、角色切换与数据通道语义。
  • 明确失败:当前版本不支持的能力返回明确错误码,不会返回假成功。
  • API 与媒体实现解耦:业务代码只依赖公开 API,不依赖底层媒体引擎。

Token 提供链(各端一致)

所有端都接受同三种 Token 来源,可组合成回退链:

形态用法适用场景
endpoint调你的后端(最终落到 POST /v1/tokens)大多数应用
callback委托给宿主应用 / IM 的 getRTCTokenInfo已有 IM 体系的场景
static预签发 Token测试、离线 Demo

永远不要把 customerSecret / appCertificate 打进客户端包:客户端只拿 { appId, rtcToken, rtcUid }。语义细节见 AccessToken2 语义。

公共语义清单

不管哪一端,下面这些语义保持一致:

  • 事件顺序:connection-state-change → user-joined → user-published → user-unpublished → user-left;
  • 断线:CONNECTION_STATE.RECONNECTING 期间不断流、不销毁轨道;-112 才需要重新入会;
  • 静音用 setEnabled(false),不是 setMuted;
  • 角色切换:setClientRole('audience') 会自动停止本地发布;
  • 统计:getRTCStats() 的字段口径与 水晶球指标 一致。

能力边界

  • 内容审核(Content Inspect)、E2EE、频道媒体中继、客户端直推 CDN 当前版本暂不提供;相关方法调用返回错误码 -4(ERR_NOT_SUPPORTED)。
  • 各端运行时能力以实际发布的 SDK 包为准;API 参考中的接口定义不代表该端运行时已全部可用。
  • Cocos Creator:提供接口定义与绑定说明;运行时能力以实际发布的 SDK 包为准。

平台与接口规模

接口规模在构建时从公开接口定义统计,供选型参考。可用性以实际发布的 SDK 包为准。

平台语言接口版本接口/类方法重载枚举错误码可用性参考
Web(浏览器)TypeScript4.24.963157168096✅ 正式可用API 参考
Electron(桌面)TypeScript4.6.213757857814648✅ 正式可用API 参考
AndroidKotlin4.7.0143654709526✅ 正式可用API 参考
iOSSwift / Objective-C4.7.013264964915170✅ 正式可用API 参考
macOSSwift / Objective-C4.7.012161261214470✅ 正式可用API 参考
Windows(C++)C++4.7.014968871915849✅ 正式可用API 参考
FlutterDart6.6.415061861815048✅ 正式可用API 参考
React NativeTypeScript / Java / Objective-C4.6.414157757714848✅ 正式可用API 参考
Unity(C#)C#4.6.214058861714848✅ 正式可用API 参考
Unreal Engine(C++)C++4.5.114060362914546✅ 正式可用API 参考
Unreal Engine(Blueprint)Blueprint / C++4.5.1904584581036✅ 正式可用API 参考
Cocos CreatorTypeScript4.5.32636354✅ 正式可用API 参考
小程序(微信)TypeScript2.6.54324540✅ 正式可用API 参考
Cocos2d-x(C++ 绑定)C++4.7.02434800✅ 正式可用API 参考
C#(.NET)C#unknown12151952514446✅ 正式可用API 参考
HarmonyOS(ArkTS)ArkTS4.6.3883173178640✅ 正式可用API 参考

合计 1623 个接口/类、7156 个方法 (7332 个重载)、1584 个枚举。

下一步

  • 选好端:进该端「快速开始与功能指南」,里面有前置条件、安装、Token、入会、事件与排障。
  • 看接口:同端「API 参考」列出全部方法重载、属性、事件与枚举。
  • 排障:连接、鉴权与媒体失败的错误码见 错误码,常见问题见 FAQ。

本页由文档构建流水线生成 · 2026-10-31 01:24:02 UTC · 文档中心 v1.1.0.

内容依据公开 API 定义.

ni-meet 是自建 RTC PaaS,媒体面基于 LiveKit(Apache-2.0),并与声网 API 兼容。