repository·master·Indexed 19 days ago
https://github.com/epicgames/pixelstreaminginfrastructureServers (Signalling Web Server, SFU) and frontend libraries (WebRTC players, UI components) used to stream Unreal Engine applications to web browsers via WebRTC. Includes the @epicgames-ps/lib-pixelstreamingcommon-ue5.5 package for shared logic, messaging, transport, and the Signalling Protocol.
The lib-pixelstreamingfrontend-ui library provides ready-to-use UI components that extend the core lib-pixelstreamingfrontend library. It includes:
The JavaScript Streamer is a functional, drop-in replacement for an Unreal Engine Pixel Streaming application instance. It is designed to run entirely in the browser without requiring a GPU or any Unreal Engine dependencies.
It serves two primary purposes:
The @epicgames-ps/lib-pixelstreamingsignalling-ue5.5 package provides the core signalling logic for Pixel Streaming. It manages the communication between the Streamer (Unreal Engine instance), the SFU (Selective Forwarding Unit), and the Players.
Key functional modules include:
PlayerRegistry component is part of the @epicgames-ps/lib-pixelstreamingsignalling-ue5.5 package. It is responsible for managing and tracking active players within the signalling infrastructure. It utilizes the IPlayer and IPlayerInfo interfaces to define the structure of player data and state.@epicgames-ps/lib-pixelstreamingcommon-ue5.5 package provides the core shared logic and abstractions used across the Pixel Streaming infrastructure. It contains fundamental building blocks for messaging, transport, logging, and protocol management that ensure consistency between different components of the streaming stack.The lib-pixelstreamingcommon library provides shared core functionality used across Pixel Streaming web applications. It includes implementations for:
For practical implementation examples, you can refer to the following reference projects within this repository:
lib-pixelstreamingfrontend (Frontend library)lib-pixelstreamingsignalling (Signalling library)Wilbur (The reference Pixel Streaming signalling server)LoggingUtils is a utility module within the @epicgames-ps/lib-pixelstreamingsignalling-ue5.5 package designed to handle logging for signaling messages. It provides standardized interfaces and functions to log incoming, outgoing, and forwarded messages, which is useful for debugging signaling flows in Pixel Streaming infrastructure.The pixelstreamingsignalling package provides the core logic for managing Pixel Streaming signalling, including server management, player registries, streamer registries, and logging utilities.
Key components include:
SignallingServer for managing connections, WebServer for handling HTTP requests, and SFUConnection for Selective Forwarding Unit logic.PlayerRegistry to track connected players and StreamerRegistry to track available streamers.PlayerConnection and StreamerConnection to manage individual session lifecycles.Logger, InitLogging, and specialized functions like logIncoming, logOutgoing, and logForward for monitoring protocol traffic.The @epicgames-ps/lib-pixelstreamingfrontend-ue5.8 library provides the low-level logic required for a Pixel Streaming client-side experience. It is a headless library and contains no UI components.
Key capabilities include:
The @epicgames-ps/lib-pixelstreamingsignalling library is intended for developers building tools and applications that need to implement signaling for Pixel Streaming applications.
For high-level usage (running a signaling server rather than building tools with the library), refer to the Getting Started guide in the main repository.
The reference frontend provides a complete Pixel Streaming experience including: