Settings Panel Documentation #135
Conversation
Signed-off-by: Michael Wallace <[email protected]>
Signed-off-by: Michael Wallace <[email protected]>
Frontend/Docs/Settings Panel.md
Outdated
|
|
||
| ## Legal | ||
|
|
||
| Copyright © 2022, Epic Games. Licensed under the MIT License, see the file [LICENSE](./LICENSE) for details. |
There was a problem hiding this comment.
Let's update copyright year to 2023
Frontend/Docs/Settings Panel.md
Outdated
| @@ -0,0 +1,71 @@ | |||
| # Front End Setting Panel | |||
|
|
|||
| With the new Pixel Streaming Front End, we've created a settings panel that allows you to adjust and change settings of your stream on the fly. | |||
There was a problem hiding this comment.
frontend instead of Front End - in this context it is understood to be correct usage
There was a problem hiding this comment.
It won't always be new.
I would prefer
The Pixel Streaming frontend contains a settings panel that allows you to configure your Pixel Streaming user experience as needed - whether that be toggling features or connecting to different signalling servers.
Frontend/Docs/Settings Panel.md
Outdated
| # Front End Setting Panel | ||
|
|
||
| With the new Pixel Streaming Front End, we've created a settings panel that allows you to adjust and change settings of your stream on the fly. | ||
| This page will be updated with new features and commands available. |
There was a problem hiding this comment.
This page will be updated with new features and commands available.
to
This page will be updated with new features and commands as they become available.
Frontend/Docs/Settings Panel.md
Outdated
| | **Signalling URL** | The URL of the signalling server. | | ||
| | **Streamer ID** | Allows you to select which streamer to stream. | | ||
| | **Auto connect to stream** | Browser will automatically connect to the stream when loaded. Prevents having to click to start | | ||
| | **Auto play video** | When stream is ready, starts playing video immediately instead of showing a play button. | |
There was a problem hiding this comment.
When stream is ready
to
When the stream is ready
Frontend/Docs/Settings Panel.md
Outdated
| | **Streamer ID** | Allows you to select which streamer to stream. | | ||
| | **Auto connect to stream** | Browser will automatically connect to the stream when loaded. Prevents having to click to start | | ||
| | **Auto play video** | When stream is ready, starts playing video immediately instead of showing a play button. | | ||
| | **Browser send offer** | The browser will start the WebRTC handshake instead of the Unreal Engine application. This is an advanced setting for people customising the front end. Primarily for backwards compatibility for 4.x versions of the engine. | |
There was a problem hiding this comment.
people -> users
front end -> frontend
Frontend/Docs/Settings Panel.md
Outdated
| | **Auto connect to stream** | Browser will automatically connect to the stream when loaded. Prevents having to click to start | | ||
| | **Auto play video** | When stream is ready, starts playing video immediately instead of showing a play button. | | ||
| | **Browser send offer** | The browser will start the WebRTC handshake instead of the Unreal Engine application. This is an advanced setting for people customising the front end. Primarily for backwards compatibility for 4.x versions of the engine. | | ||
| | **Use microphone** | Will start receiving audio input from your microphone and play it back through the stream. | |
There was a problem hiding this comment.
Will start receiving audio input from your microphone and transmit it to the Unreal Engine.
Frontend/Docs/Settings Panel.md
Outdated
| | **Auto play video** | When stream is ready, starts playing video immediately instead of showing a play button. | | ||
| | **Browser send offer** | The browser will start the WebRTC handshake instead of the Unreal Engine application. This is an advanced setting for people customising the front end. Primarily for backwards compatibility for 4.x versions of the engine. | | ||
| | **Use microphone** | Will start receiving audio input from your microphone and play it back through the stream. | | ||
| | **Start video muted** | Muted audio when stream starts | |
Frontend/Docs/Settings Panel.md
Outdated
| | **Browser send offer** | The browser will start the WebRTC handshake instead of the Unreal Engine application. This is an advanced setting for people customising the front end. Primarily for backwards compatibility for 4.x versions of the engine. | | ||
| | **Use microphone** | Will start receiving audio input from your microphone and play it back through the stream. | | ||
| | **Start video muted** | Muted audio when stream starts | | ||
| | **Prefer SFU** | Will attempt to use the Selective Forwarding Unit, will only work if you have one running. | |
There was a problem hiding this comment.
Will attempt to use the Selective Forwarding Unit, will only work if you have one running.
to
Will attempt to use the Selective Forwarding Unit (SFU), if you have one running.
Frontend/Docs/Settings Panel.md
Outdated
| ### UI | ||
| | **Setting** | **Description** | | ||
| | --- | --- | | ||
| | **Match viewport resolution** | Visualizes statistics about the connection between the browser and the Unreal Engine application. | |
There was a problem hiding this comment.
This text is wrong. Should be:
Resizes the Unreal Engine application resolution to match the browser's video element size.
There was a problem hiding this comment.
Ah! I did see this, missed fixing it sorry. Good catch.
Frontend/Docs/Settings Panel.md
Outdated
| | **Setting** | **Description** | | ||
| | --- | --- | | ||
| | **Match viewport resolution** | Visualizes statistics about the connection between the browser and the Unreal Engine application. | | ||
| | **Control scheme** | Will dictate if the stream captures your mouse or keeps it free. | |
There was a problem hiding this comment.
If the scheme is locked mouse the browser will use pointerlock to capture your mouse, whereas if the scheme is hovering mouse you will retain your OS/browser cursor.
Frontend/Docs/Settings Panel.md
Outdated
| | **Start video muted** | Muted audio when stream starts | | ||
| | **Prefer SFU** | Will attempt to use the Selective Forwarding Unit, will only work if you have one running. | | ||
| | **Is quality controller?** | Makes the encoder of the Pixel Streaming Plugin use the current browser connection to determine the bandwidth available, and therefore the quality of the stream encoding. **See notes below** | | ||
| | **Force mono audio** | Force browser to request mono audio in the SDP. | |
Frontend/Docs/Settings Panel.md
Outdated
| | --- | --- | | ||
| | **Show FPS** | Will display the current FPS | | ||
| | **Request Keyframe** | Will ask the stream for a keyframe. This is helpful if your stream is choppy and needs to catch up. | | ||
| | **Restart Stream** | Restarts the peer connection to the stream. Should be used if you change above settings to ensure they are applied. | |
There was a problem hiding this comment.
Restarts the stream by disconnecting and reconnecting the websocket connection.
Frontend/Docs/Settings Panel.md
Outdated
| ### Notes | ||
|
|
||
| **Quality Controller** | ||
| Although Pixel Streaming adapts the quality of the stream to match the available bandwidth, the video frames are only encoded once by the Pixel Streaming Plugin. That one encoding is used for all clients. Therefore, only one client connection can "own" the quality used for adaptive streaming. If the other clients have a much better connection to the server, they may end up seeing a lower quality stream than necessary. On the other hand, if other clients have a much worse connection to the server, they may end up with lag or jitter. |
There was a problem hiding this comment.
match the available bandwidth, when using H.264 the video frames
....
they may end up with lag or jitter. Note, this quality controller setting is completely irrelevant if you are streaming using any codec other than H.264 (such as VP8 or VP9).
Made proposed changes from Luke.
|
Made all proposed changes. Let me know if it's up to snuff! |
New page of control panel information.
Have taken the old information from the official documentation and updated it with all of the new + removed out of date elements.