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

    Variable MessageTypeConst

    MessageType: {
        Broadcast: "broadcast";
        Error: "error";
        Kicked: "kicked";
        PeerJoined: "peer-joined";
        PeerLeft: "peer-left";
        Ping: "ping";
        Pong: "pong";
        PresenceOffline: "presence-offline";
        PresenceOnline: "presence-online";
        RoleChanged: "role-changed";
        RoomJoined: "room-joined";
        Signal: "signal";
    } = ...

    The type discriminator carried by every wire message exchanged over the signaling WebSocket. Some values flow server→client, some client→server, and a few both ways (see ServerMessage and ClientMessage).

    Type Declaration

    • ReadonlyBroadcast: "broadcast"

      Both directions. A room-wide fan-out message on a named channel.

    • ReadonlyError: "error"

      Server→client. A protocol or application error.

    • ReadonlyKicked: "kicked"

      Server→client. The peer was forcibly removed from the room.

    • ReadonlyPeerJoined: "peer-joined"

      Server→client. A new peer joined the room.

    • ReadonlyPeerLeft: "peer-left"

      Server→client. A peer left the room.

    • ReadonlyPing: "ping"

      Server→client. Heartbeat probe; the client must answer with MessageType.Pong.

    • ReadonlyPong: "pong"

      Client→server. Heartbeat response to a MessageType.Ping.

    • ReadonlyPresenceOffline: "presence-offline"

      Server→client. A peer became unreachable (presence down).

    • ReadonlyPresenceOnline: "presence-online"

      Server→client. A peer became reachable (presence up).

    • ReadonlyRoleChanged: "role-changed"

      Server→client. A peer's role changed.

    • ReadonlyRoomJoined: "room-joined"

      Server→client. Sent once on join with the room roster, roles, metadata, and ICE servers.

    • ReadonlySignal: "signal"

      Both directions. A directed peer-to-peer signal (SDP/ICE payload).