# @flashphoner/websdk 中文文档

规范地址：https://npmcn.com/package/%40flashphoner/websdk/

版本：2\.0\.283
npm 元数据更新时间：2026-05-29T09:02:45.613Z
中文译文更新时间：2026-11-14T21:41:38.561Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40flashphoner/websdk
原文对照：https://npmcn.com/package/%40flashphoner/websdk/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：45 MB，628 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：8 个
- 首次发布：2021-02-09T05:40:14.879Z
- 最新版本发布：2026-05-29T09:02:45.499Z
- 近 30 天下载量：3574（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：95（近 12 个月 9 个）

## 中文简介

官方闪存手机 WebCallServer WebSDK软件包

## 安装

```sh
npm install @flashphoner/websdk
```

也可以使用：`pnpm add @flashphoner/websdk`、`yarn add @flashphoner/websdk`、`bun add @flashphoner/websdk`

## README

# @flashphoner/websdk (英语)

# 闪存电话机 WebCallServer JavaScript API (Web SDK)

闪光机 [网络呼叫服务器](https://flashphoner.com/) JavaScript API (Web SDK) 执行.

## 安装

npm 安装 @ flashphoner/ websdk

## 在浏览器中使用预建 Javascript 捆绑

双向流转. html:

```HTML
<!DOCTYPE html>
<html lang="en">
<head> 
    <script type="text/javascript" src="node_modules/@flashphoner/websdk/flashphoner.js"></script> 
    <script type="text/javascript" src="two-way-streaming.js"></script> 
</head>
<body onload="init_api()">
    <div id="publish" style="width:320px;height:240px;border: solid 1px"></div>
    <br/><button id="publishBtn">Publish</button><br/>
    <br/>
    <div id="play" style="width:320px;height:240px;border: solid 1px"></div>
    <br/><button id="playBtn">Play</button><br/>
    <br/>
    <br/><button id="stopBtn">Stop</button><br/>
</body>
</html>
```

双向流式. js:

```Javascript
//Constants
var SESSION_STATUS = Flashphoner.constants.SESSION_STATUS;
var STREAM_STATUS = Flashphoner.constants.STREAM_STATUS;
var session;
var stream;
  
//Init Flashphoner API on page load
function init_api() {
    Flashphoner.init({});
    publishBtn.onclick = connect;
    playBtn.onclick = playStream;
    stopBtn.onclick = stopPublish;
}
  
//Connect to WCS server over websockets
function connect() {
    session = Flashphoner.createSession({
        urlServer: "wss://demo.flashphoner.com"
    }).on(SESSION_STATUS.ESTABLISHED, function(session) {
        publishStream(session);
    });
}
  
//Publish stream
function publishStream(session) {
    stream = session.createStream({
        name: "stream",
        display: document.getElementById("publish"),
    });
    stream.publish();
}
  
//Playing stream
function playStream() {
    session.createStream({
        name: "stream",
        display: document.getElementById("play"),
    }).play();
}
 
//Stopping stream
function stopPublish() {
    stream.stop();
}
```

## 更多实例

请查找更多关于 [GitHub 图像](https://github.com/flashphoner/flashphoner_client/tree/wcs_api-2.0/examples) 继续 [此页面](https://flashphoner.com/)

## 文档

请读详细信息 [这里](https://docs.flashphoner.com/display/WEBSDK2EN/Web+SDK+2.0+-+EN) 和 API 文档 [这里](http://flashphoner.com/docs/api/WCS5/client/web-sdk/latest)

## 已知问题

WebSDK 正在以 [webrtc/调整器](https://github.com/webrtc/adapter/) 库版本不低于7.2.6. 在这方面,应避免直接使用这个图书馆和WebSDK.

## 常见问题

### @flashphoner/websdk 是什么？

官方闪存手机 WebCallServer WebSDK软件包

### 如何安装 @flashphoner/websdk？

在项目目录运行 npm install @flashphoner/websdk，或使用 pnpm add / yarn add / bun add。

### @flashphoner/websdk 支持 TypeScript 吗？

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

### @flashphoner/websdk 支持 ESM 还是 CommonJS？

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

### @flashphoner/websdk 可以商用吗？

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

### @flashphoner/websdk 的下载量有多少？

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

### @flashphoner/websdk 还在维护吗？

最新版本 2\.0\.283 发布于 2026/05/29（5 个月前）；至今共发布 95 个版本，其中过去 12 个月发布了 9 个；首次发布于 2021/02/09。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。