From f56cb1089f47209580ac14dffecd0f3230c0c71a Mon Sep 17 00:00:00 2001
From: mcottontensor <80377552+mcottontensor@users.noreply.github.com>
Date: Fri, 7 Jul 2023 10:47:11 +1000
Subject: [PATCH] Update SignallingProtocol.md
Signed-off-by: mcottontensor <80377552+mcottontensor@users.noreply.github.com>
---
SignallingWebServer/Docs/SignallingProtocol.md | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/SignallingWebServer/Docs/SignallingProtocol.md b/SignallingWebServer/Docs/SignallingProtocol.md
index f9599c22..13bd80a8 100644
--- a/SignallingWebServer/Docs/SignallingProtocol.md
+++ b/SignallingWebServer/Docs/SignallingProtocol.md
@@ -111,7 +111,7 @@ end
| Param Name | Type | Description |
|-|-|-|
-| Sdp | string | The WebRTC SDP package in string format |
+| sdp | string | The WebRTC SDP package in string format |
### dataChannelRequest
@@ -126,7 +126,7 @@ end
| Param Name | Type | Description |
|-|-|-|
-| candidate | string | The JSON string describing the ICE candidate |
+| candidate | Object | The JSON object describing the ICE candidate |
### listStreamers
@@ -141,7 +141,7 @@ end
| Param Name | Type | Description |
|-|-|-|
-| Sdp | string | The WebRTC SDP package in string format |
+| sdp | string | The WebRTC SDP package in string format |
### peerDataChannelsReady
@@ -181,7 +181,7 @@ end
| Param Name | Type | Description |
|-|-|-|
-| Sdp | string | The WebRTC SDP package in string format |
+| sdp | string | The WebRTC SDP package in string format |
### offer
@@ -190,7 +190,7 @@ end
| Param Name | Type | Description |
|-|-|-|
| playerId | string | The id of the player to send the offer to. |
-| Sdp | string | The WebRTC SDP package in string format |
+| sdp | string | The WebRTC SDP package in string format |
### peerDataChannels
@@ -220,7 +220,7 @@ end
| Param Name | Type | Description |
|-|-|-|
-| peerConnectionOptions | object | The object describing the peer connection options for this server. |
+| peerConnectionOptions | Object | The object describing the peer connection options for this server. |
### identify
@@ -288,7 +288,7 @@ end
| Param Name | Type | Description |
|-|-|-|
| playerId | string | The id of the player to send the answer to. |
-| Sdp | string | The WebRTC SDP package in string format |
+| sdp | string | The WebRTC SDP package in string format |
### disconnectPlayer
@@ -314,7 +314,7 @@ end
| Param Name | Type | Description |
|-|-|-|
| playerId | string | The id of the player to send the ICE candidate to. |
-| candidate | string | The JSON string describing the ICE candidate |
+| candidate | Object | The JSON string describing the ICE candidate |
### layerPreference
@@ -333,7 +333,7 @@ end
| Param Name | Type | Description |
|-|-|-|
| playerId | string | The id of the player to send the offer to. |
-| Sdp | string | The WebRTC SDP package in string format |
+| sdp | string | The WebRTC SDP package in string format |
### ping