README.md

WebRTC Stats Gatherer

This module is designed to collect RTCPeerConnection stats on a regular interval and emit stats and trace data as appropriate.

Note that this project makes use of event emitting capabilities of RTCPeerConnection as opposed to a raw browser RTCPeerConnection.

API

constructor(peerConnection: RTCPeerConnection, opts: StatsGathererOpts)

interface StatsGathererOpts {
  session?: string;     // sessionId
  initiator?: string;
  conference?: string;  // conversationId
  interval?: number;    // interval, in seconds, at which stats are polled (default to 5)
  logger?: any;         // defaults to console
}

Usage

import StatsGatherer from 'webrtc-stats-gatherer';

const gatherer = new StatsGatherer(myPeerConnection);
gatherer.on('stats', (statsEvent) => doSomethingWithStats(statsEvent));