/Frontend

Web frontend for Scalable Pixel Streaming

Primary LanguageTypeScriptMIT LicenseMIT

Scalable Pixel Streaming Frontend

This is the web frontend for Scalable Pixel Streaming (SPS).

The SPS frontend is a lightweight 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.
  • The sending of streaming statistics to our signalling server.

Documentation

Utilising the Scalable Pixel Streaming Frontend

Below is a comprehensive guide for accessing the Scalable Pixel Streaming Frontend. This guide includes where to download the library, how to consume it and how to customise it for usage in different projects.

Migrating from Scalable Pixel Streaming Frontend

In general, the official Epic Games Pixel Streaming Frontend docs should cover most common usage cases (as our library is simply a thin wrapper on that). However, some Scalable Pixel Streaming Frontend specific docs are listed below:

Scalable Pixel Streaming Frontend Reference section

The Scalable Pixel Streaming Frontend is a part of a complex system which abstracts a lot of its complexities behind the library. Below is a useful collection of references which explain how the Scalable Pixel Streaming Frontend fits within Scalable Pixel Streaming as a whole.

Issues

As the SPS frontend is a lightweight implementation of the Epic Games frontend, the majority of issues should be reported to the Epic Games frontend here.

However, in cases where you are certain it is an SPS specific frontend issue, please report your issue here.

Legal

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