開発ガイド¶

配信者として接続する¶

sendonly() を使用して接続します。

const debug = true;
const sora = Sora.connection("ws://192.0.2.100:5000/signaling", debug);
const channelId = "sorajssdk";
const metadata = "";
const sendonly = sora.sendonly(channelId, metadata);

navigator.mediaDevices.getUserMedia({ audio: true, video: true }).then((mediastream) => {
  return sendonly.connect(mediastream);
});

視聴者として接続する¶

recvonly() を使用して接続します。

const debug = true;
const sora = Sora.connection("ws://192.0.2.100:5000/signaling", debug);
const channelId = "sorajssdk";
const metadata = "";
const recvonly = sora.recvonly(channelId, metadata);

recvonly.connect();

マルチストリームで接続する¶

マルチストリームとは、一つのピア接続で複数のメディアストリームを管理する機能です。詳しくは Sora ドキュメントマルチストリームを参照してください。

SendRecv オブジェクトのオプションに multistream: true を指定します。

const debug = true;
const sora = Sora.connection("ws://192.0.2.100:5000/signaling", debug);
const channelId = "sorajssdk";
const metadata = "";
const options = {
  multistream: true,
};
const sendrecv = sora.sendrecv(channelId, metadata, options);

navigator.mediaDevices.getUserMedia({ audio: true, video: true }).then((mediastream) => {
  return sendrecv.connect(mediastream);
});

マルチストリームで接続した Connection オブジェクトは接続したチャネル ID に MediaStream が追加、削除されるとイベントハンドラが呼ばれます。イベントハンドラを利用して追加、削除された MediaStream を処理します。

sendrecv.on("track", (event) => {
  const stream = event.streams[0];
  const remoteVideos = document.querySelector("#remote-videos");
  const remoteVideoId = "remote-video-" + stream.id;
  if (!remoteVideos.querySelector("#" + remoteVideoId)) {
    const remoteVideo = document.createElement("video");
    remoteVideo.id = remoteVideoId;
    remoteVideo.autoplay = true;
    remoteVideo.srcObject = stream;
    remoteVideos.appendChild(remoteVideo);
  }
});

sendrecv.on("removetrack", (event) => {
  const remoteVideoId = "remote-video-" + event.target.id;
  const remoteVideo = document.querySelector("#" + remoteVideoId);
  const remoteVideos = document.querySelector("#remote-videos");
  if (remoteVideo) {
    remoteVideos.removeChild(remoteVideo);
  }
});

SendRecv オブジェクトのオプションに multistream: true を指定することで Multistream 接続を視聴可能です。

const debug = true;
const sora = Sora.connection("ws://192.0.2.100:5000/signaling", debug);
const channelId = "sorajssdk";
const metadata = "";
const options = {
  multistream: true,
};
const recvonly = sora.recvonly(channelId, metadata, options);
recvonly.connect();

recvonly.on("track", (event) => {
  const stream = event.streams[0];
  const remoteVideos = document.querySelector("#remote-videos");
  const remoteVideoId = "remote-video-" + stream.id;
  if (!remoteVideos.querySelector("#" + remoteVideoId)) {
    const remoteVideo = document.createElement("video");
    remoteVideo.id = remoteVideoId;
    remoteVideo.autoplay = true;
    remoteVideo.srcObject = stream;
    remoteVideos.appendChild(remoteVideo);
  }
});

recvonly.on("removetrack", (event) => {
  const remoteVideoId = "remote-video-" + event.target.id;
  const remoteVideo = document.querySelector("#" + remoteVideoId);
  const remoteVideos = document.querySelector("#remote-videos");
  if (remoteVideo) {
    remoteVideos.removeChild(remoteVideo);
  }
});

サイマルキャストで接続する¶

サイマルキャスト (Simulcast) は配信時に 1 つの RTCPeerConnection から複数種類のエンコードした映像を配信する機能です。詳しくは Sora ドキュメントサイマルキャストを参照してください。

SendRecv オブジェクトのオプションに simulcast: true を指定します

const debug = true;
const sora = Sora.connection("ws://192.0.2.100:5000/signaling", debug);
const channelId = "sorajssdk";
const metadata = "";
const options = {
  videoCodecType: "VP8",
  simulcast: true,
};
const sendonly = sora.sendonly(channelId, metadata, options);

