Skip to content

MeshRoom

メッシュ接続でのルームを管理するクラスです。

Constructor

SDK内部の利用のみで、コンストラクタは通常利用しません。 MeshRoomのインスタンスは、joinRoom() で生成されます。

Sample

meshRoom = peer.joinRoom('roomName');

Methods

close

ルームを退出し、ルーム内のすべてのユーザーとのコネクションをcloseします

Parameters

None

Return value

undefined

Sample

room.close();

getLog

シグナリングサーバにルームのログ取得を要求します。 シグナリングサーバからログを受信すると、logイベントが発火します。

Parameters

None

Return value

undefined

Sample

room.getLog();

replaceStream

送信しているMediaStreamを更新します。受信のみモードから双方向に切り替えできます。 また、音声のみのストリームから、音声+映像のストリームへの変更もできます。

Parameters

Name Type Required Default Description
stream MediaStream 交換対象となる新しいMediaStreamです。

Return value

undefined

Sample

// newStream
meshRoom.replaceStream(newStream);

send

WebSocketを使用してルーム内の全てのユーザーにデータを送信します。

Parameters

Name Type Required Default Description
data * 送信するデータです。

Events

open

新規にPeerがルームへ入室したときに発生します。

peerJoin

ルームに新しいPeerが参加したときに発生します。

Type Description
string 参加したPeerID

peerLeave

新規にPeerがルームを退出したときに発生します。

Type Description
string 退出したPeerID

log

ルームのログを受信したときに発生します。

Type Description
Array ログの配列です

stream

ルームにJoinしている他のユーザのストリームを受信した時に発生します。ストリーム送信元のpeerIdは stream.peerId で取得できます。

Type Description
MediaStream MediaStreamのインスタンスです。

Sample

room.on('stream', stream =>{
  // Streamをvideoタグに設定など
});

data

他のユーザーから送信されたデータを受信した時に発生します。

Type Description
object data object形式のオブジェクトです。

data object

Name Type Description
src string データを送信したPeerのIDです。
data * 受信したデータです。

close

ルームをcloseしたときに発生します。

removeStream

ルームからMediaStreamが削除されたときに発生します。

Type Description
MediaStream MediaStreamのインスタンスです。

Sample

meshRoom.on('removeStream', stream => {
  // 削除されたストリームを持つPeerIDを取得
  const peerId = stream.peerId;
}