New docs #429

mcottontensor · 2023-11-17T01:52:31Z

Relevant components:

Problem statement:

Missing documentation for several components.

Solution

Added some brief documentation that was missing.

Documentation

Added SignallingWebServer docs. Linked the existing Matchmaker docs. Added SFU docs.

Test Plan and Compatibility

No testing needed.

Signed-off-by: mcottontensor <80377552+mcottontensor@users.noreply.github.com>

mcottontensor · 2023-11-17T01:55:42Z

Closes #257
Closes #256
Closes #255

lukehb · 2023-11-20T04:23:55Z

SFU/README.md

+| Name | Type | Default | Description |
+|-|-|-|-|
+| rtcMinPort | Number | 40000 | Minimun RTC port for ICE, DTLS, RTP, etc. |
+| rtcMazPort | Number | 49999 | Maximum RTC port for ICE, DTLS, RTP, etc. |


Should be rtcMaxPort

lukehb · 2023-11-20T04:24:57Z

SFU/README.md

+| Name | Type | Default | Description |
+|-|-|-|-|
+| signallingURL | String | 'http://localhost:8889' | The URL pointing to the signalling server we want to connect to. |
+| SFUId | String | 'SFU' | The streamer name this peer will be given when connecting to the signalling server. Peers wishing to receive from this SFU should subscribe to this ID. |


I think

The ~~streamer~~ name this peer will be given when connecting to the signalling server. Peers wishing to receive from this SFU should subscribe to this ID.

lukehb · 2023-11-20T04:26:37Z

SFU/README.md

+
+Launch the streaming app with the following arguments
+`-SimulcastParameters="1.0,5000000,20000000,2.0,1000000,5000000,4.0,50000,1000000"`
+This tells the pixel streaming plugin to stream simulcast with 3 streams, each one scaling down by 2. The sequence of values is as follows, `scale_down_factor,min_bitrate,max_bitrate,...repeating for each stream`


I prefer:

scaling video resolution by half.

pixel streaming

to

Pixel Streaming

lukehb

Minor changes requested.

DenisTensorWorks

Minor style and sentence flow edits.

DenisTensorWorks · 2023-11-20T04:49:58Z

SFU/README.md

@@ -0,0 +1,59 @@
+# Pixel Streaming Selective Forwarding Unit
+
+The SFU (Selective Forwarding Unit) is a mechanism to allow distributing a single stream out to a large number of peers. This is useful because when peers connect directly to the streamer, resources must be allocated per peer to allow encoding of the stream. This means resources can quickly be drained after only a handful of peers. The SFU can receive multiple streams using simulcast and selectively forward out streams to remote peers based on their available resources, without requiring to actually reencode the stream.


This means resources can quickly be drained

This means the resources can be quickly drained

reencode the stream

re-encode the stream

DenisTensorWorks · 2023-11-20T04:52:26Z

SFU/README.md

+|-|-|-|-|
+| signallingURL | String | 'http://localhost:8889' | The URL pointing to the signalling server we want to connect to. |
+| SFUId | String | 'SFU' | The streamer name this peer will be given when connecting to the signalling server. Peers wishing to receive from this SFU should subscribe to this ID. |
+| subscribeStreamerId | String | 'DefaultStreamer' | This is the name of the streamer that this SFU should subscribe to and restream. |


subscribe to and restream

subscribe to and re-stream

DenisTensorWorks · 2023-11-20T04:52:53Z

SFU/README.md

+| SFUId | String | 'SFU' | The streamer name this peer will be given when connecting to the signalling server. Peers wishing to receive from this SFU should subscribe to this ID. |
+| subscribeStreamerId | String | 'DefaultStreamer' | This is the name of the streamer that this SFU should subscribe to and restream. |
+| retrySubscribeDelaySecs | Number | 10 | If subscribing to the given streamer fails, wait this many seconds before trying again. |
+| mediasoup | Object | | Mediasoup related configuration options. See below. |


Mediasoup related

Mediasoup-related

DenisTensorWorks · 2023-11-20T04:53:38Z

SFU/README.md

+| retrySubscribeDelaySecs | Number | 10 | If subscribing to the given streamer fails, wait this many seconds before trying again. |
+| mediasoup | Object | | Mediasoup related configuration options. See below. |
+
+### Mediasoup related configuration options.


Mediasoup related configuration options.

Mediasoup-related configuration options

DenisTensorWorks · 2023-11-20T04:54:08Z

SFU/README.md

+
+| Name | Type | Default | Description |
+|-|-|-|-|
+| worker | Object | | Worker related configuration options. See below. |


Worker related

Worker-related

DenisTensorWorks · 2023-11-20T05:00:54Z

SignallingWebServer/README.md

@@ -0,0 +1,32 @@
+# Pixel Streaming Signalling Server
+
+The signalling server is a small middle-man application that sits between streamers and other peers. It handles the initial connection negotiations and some other small ongoing control messages between peers as well as acting as a simple web server for serving the [Frontend](/Frontend/README.md) web application.


