RTCForge API Reference v1.1.1
    Preparing search index...

    Variable RoomEventConst

    RoomEvent: {
        Broadcast: "broadcast";
        Closed: "closed";
        Kicked: "kicked";
        PeerJoined: "peer-joined";
        PeerLeft: "peer-left";
        PresenceOffline: "presence-offline";
        PresenceOnline: "presence-online";
        Refreshed: "refreshed";
        RoleChanged: "role-changed";
        Signal: "signal";
    } = ...

    Events emitted by a Room that concern the room itself rather than a specific peer message.

    Type Declaration

    • ReadonlyBroadcast: "broadcast"

      A broadcast arrived on a named channel; the payload is (from, channel, data).

    • ReadonlyClosed: "closed"

      The room was closed; the Room instance is no longer usable.

    • ReadonlyKicked: "kicked"

      The local peer was kicked; the payload is (peerId, reason).

    • ReadonlyPeerJoined: "peer-joined"

      A remote peer joined the room; the payload is the peer id string.

    • ReadonlyPeerLeft: "peer-left"

      A remote peer left the room; the payload is the peer id string.

    • ReadonlyPresenceOffline: "presence-offline"

      A known peer lost its connection but has not left; the payload is the peer id string.

    • ReadonlyPresenceOnline: "presence-online"

      A known peer regained its connection; the payload is the peer id string.

    • ReadonlyRefreshed: "refreshed"

      The room roster was replaced after a reconnect/rejoin (peers, roles, metadata, ICE servers).

    • ReadonlyRoleChanged: "role-changed"

      A peer's role changed; the payload is (peerId, role).

    • ReadonlySignal: "signal"

      A directed peer-to-peer signaling payload arrived; the payload is (from, data).