# rc-rtc-tools

> rc rtc tools

Latest version **0.0.2** (published 2022-09-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install rc-rtc-tools
pnpm add rc-rtc-tools
yarn add rc-rtc-tools
bun add rc-rtc-tools
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2022-09-23 |
| First published | 2022-09-22 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 8.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | jehan |
| Maintainers | gzh123 |

## Links

- npm: https://www.npmjs.com/package/rc-rtc-tools
- npm.io page: https://npm.io/package/rc-rtc-tools

## Dependencies (1)

- [jquery](https://npm.io/package/jquery.md) ^3.6.1

## Recent versions

- 0.0.2 (latest) — 2022-09-23
- 0.0.1-alpha.2 — 2022-09-22
- 0.0.1 — 2022-09-22

## README

## RCRTCTools 

### [CHANGELOG](./CHANGELOG.md)


@rongcloud/plugin-rtc 辅助工具，可以查看 peerConnection 相关信息。


### Install 

```bash
npm install rc-rtc-tools@latest -D 
```

### Usage

1. 引入 rc-rtc-tools
```js
import RCRTCTools from 'rc-rtc-tools'
```
   
2. 创建 rtcTools 实例。创建完 RCRTCTools 实例之后，会自动创建一个可拖拽的工具图标,此时还没有任何 peerConnection 数据。

```js
  const rtcTools = new RCRTCTools()
```

3. 加入房间成功之后，调用 **[room.registerReportListener](https://doc.rongcloud.cn/meeting/Web/5.X/guide/advanced/analysis/web)** 注册房间质量数据监听器。
   
   
 （注：如果已经注册过了质量数据监听器无需重复注册，否则后注册的监听事件会覆盖之前注册的监听事件）


4. 在 onStateReport 监听器中调用 rtcTools.updateView(reports) 更新视图。



代码示例：

```js
  import RCRTCTools from 'rc-rtc-tools'

  const rtcTools = new RCRTCTools()

  const { code, room, tracks } = await rtcClient.joinRTCRoom(roomId)

  room.registerReportListener({
    onStateReport (reports) {
      // 传入 reports 更新视图
      rtcTools.updateView(reports)
    }
  })
```


当资源发布/订阅后，会触发 onStateReport 监听, 此时点击工具图标会展示 peerConnection 相关的数据。

![image](https://webqa.rongcloud.net/static/jenkins/plugin-rtc-demo/origin/meeting/20220921191322.jpg)

---
_Source: https://npm.io/package/rc-rtc-tools · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._