Reference

SPS frontend

Overview

The Scalable Pixel Streaming Frontend is a library of HTML, CSS and TypeScript code that runs in client web browsers to enable users to connect to Scalable Pixel Streaming applications and interact with them. The Scalable Pixel Streaming Frontend can also be consumed via Github or as an NPM Package.

Utilising the Scalable Pixel Streaming Frontend

Utilising the Scalable Pixel Streaming Frontend page covers the concepts around installing, consuming and modifying the Scalable Pixel Streaming Frontend. Currently the Scalable Pixel Streaming Frontend can be consumed by forking the Github Repo or by consuming the NPM package. As the Scalable Pixel Streaming Frontend consumes the Epic Games Pixel Streaming Frontend, we also include examples of how to use and extend their library for use with the Scalable Pixel Streaming frontend and links to the Epic Games documentation.

Migrating from Scalable Pixel Streaming Frontend

Migrating from Scalable Pixel Streaming Frontend page explains how to upgrade to the Scalable Pixel Streaming Frontend 0.2.0 from earlier versions. It covers the API changes that the Scalable Pixel Streaming Frontend has undergone and how to make use of them. API topics include:

• Listening for UE messages;
• Sending messages to UE;
• Listen for the WebRTC stream to start.

Scalable Pixel Streaming Frontend Reference section

Scalable Pixel Streaming Frontend Reference page covers reference material that is useful to understand the broader concepts of the Scalable Pixel Streaming Frontend, such as the Scalable Pixel Streaming life cycle.