peerconnection-stats

Index

References

default

Classes

Interfaces

Report

Type aliases

OriginalReport

Variables

version

Functions

References

default

Renames and exports getStats

Type aliases

OriginalReport

OriginalReport: Map<string, string | number | boolean>

Variables

Const version

version: string = ...

The version of AudioTrackMixer

example

import { version } from 'audio-track-mixer';

Functions

getLegacyStats

getLegacyStats(pc: RTCPeerConnection): Promise<OriginalReport[]>

Get stats of peerconnection / 获取 peerconnection 的状态信息
example
```
getLegacyStats(pc)
 .then((originalReports: Array<OriginalReport>) => {
   let report: CandidatePairReports = new CandidatePairReports(originalReports);
   console.log(report.currentRoundTripTime);
   ...
 })
 .catch(err => {
   ...
 });
```
Parameters
- pc: RTCPeerConnection
  
  A peerconnection object / 需要获取状态的 peerconnection 对象
Returns Promise<OriginalReport[]>

A collection of formatted reports from original getStats of peerconnection / 一组通过 peerconnection 原生 getStats 方法获取的数据的格式式报告

getStats

getStats(pc: RTCPeerConnection): Promise<OriginalReport[]>

Get stats of peerconnection / 获取 peerconnection 的状态信息
example
```
getStats(pc)
 .then((originalReports: Array<OriginalReport>) => {
   let report: CandidatePairReports = new CandidatePairReports(originalReports);
   console.log(report.currentRoundTripTime);
   ...
 })
 .catch(err => {
   ...
 });
```
Parameters
- pc: RTCPeerConnection
  
  A peerconnection object / 需要获取状态的 peerconnection 对象
Returns Promise<OriginalReport[]>

A collection of formatted reports from original getStats of peerconnection / 一组通过 peerconnection 原生 getStats 方法获取的数据的格式式报告

Generated using TypeDoc