@wireapp/avs-debugger

Wire Track Debugger

Visualize and debug media tracks in web

Use it

NPM

npm install @wireapp/avs-debugger

From Source

The only way to use it currently is to build from source code and then link to your project

git clone [e-mail]:wireapp/wire-avs-debugger.git
npm install
npm run build
npm link

Go to your Project and run:

npm link @wireapp/avs-debugger

Integrate

Integrate as JS WebComponent

<script type="application/javascript" src="dist/index.js"></script>
<track-debugger id="avs-debugger"></track-debugger>

<script>
  document.onreadystatechange = function () {
    const state = document.readyState;
    if (state == 'complete') {
      // init web component
      window.initTrackDebugger();

      // API
      document.getElementById('avs-debugger').addTrack(id, name, track);
      document.getElementById('avs-debugger').removeTrack(id);
      document.getElementById('avs-debugger').hasTrack(id);
      document.getElementById('avs-debugger').reset();

      // destruct web component
      window.destructTrackDebugger();
    }
  }
</script>

Integrate as TypeScript WebComponent

<track-debugger id='avs-debugger'></track-debugger>

import * as avsTrackLogger from '@wireapp/avs-debugger';

// init web component
avsTrackLogger.initTrackDebugger();

// API
avsTrackLogger.addTrack(id, name, track);
avsTrackLogger.removeTrack(id);
avsTrackLogger.hasTrack(id);
avsTrackLogger.reset();

// destruct web component
avsTrackLogger.destructTrackDebugger();

Develop

npm install
npm start

Build

npm install
npm run build

The generated artifacts are located in dist

Release

A successful Github release automatically triggers an NPM release.