CloudflareRoom

CloudflareRoom watches every device in one room of a cf-sfu-worker. See the Cloudflare Realtime guide for examples.

It is a connection and a room.

import { CloudflareRoom } from '@mazupo/client';

const room = new CloudflareRoom({ apiUrl, apiKey, roomId });
room.onDevices = (devices) => { /* ... */ };
room.connect();

Options複製段落連結

Next to the options of every connection and of every room.

Status複製段落連結

connected means that you are in the room. The devices' video comes after that, as each device wakes. If the connection drops, the room is reconnecting until it is back. It gets a new access token each time.

Messages and control複製段落連結

Only the viewer that controls a device can send to it. Others wait in line.

• sendText() goes to every device that you control.
• sendTextTo(deviceId) goes to that device, if you control it.
• canSend() and canSendTo(deviceId) tell whether a message would get there now.
• gamepad() goes to every device that you control, or only to deviceIds.

onMessage(data, deviceId) gets the messages of every device in the room. All of this needs ipc: true.

takeControl複製段落連結

.takeControl(deviceId: string)

Takes control of the device, or waits in line. Needs ipc: true.

releaseControl複製段落連結

.releaseControl(deviceId: string)

Gives up control or your place in line.

Voice複製段落連結

With microphone (the default), the room publishes your microphone and pulls every other viewer's. You start muted.

• toggleMic() mutes or unmutes you. The others see it: muted in their viewers.
• Each other viewer's voice is the stream of its RoomViewerInfo. Play it in an <audio> element.
• toggleSpeaker(false) silences everyone, devices included.
• The room's devices play your voice too, unless they run with --no-audio.
• A room takes 10 microphones by default. Past that, onError gets microphone_limit, and you only listen.

onError複製段落連結

Next to the codes of every connection, the codes are the worker's error codes in lower case, such as not_controller, plus these:

• token: the token request failed. A refused request, such as a wrong apiKey, closes the room. Otherwise the room tries again.
• replaced: a copy of this tab took over. The room closes.
• viewer_id_in_use: someone else in the room uses this viewerId. The room closes.
• microphone: the browser did not give the microphone. You only listen.
• microphone_limit: the room already has the most microphones. You only listen.

RoomDevice複製段落連結

Each state:

• offline: the device is not connected to the worker.
• sleeping: the device is connected, and nobody watches it.
• waking: the device is starting to stream.
• live: the device streams. Its stream comes soon after.

RoomControl:

RoomViewerInfo複製段落連結

To see what a viewer controls, look at control of each device.

A RoomViewer is { room, viewerId }. A viewer in another room can control the same device, because a device can join up to 4 rooms.