Skip to content
This repository has been archived by the owner on Mar 1, 2024. It is now read-only.

Update SignallingProtocol.md #288

Merged
merged 1 commit into from
Jul 7, 2023
Merged

Update SignallingProtocol.md #288

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions SignallingWebServer/Docs/SignallingProtocol.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<a name="player-datachannelrequest"></a>

Expand All @@ -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<a name="player-liststreamers"></a>

Expand All @@ -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<a name="player-peerdatachannelsready"></a>

Expand Down Expand Up @@ -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<a name="sfu-offer"></a>

Expand All @@ -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<a name="sfu-peerdatachannels"></a>

Expand Down Expand Up @@ -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<a name="signalling-identify"></a>

Expand Down Expand Up @@ -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<a name="streamer-disconnectplayer"></a>

Expand All @@ -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<a name="streamer-layerpreference"></a>

Expand All @@ -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<a name="streamer-ping"></a>

Expand Down
Loading