a small middle-man application

a small intermediary application

DenisTensorWorks · 2023-11-20T05:01:17Z

SignallingWebServer/README.md

+
+## Configuration
+
+Configuration of the signalling server is handled via the config.js file in the SignallingWebServer directory. The following are supported options.


The following are supported options.

The following are its supported options.

DenisTensorWorks · 2023-11-20T05:02:11Z

SignallingWebServer/README.md

+| HomepageFile | String | 'player.html' | The root file of the frontend web application. |
+| AdditionalRoutes | Map | | Additional routes for the web application. |
+| EnableWebserver | Boolean | true | Enables or disables the serving of the frontend through the internal web server. Disbable this if you are serving your own frontend. |
+| MatchmakerAddress | String | | The IP/hostname of the match maker application. |


the match maker application

the matchmaker application

DenisTensorWorks · 2023-11-20T05:02:27Z

SignallingWebServer/README.md

+| AdditionalRoutes | Map | | Additional routes for the web application. |
+| EnableWebserver | Boolean | true | Enables or disables the serving of the frontend through the internal web server. Disbable this if you are serving your own frontend. |
+| MatchmakerAddress | String | | The IP/hostname of the match maker application. |
+| MatchmakerPort | Number | 9999 | The port the match maker is listening on. |


the match maker is listening on

the matchmaker is listening on

DenisTensorWorks · 2023-11-20T05:02:41Z

SignallingWebServer/README.md

+| EnableWebserver | Boolean | true | Enables or disables the serving of the frontend through the internal web server. Disbable this if you are serving your own frontend. |
+| MatchmakerAddress | String | | The IP/hostname of the match maker application. |
+| MatchmakerPort | Number | 9999 | The port the match maker is listening on. |
+| PublicIp | String | "localhost" | The public IP/hostname of the host that the signalling server is listening on. This is used by the match maker. |


This is used by the match maker.

This is used by the matchmaker.

mcottontensor and others added 7 commits November 17, 2023 10:22

Adding some new documentation for signalling

7f54018

Updating main doc to link to signalling docs

32d6e2b

Delete SignallingWebServer/Readme.md

7d3a6b6

Signed-off-by: mcottontensor <80377552+mcottontensor@users.noreply.github.com>

Fixing readme filename. Maybe?

d5efa38

Adding SFU docs.

65ebcfe

Adding info about simulcast streaming from UE

1aad4a6

Merge branch 'master' into new_docs

0f5e2d9

lukehb reviewed Nov 20, 2023

View reviewed changes

lukehb suggested changes Nov 20, 2023

View reviewed changes

DenisTensorWorks reviewed Nov 20, 2023

View reviewed changes

Small fixes from reviews

bbba5e0

mcottontensor merged commit e66dacf into EpicGames:master Nov 21, 2023

mcottontensor deleted the new_docs branch November 21, 2023 00:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New docs #429

New docs #429

mcottontensor commented Nov 17, 2023

mcottontensor commented Nov 17, 2023

lukehb Nov 20, 2023

lukehb Nov 20, 2023

lukehb Nov 20, 2023

lukehb Nov 20, 2023

lukehb left a comment

DenisTensorWorks left a comment

DenisTensorWorks Nov 20, 2023

DenisTensorWorks Nov 20, 2023

DenisTensorWorks Nov 20, 2023

DenisTensorWorks Nov 20, 2023

DenisTensorWorks Nov 20, 2023

DenisTensorWorks Nov 20, 2023

DenisTensorWorks Nov 20, 2023

DenisTensorWorks Nov 20, 2023

DenisTensorWorks Nov 20, 2023

DenisTensorWorks Nov 20, 2023

		@@ -0,0 +1,59 @@
		# Pixel Streaming Selective Forwarding Unit

		The SFU (Selective Forwarding Unit) is a mechanism to allow distributing a single stream out to a large number of peers. This is useful because when peers connect directly to the streamer, resources must be allocated per peer to allow encoding of the stream. This means resources can quickly be drained after only a handful of peers. The SFU can receive multiple streams using simulcast and selectively forward out streams to remote peers based on their available resources, without requiring to actually reencode the stream.

		@@ -0,0 +1,32 @@
		# Pixel Streaming Signalling Server

		The signalling server is a small middle-man application that sits between streamers and other peers. It handles the initial connection negotiations and some other small ongoing control messages between peers as well as acting as a simple web server for serving the [Frontend](/Frontend/README.md) web application.


		## Configuration

		Configuration of the signalling server is handled via the config.js file in the SignallingWebServer directory. The following are supported options.

New docs #429

New docs #429

Conversation

mcottontensor commented Nov 17, 2023

Relevant components:

Problem statement:

Solution

Documentation

Test Plan and Compatibility

mcottontensor commented Nov 17, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lukehb left a comment

Choose a reason for hiding this comment

DenisTensorWorks left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment