verax-sfu

WebRTC Selective Forwarding Unit

Events

Room (Connect)

1. Join Room

Client -> Server

{
  "type": "connect",
  "name": "room",
  "data": {
    "room": "name"
  }
}

Server -> Client

{
  "type": "connect",
  "name": "roomResponse",
  "data": {
    "room": "name",
    "id" : "ClientId"
  }
}

2. Conference

2.1. Join Conference

Client -> Server

{
  "type": "conference",
  "name": "join",
  "data": {
    "room": "name",
    "id": "ClientId"
  }
}

Server -> Client

{
  "type": "conference",
  "name": "joinResponce",
  "data": {
    "id": "ClientId",
    "room": "name"
  }
}

Server -> Broadcast Peers

{
  "type": "conference",
  "name": "peerJoin",
  "data": {
    "id": "ClientId",
    "room": "name"
  }
}

2.2 Leave Conference

Client -> Server

{
  "type": "conference",
  "name": "leave",
  "data": {
    "room": "name",
    "id": "ClientId"
  }
}

Server -> Client

{
  "type": "conference",
  "name": "leaveResponce",
  "data": {}
}

Server -> Broadcast Peers

{
  "type": "conference",
  "name": "peerLeave",
  "data": {
    "id": "ClientId",
    "room": "name"
  }
}

3. Signaling

3.1 Session Description

Client -> Server -> Broadcast Peers

{
  "type": "signal",
  "name": "sdp",
  "data": {
    "room": "name",
    "sdp": "string",
    "id": "ClientId"
  }
}

3.2 Ice Candidates

Client -> Server -> Broadcast Peers

{
  "type": "signal",
  "name": "trickle",
  "data": {
    "room": "name",
    "candidate": "string",
    "id": "ClientId"
  }
}

3.3 Renegotiation

####Server -> Broadcast Peers

{
  "type": "signal",
  "name": "renegotiation",
  "data": {
    "room": "name",
    "sdp": "string",
    "id": "ClientId"
  }
}

3 Verax Signal

Client -> Server -> Broadcast Peers

{
  "type": "signal",
  "method": "join",
  "data": {
    "sid": "sid:string",
    "uid": "uid:string",
    "offer": "sdp:string"
  }
}

4 System

4.1 Peer Disconnected

Server -> Broadcast Peers

{
  "type": "system",
  "name": "peerDisconnected",
  "data": {
    "id": "ClientId",
    "room": "name"
  }
}

4.2 Keep Alive

Client -> Server

{
  "type": "system",
  "name": "ping",
  "data": {
  }
}

Server -> Client

{
  "type": "system",
  "name": "pong",
  "data": {
  }
}