navigator.mediaDevices.getUserMedia({ audio: true, video: true }).then((mediastream) => {
  return sendonly.connect(mediastream);
});

スポットライトで接続する¶

スポットライト (Spotlight) は一定の音量を超えて音声を発している参加者の場合は音声や高画質映像を、それ以外の参加者は音声のない低画質映像を配信する機能です。詳しくは Sora ドキュメントスポットライトを参照してください。

SendRecv オブジェクトのオプションに spotlight: true simulcast: true multistream: true を指定します

const debug = true;
const sora = Sora.connection("ws://192.0.2.100:5000/signaling", debug);
const channelId = "sorajssdk";
const metadata = "";
const options = {
  spotlight: true,
  simulcast: true,
  multistream: true,
  videoCodecType: "VP8",
};
const sendrecv = sora.sendrecv(channelId, metadata, options);

navigator.mediaDevices.getUserMedia({ audio: true, video: true }).then((mediastream) => {
  return sendrecv.connect(mediastream);
});

映像・音声コーデックを指定する¶

SendRecv オブジェクトのオプションで指定します

const debug = true;
const sora = Sora.connection("ws://192.0.2.100:5000/signaling", debug);
const channelId = "sorajssdk";
const metadata = "";
const options = {
  audioCodecType: "OPUS",
  videoCodecType: "VP9",
};
const sendonly = sora.sendonly(channelId, metadata, options);

ビットレートを指定する¶

音声のビットレート指定は推奨しません

SendRecv オブジェクトのオプションで指定します

const debug = true;
const sora = Sora.connection("ws://192.0.2.100:5000/signaling", debug);
const channelId = "sorajssdk";
const metadata = "";
const options = {
  audioBitRate: 64,
  videoBitRate: 100,
};
const sendonly = sora.sendonly(channelId, metadata, options);

映像と音声の可否を指定する¶

SendRecv オブジェクトのオプションで指定します

音声なし

const debug = true;
const sora = Sora.connection("ws://192.0.2.100:5000/signaling", debug);
const channelId = "sorajssdk";
const metadata = "";
const options = {
  audio: false,
};
const sendonly = sora.sendonly(channelId, metadata, options);

映像なし

const debug = true;
const sora = Sora.connection("ws://192.0.2.100:5000/signaling", debug);
const channelId = "sorajssdk";
const metadata = "";
const options = {
  video: false,
};
const sendonly = sora.sendonly(channelId, metadata, options);

クライアントIDを指定する¶

接続時やサーバー認証成功時に任意の文字列を指定できる値です。詳しくは Sora ドキュメント WebSocket 経由のシグナリング client_id を参照してください。

SendRecv オブジェクトのオプションで指定します

const debug = true;
const sora = Sora.connection("ws://192.0.2.100:5000/signaling", debug);
const channelId = "sorajssdk";
const metadata = "";
const options = {
  clientId: "clientid",
};
const sendonly = sora.sendonly(channelId, metadata, options);

DataChannel 経由のシグナリングを使用する¶

WebRTC 接続確立後に、シグナリングを WebSocket 経由から DataChannel 経由に切り替える機能です。詳しくは Sora ドキュメント DataChannel 経由のシグナリングを参照してください。

SendRecv オブジェクトのオプションで指定します

const debug = true;
const sora = Sora.connection("ws://192.0.2.100:5000/signaling", debug);
const channelId = "sorajssdk";
const metadata = "";
const options = {
  // シグナリングを WebSocket 経由から DataChannel 経由に切り替えるかどうか
  dataChannelSignaling: true,
  // シグナリングを DataChannel 経由に切り替えたあとに WebSocket を切断するかどうか
  ignoreDisconnectWebSocket: false,
};
const sendonly = sora.sendonly(channelId, metadata, options);

メッセージング機能を使用する¶

SendRecv オブジェクトのオプションで指定します

const debug = true;
const sora = Sora.connection("ws://192.0.2.100:5000/signaling", debug);
const channelId = "sorajssdk";
const metadata = null;
// ConnectionOptions の dataChannels を指定する
const options = {
  multistream: true,
  dataChannelSignaling: true,
  dataChannels: [
    {
      label: "#example",
      direction: "sendrecv",
    },
  ],
}
const sendonly = sora.sendonly(channelId, metadata, options);

// メッセージを送信する
sendrecv.sendMessage('#example', new TextEncoder().encode("Hello world."));