From c6ec036e9eb16e567e8837247e47b1a069b9b012 Mon Sep 17 00:00:00 2001 From: hippoz Date: Mon, 17 May 2021 02:26:34 +0300 Subject: [PATCH] add voice to documentation --- resources/Docs/DOCS.md | 34 ++++++++++++++++++++++++++++------ 1 file changed, 28 insertions(+), 6 deletions(-) diff --git a/resources/Docs/DOCS.md b/resources/Docs/DOCS.md index dd06b52..be9cc13 100644 --- a/resources/Docs/DOCS.md +++ b/resources/Docs/DOCS.md @@ -138,7 +138,7 @@ Example: 7@{_id:"totallyrealuserid",username:"totallyrealusername",status:1,status_text:"hello"} ``` -## 21:ACTION\_VOICE\_BEGIN\_SESSION +## 21:ACTION_VOICE_REQUEST_SESSION *Auth required, Client to server* @@ -150,21 +150,43 @@ JSON data format: | - | - | | channel | An object that contains "_id", the id of the channel to connect to | -(unfinished) -## 22:ACTION\_VOICE\_BEGIN\_SESSION +## 22:EVENT_VOICE_ASSIGN_SERVER -*Auth required, Client to server* +*Auth required, Server to client* -Sent by the server when the voice session request has been accepted. If it is rejected, the client MUST be disconnected from the gateway as soon as possible. +Sent by the server when a voice server has been assigned to a channel session. JSON data format: | Field | Description | | - | - | | reportTo | The IP and port of the voice server to connect to | +| channel | An object that contains "_id", the id of the channel | + +# Voice server gateway + +Voice server signaling is done through a websocket gateway. This gateway is specified by the `reportTo` property in EVENT_VOICE_ASSIGN_SERVER. + +## 50:ACTION_VOICE_CONNECTION_REQUEST + +*Client to server* + +| Field | Description | +| - | - | +| token | The authentication token | +| channel | An object that contains "_id", the id of the channel to connect to | +| offer | An SDP payload; the webrtc offer from the client | + +## 51:EVENT_VOICE_CONNECTION_ANSWER + +*Auth required, Server to client* + +| Field | Description | +| - | - | +| session_id | A UUIDv4 | +| answer | An SDP payload; the webrtc answer from the server | -(unfinished) # Objects and data types