@formant/realtime-sdk

中文文档
1.381.8发布于 2026/11/12MITTypeScriptCommonJS近 30 天下载 7186

A library for accessing realtime connections your Formant devices/fleet.

原始使用文档
文档目录7 节
  1. Get Started
  2. License
  3. Changelog
  4. 1.3.0 - 2024-09-09
  5. 1.2.0 - 2023-08-18
  6. 1.1.0 - 2023-08-18
  7. 1.0.0 - 2023-07-19

Formant Realtime SDK

A library for accessing realtime connections your Formant devices/fleet.

Get Started

$ npm install --save @formant/realtime-sdk@latest

# or with

$ yarn add @formant/realtime-sdk@latest

License

Distributed under the MIT License. See LICENSE.txt for more information.

Changelog

1.3.0 - 2024-09-09

Fixed

  • Redact sensitive ICE credentials.

1.2.0 - 2023-08-18

Added

  • Exporting IRtcPeer and RtcStreamType.

1.1.0 - 2023-08-18

Fixed

  • Fixed debug logging level output.

1.0.0 - 2023-07-19

Added

  • Odometry over teleop
  • Add support for eventing on all event trigger types

Changed

  • Reduce ICE gathering timeout to 3s

Fixed

  • Workaround for lack of getConfiguration method on RTCPeerConnection
  • Project de-cycling
  • Fix Odom
  • Use previously implemented util for detecting STUN vs TURN
  • Partition connections in a single step…
  • Immediately eject a disconnected connection from the connection set
  • More cleanup on rtcClient shutdown
  • Record RTC connection type metric (host, relay, etc)
  • Make best-effort to release the RtcPeerConnection on close
  • isConnectionInitiator never gets cleared, keeping RtcConnections alive
  • Add prettier plugin to deterministically sort import ordering
  • Dependency updates
  • Resolve realtime-sdk build warnings about re-exporting types

版本与发布记录

@formant/realtime-sdk 共发布 217 个版本,首次发布于 2021/07/08;过去 12 个月发布了 182 个版本。

版本发布日期距今
1.381.8latest2026/11/123 天前
1.381.72026/11/096 天前
1.381.62026/11/069 天前
1.381.52026/11/069 天前
1.381.42026/11/069 天前
1.381.32026/11/0510 天前

其他发布通道:next → 1.0.0。

关于 @formant/realtime-sdk 的常见问题

@formant/realtime-sdk 是什么?

A library for accessing realtime connections your Formant devices/fleet.

如何安装 @formant/realtime-sdk?

在项目目录运行 npm install @formant/realtime-sdk,或使用 pnpm add / yarn add / bun add。

@formant/realtime-sdk 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@formant/realtime-sdk 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@formant/realtime-sdk 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js ^24.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@formant/realtime-sdk 可以商用吗?

@formant/realtime-sdk 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@formant/realtime-sdk 的下载量有多少?

根据 npm 官方下载统计,@formant/realtime-sdk 在 2026/10/16 – 2026/11/14 这 30 天内被下载 7,186 次,日均约 240 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@formant/realtime-sdk 还在维护吗?

最新版本 1.381.8 发布于 2026/11/12(3 天前);至今共发布 217 个版本,其中过去 12 个月发布了 182 个;首次发布于 2021/07/08。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。