# @digitalsamba/embedded-sdk 中文文档

规范地址：https://npmcn.com/package/%40digitalsamba/embedded-sdk/

版本：0\.0\.58
npm 元数据更新时间：2026-10-09T21:28:46.379Z
中文译文更新时间：2026-11-12T09:07:52.719Z
软件包许可：BSD-2-Clause

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

原始 npm 页面：https://www.npmjs.com/package/%40digitalsamba/embedded-sdk
原文对照：https://npmcn.com/package/%40digitalsamba/embedded-sdk/?lang=original
项目主页：https://github.com/digitalsamba/embedded-sdk#readme
源码仓库：https://github.com/digitalsamba/embedded-sdk

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

- 包体积（解压后）：364 kB，61 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2022-10-27T14:24:17.429Z
- 最新版本发布：2026-10-09T21:28:45.945Z
- 近 30 天下载量：15915（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：50（近 12 个月 6 个）

## 中文简介

Digital Samba Ended SDK - 与JS轻松控制您的iframe集成.

## 安装

```sh
npm install @digitalsamba/embedded-sdk
```

也可以使用：`pnpm add @digitalsamba/embedded-sdk`、`yarn add @digitalsamba/embedded-sdk`、`bun add @digitalsamba/embedded-sdk`

## README

# 说明

Digital Samba Ended SDK - 与JS轻松控制您的iframe集成.

## 对国家预防机制的使用

使用您首选的软件包管理器将其添加到依赖列表 :

`npm install @digitalsamba/embedded-sdk`

或者说

`yarn install @digitalsamba/embedded-sdk`

[国家预防机制 软件包链接](https://www.npmjs.com/package/@digitalsamba/embedded-sdk)

安装后,请在应用程序代码中使用已提供的导入:

```js
const DigitalSambaEmbedded = require('@digitalsamba/embedded-sdk');

// or, using imports
import DigitalSambaEmbedded from '@digitalsamba/embedded-sdk';
```

这个软件包是用 TypeScript 写的,所以类型定义也可用:

```ts
import { SendMessageType, ReceiveMessageType /* ...etc */ } from '@digitalsamba/embedded-sdk';
```

## 初始化

* * *

### 安全环境

由于嵌入式应用程序依赖于媒体设备能力,它需要在一个 [安全环境](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts) (单位:千美元)`https://` 对 `http://`) (中文(简体) ).

对于本地开发,大多数浏览器处理 `http://localhost` 财务报告和审定财务报表 `http://127.0.0.1` 安全无虞.

* * *

### 配置 SDK 实例

库提供替代初始化样式. 使用类构造器可以配置并装入框架 在一个电话中:

```js
const api = new DigitalSambaEmbedded(InitOptions, InstanceProperties /* optional */);
```

或者您可以预先配置实例,然后按需加载:

```js
// notice `createControl` vs constructor call
const api = DigitalSambaEmbedded.createControl(InitOptions);

// ...
// when necessary, load the frame:
api.load(InstanceProperties /* optional */);
```

### 输入选项

`InitOptions` 拥有以下领域:

-   `root` - HTML Element(英语:HTML Element). 如果指定,将在其中创建目标框架.
-   `frame` - HTMLIFrameElement 要包装.
-   `url` - 完整 URL 应用为帧 src 。 必须包括协议和 `token` 私人房间查询参数;
-   `team` - 团队名称字符串
-   `room` - 房间标识字符串
-   `token` - 认证的可选字符串,主要用于私人房间

要成功初始化一个下列组合的包装实例:

-   `root + team + room` - 将在内部创建一个可控框架 `root` 元素
-   `frame + team + room` - 将附在现有框架上
-   `frame` - 将附加在现有框架上(假设您手动指定了正确的框架 src)
-   `root + url` - 里面会建立一个框架 `root` 元素

记住永远要说明 `allow="camera; microphone; display-capture; autoplay;"` 财务报告和审定财务报表 `allowFullscreen="true"` 属性.

### 实例

-   `frameAttributes` - 适用于目标iframe的属性清单
-   `reportErrors` - 布尔,假的默认。 是否向控制台报告配置错误或运行时间错误

## 使用量

初始化后,您可以监听由嵌入式应用程序释放出的事件,并通过发送命令来控制它.

额外功能如房间 [权限管理](https://docs.digitalsamba.com/reference/sdk/properties/permissionmanager) 财务报告和审定财务报表 [曝光状态](https://docs.digitalsamba.com/reference/sdk/properties/roomstate) 还提供.

### 活动

任何支持的活动的随附听者

```js
api.on('userJoined', (data) => {
  // ...
});
```

* * *

见 [事件文件](https://docs.digitalsamba.com/reference/sdk/events) 详细列出现有活动.

* * *

出错事件可以提供有用的细节 :

```js
api.on('appError', (error) => {
  console.log(error);

  /* outputs  {
      name: 'not-allowed',
      message:
        'Recording disabled. You’ll need to edit this room’s properties to record sessions in this room',
      data: {
        type: 'recording'
      }
    },
  */
});
```

为调试目的,您也可以同时收听所有事件

```js
api.on('*', (data) => {
  console.log(data);
});
```

### 图标

要发送命令, api 实例提供方便工具 :

```js
api.toggleVideo();
// ...
api.disableAudio();
```

* * *

QQ 包含使用示例的现有命令的全部列表可见于 [文档网站](https://docs.digitalsamba.com/reference/sdk/methods)。 。 。 .

### 实例

有多个演示, 有实例集成

-   [简易视频室](https://digitalsamba.github.io/embedded-sdk/dist/demo/videoroom.html) - 展示基本整合、倾听事件和运行命令的简单演示
-   [初始设置](https://digitalsamba.github.io/embedded-sdk/dist/demo/initial-config.html) - 在装入帧前设置默认设置的例子
-   [管理状态演示](https://digitalsamba.github.io/embedded-sdk/dist/demo/managed-state.html) - 说明如何在复杂的情景中使用暴露状态,倾听事件,检查权限并访问所储存的数据.

## 常见问题

### @digitalsamba/embedded-sdk 是什么？

Digital Samba Ended SDK - 与JS轻松控制您的iframe集成\.

### 如何安装 @digitalsamba/embedded-sdk？

在项目目录运行 npm install @digitalsamba/embedded-sdk，或使用 pnpm add / yarn add / bun add。

### @digitalsamba/embedded-sdk 支持 TypeScript 吗？

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

### @digitalsamba/embedded-sdk 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @digitalsamba/embedded-sdk 可以商用吗？

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

### @digitalsamba/embedded-sdk 的下载量有多少？

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

### @digitalsamba/embedded-sdk 还在维护吗？

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