WebRtcMultiplayerPeer
A simple interface to create a peer-to-peer mesh network composed of WebRTCPeerConnection that is compatible with the MultiplayerAPI.
A simple interface to create a peer-to-peer mesh network composed of WebRtcPeerConnection that is compatible with the MultiplayerApi.
This class constructs a full mesh of WebRtcPeerConnection (one connection for each peer) that can be used as a MultiplayerApi.MultiplayerPeer.
You can add each WebRtcPeerConnection via WebRtcMultiplayerPeer.AddPeer or remove them via WebRtcMultiplayerPeer.RemovePeer. Peers must be added in WebRtcPeerConnection.ConnectionState.New state to allow it to create the appropriate channels. This class will not create offers nor set descriptions, it will only poll them, and notify connections and disconnections.
When creating the peer via WebRtcMultiplayerPeer.CreateClient or WebRtcMultiplayerPeer.CreateServer the MultiplayerPeer.IsServerRelaySupported method will return true enabling peer exchange and packet relaying when supported by the MultiplayerApi implementation.
Note: When exporting to Android, make sure to enable the INTERNET permission in the Android export preset before exporting the project or using remote deploy. Otherwise, network communication of any kind will be blocked by Android.
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Constructors1
WebRtcMultiplayerPeerConstructor
public WebRtcMultiplayerPeer();Methods8
AddPeerError
public Error AddPeer(WebRtcPeerConnection peer, int peerId, int unreliableLifetime = 1);Add a new peer to the mesh with the given peer_id. The WebRtcPeerConnection must be in state WebRtcPeerConnection.ConnectionState.New.
Three channels will be created for reliable, unreliable, and ordered transport. The value of unreliable_lifetime will be passed to the "maxPacketLifetime" option when creating unreliable and ordered channels (see WebRtcPeerConnection.CreateDataChannel).
| Name | Type | Default |
|---|---|---|
peer | WebRtcPeerConnection | — |
peerId | int | — |
unreliableLifetime | int | 1 |
ErrorCreateClientError
public Error CreateClient(int peerId, Reckfell.Collections.Array channelsConfig = null);Initialize the multiplayer peer as a client with the given peer_id (must be between 2 and 2147483647). In this mode, you should only call WebRtcMultiplayerPeer.AddPeer once and with peer_id of 1. This mode enables MultiplayerPeer.IsServerRelaySupported, allowing the upper MultiplayerApi layer to perform peer exchange and packet relaying.
You can optionally specify a channels_config array of MultiplayerPeer.TransferModeEnum which will be used to create extra channels (WebRTC only supports one transfer mode per channel).
| Name | Type | Default |
|---|---|---|
peerId | int | — |
channelsConfig | Reckfell.Collections.Array | null |
ErrorCreateMeshError
public Error CreateMesh(int peerId, Reckfell.Collections.Array channelsConfig = null);Initialize the multiplayer peer as a mesh (i.e. all peers connect to each other) with the given peer_id (must be between 1 and 2147483647).
| Name | Type | Default |
|---|---|---|
peerId | int | — |
channelsConfig | Reckfell.Collections.Array | null |
ErrorCreateServerError
public Error CreateServer(Reckfell.Collections.Array channelsConfig = null);Initialize the multiplayer peer as a server (with unique ID of 1). This mode enables MultiplayerPeer.IsServerRelaySupported, allowing the upper MultiplayerApi layer to perform peer exchange and packet relaying.
You can optionally specify a channels_config array of MultiplayerPeer.TransferModeEnum which will be used to create extra channels (WebRTC only supports one transfer mode per channel).
| Name | Type | Default |
|---|---|---|
channelsConfig | Reckfell.Collections.Array | null |
ErrorGetPeerReckfell.Collections.Dictionary
public Reckfell.Collections.Dictionary GetPeer(int peerId);Returns a dictionary representation of the peer with given peer_id with three keys. "connection" containing the WebRtcPeerConnection to this peer, "channels" an array of three WebRtcDataChannel, and "connected" a boolean representing if the peer connection is currently connected (all three channels are open).
| Name | Type | Default |
|---|---|---|
peerId | int | — |
Reckfell.Collections.DictionaryGetPeersReckfell.Collections.Dictionary
public Reckfell.Collections.Dictionary GetPeers();Returns a dictionary which keys are the peer ids and values the peer representation as in WebRtcMultiplayerPeer.GetPeer.
Reckfell.Collections.DictionaryHasPeerbool
public bool HasPeer(int peerId);Returns true if the given peer_id is in the peers map (it might not be connected though).
| Name | Type | Default |
|---|---|---|
peerId | int | — |
boolRemovePeervoid
public void RemovePeer(int peerId);Remove the peer with given peer_id from the mesh. If the peer was connected, and MultiplayerPeer.PeerConnected was emitted for it, then MultiplayerPeer.PeerDisconnected will be emitted.
| Name | Type | Default |
|---|---|---|
peerId | int | — |