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

    Variable RoomEventConst

    RoomEvent: {
        Closed: "closed";
        PeerError: "peerError";
        PeerJoined: "peerJoined";
        PeerKicked: "peerKicked";
        PeerLeft: "peerLeft";
    } = ...

    Names of the events emitted by a Room instance.

    Type Declaration

    • ReadonlyClosed: "closed"

      The room reached RoomState.Closed and holds no peers.

    • ReadonlyPeerError: "peerError"

      Sending a message to a peer failed. Payload: (peerId, error).

    • ReadonlyPeerJoined: "peerJoined"

      A peer joined (or reconnected into) the room. Payload: the Peer.

    • ReadonlyPeerKicked: "peerKicked"

      A peer was forcibly removed via Room.kickPeer. Payload: (peerId, reason?).

    • ReadonlyPeerLeft: "peerLeft"

      A peer left the room, was replaced, kicked, or the room closed. Payload: the Peer.