Voice Events

Sent when a user's voice state changes (join, leave, mute, deafen, screen share), with the whole state. Broadcast to all members of the space, or of the conversation for calls. A VOICE_SYNC that changes nothing sends none. Updates can arrive out of order: apply one only if its version is greater than the last one applied for that user and room, counting the versions in SPACE_CREATE voice_states and READY active_calls.

{
  "type": "VOICE_STATE_UPDATE",
  "data": {
    "room_id": "019cf96a-be82-72c5-830f-75e85355d800",
    "user_id": "019cf96a-3d5b-72c5-830f-75e85355d078",
    "joined": true,
    "muted": false,
    "deafened": false,
    "screen_sharing": false,
    "version": 1792181390951042
  }
}

Sent to a user when their voice session ends server-side: it was replaced by a new connection (e.g., connecting from another device), or they lost ViewChannels or JoinVoice in that room, left the space, or the room was deleted or is no longer a voice room. If the session that joined is gone (the client reconnected), it is sent to all of the user's sessions; only one that is in that room should act on it. The client should clean up its local voice state. Losing SpeakInVoice does not end the session; the gateway stops forwarding the user's audio and shows them as muted (VOICE_STATE_UPDATE). When they get it back, it shows the mute state their client last sent in VOICE_SYNC again. Clients mute themselves when they lose it, and should send that VOICE_SYNC too.

{
  "type": "VOICE_SESSION_REPLACED",
  "data": {
    "room_id": "019cf96a-be82-72c5-830f-75e85355d800",
    "reason": "permissions"
  }
}

Sent to the user after they successfully join a voice room. Contains the SDP answer from the server to complete the WebRTC handshake.

{
  "type": "VOICE_JOINED",
  "data": {
    "room_id": "019cf96a-be82-72c5-830f-75e85355d800",
    "answer": {
      "type": "answer",
      "sdp": "v=0\r\no=- 1234567890 2 IN IP4 127.0.0.1..."
    }
  }
}

Sent when the server discovers a new ICE candidate for the WebRTC connection. The client should add this candidate to its peer connection.

{
  "type": "WEBRTC_ICE_CANDIDATE",
  "data": {
    "candidate": "candidate:1 1 UDP 2130706431 192.168.1.1 12345 typ host",
    "room_id": "019cf96a-be82-72c5-830f-75e85355d800"
  }
}

Sent by the server when the WebRTC connection needs to be renegotiated (e.g., when another user joins or leaves the voice room). Contains a new SDP offer that the client must respond to with an answer.

{
  "type": "WEBRTC_RENEGOTIATE",
  "data": {
    "offer": {
      "type": "offer",
      "sdp": "v=0\r\no=- 1234567890 3 IN IP4 127.0.0.1..."
    },
    "room_id": "019cf96a-be82-72c5-830f-75e85355d800"
  }
}

Sent by the server as a confirmation after processing the client's renegotiation answer.

{
  "type": "WEBRTC_RENEGOTIATE_ANSWER",
  "data": {
    "room_id": "019cf96a-be82-72c5-830f-75e85355d800",
    "answer": {
      "type": "answer",
      "sdp": "v=0\r\no=- 1234567890 4 IN IP4 127.0.0.1..."
    }
  }
}