david-macpherson / frontend

Web frontend for Scalable Pixel Streaming

Scalable Pixel Streaming frontend

This repository contains the web frontend for Scalable Pixel Streaming (SPS), which is a lightweight wrapper implementation of Epic Games Pixel Streaming frontend.

Features of the SPS frontend

• Extensions to the default signalling messages to communicate with our custom signalling server.
• Streaming statistics are being sent to our signalling server.

Documentation

Utilising the Scalable Pixel Streaming Frontend

Refer to our Scalable Pixel Streaming frontend utilisation guide for accessing the Scalable Pixel Streaming frontend, downloading the library, consuming it, and customising it for usage in different projects.

Migrating legacy Scalable Pixel Streaming frontend

All SPS versions since v0.1.4 are using the current version of Epic Games Pixel Streaming frontend. Refer to our migration guide if your frontend predates this version.

Scalable Pixel Streaming frontend reference

The Scalable Pixel Streaming frontend is part of a complex system that abstracts a lot of its complexities behind the library. Refer to our reference guide to gain a deeper understanding of how the SPS frontend fits within Scalable Pixel Streaming as a whole.

Issues

As the SPS frontend is an implementation of the Epic Games Pixel Streaming frontend, the majority of issues will pertain to the Epic Games frontend and should be reported on their repository.

If you encounter an issue specific to the SPS implementation, please report it here.

Legal

Copyright © 2021 - 2024, TensorWorks Pty Ltd. Licensed under the MIT License, see the license file for details.