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

    Variable PeerEventConst

    PeerEvent: {
        Broadcast: "broadcast";
        Disconnected: "disconnected";
        Error: "error";
        Pong: "pong";
        RateLimitExceeded: "rate-limit-exceeded";
        Signal: "signal";
    } = ...

    Names of the events emitted by a Peer instance.

    Type Declaration

    • ReadonlyBroadcast: "broadcast"

      The peer requested a room-wide broadcast. Payload: (channel, data).

    • ReadonlyDisconnected: "disconnected"

      The peer's WebSocket closed. Payload: (code, reason).

    • ReadonlyError: "error"

      An inbound message failed to parse/validate, or a send failed. Payload: the Error.

    • ReadonlyPong: "pong"

      The peer answered a heartbeat ping; lastPong was refreshed.

    • ReadonlyRateLimitExceeded: "rate-limit-exceeded"

      An inbound message was dropped because the peer exceeded its rate limit.

    • ReadonlySignal: "signal"

      The peer sent a directed signal. Payload: (to, data).