说明

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

对国家预防机制的使用

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

npm install @digitalsamba/embedded-sdk

或者说

yarn install @digitalsamba/embedded-sdk

国家预防机制 软件包链接

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

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

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

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

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

初始化

安全环境

由于嵌入式应用程序依赖于媒体设备能力,它需要在一个 安全环境 (单位:千美元)https:// 对 http://) (中文(简体) ).

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

配置 SDK 实例

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

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

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

// 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 - 布尔,假的默认。 是否向控制台报告配置错误或运行时间错误

使用量

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

额外功能如房间 权限管理 财务报告和审定财务报表 曝光状态 还提供.

活动

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

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

见 事件文件 详细列出现有活动.

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

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'
      }
    },
  */
});

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

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

图标

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

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

QQ 包含使用示例的现有命令的全部列表可见于 文档网站。 。 。 .

实例

有多个演示, 有实例集成

• 简易视频室 - 展示基本整合、倾听事件和运行命令的简单演示
• 初始设置 - 在装入帧前设置默认设置的例子
• 管理状态演示 - 说明如何在复杂的情景中使用暴露状态,倾听事件,检查权限并访问所储存的数据.