Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@testrtc/watchrtc-sdk

Package Overview
Dependencies
Maintainers
2
Versions
127
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@testrtc/watchrtc-sdk

gather WebRTC API traces and statistics

  • 1.28.9
  • npm
  • Socket score

Version published
Weekly downloads
3.9K
increased by70.35%
Maintainers
2
Weekly downloads
 
Created
Source

watchRTC offers users the ability to collect, track and analyze the metrics of real users on any WebRTC application.

This is done by including our watchRTC SDK which connects to the testRTC backend.

Installation

via Yarn
yarn add @testrtc/watchrtc-sdk
via NPM
npm install @testrtc/watchrtc-sdk
via CDN
<script src="https://unpkg.com/@testrtc/watchrtc-sdk/lib/index.js"></script>

Usage

Before any of your webrtc javascript code, add the following:

javascript (ES6+)
const watchRTC = require("@testrtc/watchrtc-sdk");
watchRTC.init();
Typescript
import watchRTC from "@testrtc/watchrtc-sdk";
watchRTC.init();
javascript (ES5+)

with CDN

<!DOCTYPE html>
<html lang="en">
  <head>
    <title>watchRT SDK</title>
  </head>
  <body>
    <script src="https://unpkg.com/@testrtc/watchrtc-sdk/lib/index.js"></script>
    <script>
      watchRTC.init();
    </script>
  </body>
</html>

This will transparently modify the RTCPeerConnection objects, allowing it to connect to the watchRTC backend service. The watchrtc parameter is needed to make this connection.

  • rtcApiKey - the watchRTC API key, as provided by testRTC
  • rtcRoomId - an identifier to the session/room/conference. This will enable an analysis of all participants in the same room as a single logical unit
  • rtcPeerId - an identifer of this peer/user in the session. This will make it easier to identify and troubleshoot users. It is recommended to use non-PII data here as much as possible
  • rtcTags - tags to associate with this peer connection. These can later be searched for or filtered
  • proxyUrl - (optional) secured web socket proxy server address, the proxy server should forward the connection to testRTC watch RTC server
var pc = new RTCPeerConnection({
  ...,
  watchrtc:{
    rtcApiKey: "watchrtc api key",
    rtcRoomId: "identifier for the session",
    rtcPeerId: "identifier for the current peer",
    rtcTags: ["tag1", "tag2", "tag3"]
  }
});

Instead of calling

watchRTC.init();

you can use next approach

watchRTC.init({
  rtcApiKey: "watchrtc api key",
  rtcRoomId: "identifier for the session",
  rtcPeerId: "identifier for the current peer",
  rtcTags: ["tag1", "tag2", "tag3"],
});

You also can use watchRTC.setConfig function to set watchrtc configuration

watchRTC.setConfig({
  rtcApiKey: "watchrtc api key",
  rtcRoomId: "identifier for the session",
  rtcPeerId: "identifier for the current peer",
  rtcTags: ["tag1", "tag2", "tag3"],
});

This will override peerconnection and will use those values.

Initialize SDK. Can be called multiple times but it will be initialized only at the first time.

Samples

https://github.com/testRTC/sample-Twilio-video-app-React-TypeScript-watchRTC

Keywords

FAQs

Package last updated on 15 Jun 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc