@lingoace/lingo-base-rtc v0.0.10

lingo-base-rtc

lingo 对外曝露的rtc服务接口定义，第三方可以使用 npm 引入此包作为依赖并实现此包中定义的 interface 后，即可集成到 lingo 的电子教室中提供音视频服务。

npm install @lingoace/lingo-base-rtc

第三方插件开发说明

1. 创建一个新的 npm 工程
2. 使用 npm 引入 @lingoace/lingo-base-rtc
3. 实现下方表格中列出的接口，并且对外曝露实现的 LingoRTC 类，例如：

import { LingoBaseRTC, ILingoRTC } from "@lingoace/lingo-base-rtc";
export class LingoRTC extends LingoBaseRTC implements ILingoRTC {
  //...
}

4. 插件方自行测试
5. 提供打包后的 npm 包给 lingo 集成到业务端进行测试
6. lingo 电子教室发布带有插件方音视频服务sdk的版本上线

最终完成的sdk插件建议上传到 npm 的 @lingoace 组织下，npm包命名规范：

@lingoace/lingo-{插件方标识}-rtc

异常处理

插件方的API实现中，异常需要统一抛出 LingoRTCError （lingo-base-rtc包里已包含此类的定义，用法如下：）

// 无音视频权限
throw new LingoRTCError(LingoRTCErrorCode.PermissionDenied, '异常信息');
// 设备不存在
throw new LingoRTCError(LingoRTCErrorCode.DeviceNotFound, '异常信息');
// 设备不可用
throw new LingoRTCError(LingoRTCErrorCode.NotReadable, '异常信息');
// 其他异常（LingoRTCErrorCode 枚举没有定义的暂时都抛此异常，目前业务侧会针对已定义的code做处理，未定义的暂未处理）
throw new LingoRTCError(LingoRTCErrorCode.Other, '异常信息');

目录说明

src/commom 目录下是公共代码，一些简单的方法已直接实现，插件方继承此目录下对应的类后可以少写部分代码，当然也可以在自己的实现类中重写方法实现，但是必须要使用 extends 继承对应的类，方便我方后续有简单需求可以直接增加方法而无需请插件方修改插件sdk

src/types 目录下是用到的所有的 TypeScript 类型定义

插件实现方需要实现以下接口

Lingo类(接口)关系图

自采集

自采集的核心是依赖摄像头采集的画面进行二次加工

执行步骤说明

1. 创建摄像头采集（LingoRTC.createCameraVideoTrack）
2. 创建自采集（LingoRTC.createCustomVideoTrack）并 init
3. 调用customVideoTrack.play （play 其实就是创建了一个时钟绘制，定时将摄像头采集的画面绘制到一个 canvas 上，然后调用 play 方法传递的参数中的 onDraw 回调函数，交给业务侧进行canvas画面二次加工）
4. 推送customVideoTrack视频流（LingoRTCClient.publish）

事件

lingo-base-rtc包中的interface LingoRTCEvent 定义了插件方需要抛出的事件，事件参数请看TypeScript的类型定义说明

// 抛出事件实例
LingoRTCClient.emit('UserJoined', 'uid');