This repository has been archived by the owner on Mar 1, 2024. It is now read-only.
Updating the Frontend Docs #152
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lukehb
suggested changes
Mar 15, 2023
lukehb
suggested changes
Mar 16, 2023
lukehb
reviewed
Mar 23, 2023
|
|
||
|
|
||
| ## Customising the Player Webpage | ||
| The Pixel Streaming Signaling and Web Server provides a sample player page that is already set up to stream in media from your Unreal Engine application and to send mouse, keyboard, and touch events back to the application. You can use this default player page as-is, if it meets your needs. |
There was a problem hiding this comment.
Signaling
to
Signalling
not sure why, but convention throughout source and docs is two l's
lukehb
reviewed
Mar 23, 2023
| For example, if you save a file to `Engine/Source/Programs/PixelStreaming/WebServers/SignallingWebServer/myfolder/myplayerpage.html`, and you set the `HomepageFile` parameter to `myfolder/myplayerpage.html`, the page would be accessible without needing to provide a file name in the URL: `http://127.0.0.1/`. | ||
| * You can create a new implementation page and place it in [`/Frontend/implementations/EpicGames/src/`](/Frontend/implementations/EpicGames/src) alongside the sample implementations. This must consist of both a base `.html` page and the `.ts` source for your application's entrypoint. This will then be accessible by appending the name of the `html` file to IP address or hostname of the computer running the Signalling Server. | ||
| For example, the sample `stresstest` page can be accessed on a locally-running infrastructure at `http:/127.0.0.1/stresstest.html`. | ||
| * You can customize the `HomepageFile` parameter for the Signaling and Web Server, and set the path to the filename of your custom HTML player page relative to the [Frontend implementations source folder](/Frontend/implementations/src). It will then be accessible when you access the IP address or hostname of the computer running the Signaling and Web Server. |
lukehb
suggested changes
Mar 23, 2023
Signed-off-by: Luke Bermingham <[email protected]>
lukehb
approved these changes
Mar 23, 2023
lukehb
added a commit
that referenced
this pull request
Mar 23, 2023
* Downgrade ts-jest and jest to support older Node version (#168) * Downgrade ts-jest and jest to support older Node version * bumbed ts-jest to 27.1.5 (latest 27.x.y) * Bump lib-pixelstreamingfrontend to 0.3.0 Signed-off-by: Luke Bermingham <[email protected]> * Bump lib-pixelstreamingfrontend-ui to 0.2.0 update dep versions Signed-off-by: Luke Bermingham <[email protected]> * Bump versions in package-lock.json for ui-library * Bump ui-library to 0.2.0 and force NPM publish * Update UE version printed when Cirrus starts Signed-off-by: Luke Bermingham <[email protected]> * Bump Github release of 5.2 infra to 0.4.0 Signed-off-by: Luke Bermingham <[email protected]> * Fix: sfu player would try subscribing when sfu disconnected * Updating the Frontend Docs (#152) --------- Signed-off-by: Luke Bermingham <[email protected]> Co-authored-by: hmuurine <[email protected]> Co-authored-by: William Belcher <[email protected]> Co-authored-by: Michael Stopa <[email protected]>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Not ready for merging yet (not for a little while yet). Preliminary pull request made so there's somewhere for review feedback to live.
Resolves #98