Negotiated data channels keyed by channel label.
Native WebRTC peer connection to the peer.
Peer identifier.
Metadata advertised by the peer.
Peer connection state, updated on connection state changes.
Remote media streams keyed by stream label.
Closes and frees all connection resources.
Removes a previously registered event listener.
Event name.
Optionalhandler: (...args: PeerEvents<M>[K]) => void
Event handler to remove. If omitted, all handlers for the event will be removed.
Subscribes to a peer event.
Event name.
Event handler.
Optionaloptions: ListenerOptions
Listener options, such as an AbortSignal that removes the handler.
A function that removes the handler.
Subscribes to an event and auto-unsubscribes after first invocation.
Event name.
Event handler.
Optionaloptions: ListenerOptions
Listener options, such as an AbortSignal that removes the handler.
A function that removes the handler.
Opens a data channel to the current peer.
If a channel with the same label already exists, it will be reused.
You can open a channel with the same label on both local and remote peers or only on one side. In any case, only one channel will be created for each label. You can send data through the channel in both directions.
It resolves once the channel is requested, not once it is open, so wait
for channel:open before sending through it.
Channel options or channel label.
Sends a message through a data channel.
If options is a string, it is treated as the channel label. If no label
is provided, it uses the default channel.
The send method works only with open channels that match the specified
label and are either ordered (reliable) without a protocol, or have a
protocol, which makes them raw. A raw channel accepts only strings and
binary data, and an unreliable one drops a message while its buffer is
backed up.
Failures, including a missing channel, are PeerixError instances
with the DATACHANNEL_ERROR code. A transfer fails once the channel buffer
stops draining for 10 seconds.
Message payload to send.
Optionaloptions: string | SendOptions
Send options or channel label.
A ReadableStream of transfer progress status or a Promise.
// send a message to default channel
await peer.send("Hello, peer!");
// send large data with a progress handler
const file = new File([new Uint8Array(1024 * 1024)], "example.dat");
const transfer = peer.send(file, {
label: "chat", // channel label
info: { filename: file.name }, // sent with the first chunk
signal: AbortSignal.timeout(10000), // abort signal
});
// optionally handle the progress
for await (const progress of transfer) {
const { id, label, current, total } = progress;
const percent = Math.round((current / total) * 100);
console.log(`[${id}:${label}] Sending... ${percent}%`);
}
Shares a new media stream to the current peer or updates an existing one.
If you pass a MediaStream instance directly, it will be shared under a label equal to the stream id. Otherwise, you can specify an explicit label in the options object. If a stream with the same label already exists, it will be updated and its tracks will be added/removed as needed to minimize renegotiations.
Stream descriptor or MediaStream instance.
Serializes the peer to a JSON-compatible object.
A serializable representation of the peer.
Stops sharing a previously shared media stream to the current peer.
If you pass a MediaStream instance directly, it will be unshared using its id as the label. Otherwise, you can specify the label in the options object or pass it directly as a string.
Unmanaged tracks are stopped, except for streams shared through Room.share, whose tracks other peers still use.
A stream label, MediaStream instance, or an object containing a label.
Represents a peer connection. Do not create Peer instances manually.