@videomark/sulfur.js v1.0.0

統計情報収集ライブラリ (sulfur library API)

\<script> を使用してロードを行う

<script src="./sulfur.js "></script>

Constructor

ライブラリオブジェクトの生成

Constructor(options)

const sulfur = new Sulfur(options);

open

統計情報収集開始

open(peer, connection, options)

Options

const peer = new Peer({
  key: API_KEY,
});

const sulfur = new Sulfur();

...
// 発信時
const connection = peer.call(remoteId, localStream);
sulfur.open(peer, connection, {
  video: document.getElementById("remote-pid"), // 対向のpeerID
  additionalId: "additionalId"
});

...
// 着信時
peer.on('call', mediaConnection => {
  mediaConnection.answer(localStream);
  sulfur.open(peer, mediaConnection, {
    video: document.getElementById("remote-pid"), // 対向のpeerID
    additionalId: "additionalId"
  });
});

close

統計情報収集終了

close()

connection.close(true);
sulfur.close();

Events

Event:'error'

エラーが発生した場合のイベント

sulfur.on("error", (e) => {
  // ...
});

Event:'opened'

統計情報収集を開始した場合のイベント

sulfur.on("opened", (url, collect, send) => {
  // ...
});

Event:'closed'

統計情報収集を終了した場合のイベント

sulfur.on("closed", (countsOfCollect, countsOfSend) => {
  // ...
});

値の取得方法

フィルタ処理

RTCStats のデータは getStats で取得し以下の条件でフィルタしたデータを送信する