Dolby OptiView WebRTC 统计
该项目是一个用于分析WebRTC统计数据的库.
安装此工程
运行以下 npm 命令以安装软件包 @dolbyio/webrtc-stats 输入您的项目 :
npm install @dolbyio/webrtc-stats
使用库
收藏
A 类 WebRTCStats 要启动 WebRTC 统计收集,需要创建对象。 它需要一些设置来配置您想要收藏如何工作 。 首先导入 WebRTCStats 定义.
import { WebRTCStats } from '@dolbyio/webrtc-stats';
创建此示例的收藏对象 :
const collection = new WebRTCStats({
getStats: () => {
// Get the raw WebRTC statistics from the web browser
},
getStatsInterval: 1000,
includeRawStats: true,
});
以 start() 函数.
collection.start();
停止收藏与 stop() 函数.
collection.stop();
活动
在开始收集后 stats 当WebRTC统计被收集并解析时,会触发事件.
import { OnStats } from '@dolbyio/webrtc-stats';
collection.on('stats', (event: OnStats) => {
console.log(event);
});
这个 error 当收集或解析WebRTC统计时发生错误时,会触发事件.
collection.on('error', (reason: string) => {
console.error(reason);
});
示例
如何开始从 多尔比奥普蒂维尤 SDK(英语:SDK).
import { WebRTCStats, OnStats } from '@dolbyio/webrtc-stats';
import { Director, Publish } from '@millicast/sdk';
const PUBLISHER_TOKEN = '';
const STREAM_NAME = '';
const tokenGenerator = () =>
Director.getPublisher({
token: PUBLISHER_TOKEN,
streamName: STREAM_NAME,
});
const publisher = new Publish(undefined, tokenGenerator);
// HERE: Publish a stream to Dolby OptiView
const collection = new WebRTCStats({
getStatsInterval: 1000,
getStats: () => {
return publisher.webRTCPeer.getRTCPeer().getStats();
},
});
// The stats event is triggered after each interval has elapsed
collection.on('stats', (event: OnStats) => {
console.log(event);
});
// Start the statistics collection
collection.start();
日志
也可以使用以下代码打印控制台中的日志并选择日志级别.
import { Logger } from '@dolbyio/webrtc-stats';
Logger.useDefaults({
defaultLevel: Logger.TRACE,
});
怎么样
运行测试 :
npm run test
创建分发包 :
npm run build
文献以 类型文件,生成 Doc,运行以下命令。 您可以在 docs 文件夹.
npm run docs