CHANGELOG.md

Pixel Streaming Infrastructure Changelog

The changelog is a summary of commits between releases of Unreal Engine.

As a reminder each UE-X branch/tag in this repository corresponds to a version of Unreal Engine.

UE 5.4 (Current)

Features

• Add support for non-latin characters by @Belchy06 in EpicGames/PixelStreamingInfrastructure#452
• Adding an option to hide the UI. by @mcottontensor in #88

Enhancements

• Updating NPM libs to 5.4 by @mcottontensor in EpicGames/PixelStreamingInfrastructure#362
• Update SignallingWebServer platform scripts to support Mac by @Belchy06 in EpicGames/PixelStreamingInfrastructure#389
• Expose JSS InsertionPoint (#390) by @timbotimbo in EpicGames/PixelStreamingInfrastructure#397
• Fix/allow video autoplay without click by @bramford in EpicGames/PixelStreamingInfrastructure#409
• Removing authentication features. by @mcottontensor in EpicGames/PixelStreamingInfrastructure#414
• Fixes for Streamers changing IDs when connecting & Updates to SFU behaviour relating to multi streamer changes. by @mcottontensor in EpicGames/PixelStreamingInfrastructure#416
• Rewriting a bunch of reconnect and disconnect handling. by @mcottontensor in EpicGames/PixelStreamingInfrastructure#419
• Exposing the pixelstreaming interface to the browser. by @mcottontensor in EpicGames/PixelStreamingInfrastructure#420
• Bitrate negotiation on stream startup by @mcottontensor in EpicGames/PixelStreamingInfrastructure#425
• Dockerfile for SFU by @mcottontensor in EpicGames/PixelStreamingInfrastructure#431
• Remove auto-assigned prop by @evenstensberg in EpicGames/PixelStreamingInfrastructure#434
• Update cirrus.js - More informative error messages - Fixes #184 by @alien299 in EpicGames/PixelStreamingInfrastructure#441
• Re-order settings order by @Belchy06 in EpicGames/PixelStreamingInfrastructure#471
• Add TCP+Relay detection event by @david-macpherson in EpicGames/PixelStreamingInfrastructure#485

Documentation

• Shift of Matchmaker and SFU pages to Infra by @MWillWallT in EpicGames/PixelStreamingInfrastructure#361
• New docs by @mcottontensor in EpicGames/PixelStreamingInfrastructure#429
• Update CONTRIBUTING.md - Added Verified Commits as a Requirement - Closes#445 by @alien299 in EpicGames/PixelStreamingInfrastructure#448
• Update copyright/license year by @DenisTensorWorks in EpicGames/PixelStreamingInfrastructure#474
• Fix typo readme by @Ahhj93 in EpicGames/PixelStreamingInfrastructure#488

Bug Fixes

• Bug fix to retrieve the correct selected ice candidate pair by @david-macpherson in #25
• Added SDP for probator by @zuvola in #86
• Remove unit conversion for bitrate from URL. URL is already in kbps (#369) by @Belchy06 in EpicGames/PixelStreamingInfrastructure#372
• Handle statsPanel or settingsPanel being undefined. (#392) by @timbotimbo in EpicGames/PixelStreamingInfrastructure#394
• Allowing the Matchmaker to run on linux by @mcottontensor in EpicGames/PixelStreamingInfrastructure#406
• Fixing missed function rename. by @mcottontensor in EpicGames/PixelStreamingInfrastructure#427
• Update platform scripts so that the BASH_LOCATION works on Mac as well by @Belchy06 in EpicGames/PixelStreamingInfrastructure#428
• Fixing left behind streamer IDs when they're late to ID themselves. by @mcottontensor in EpicGames/PixelStreamingInfrastructure#432
• Fixing handling of StreamerId in the initial config settings. by @mcottontensor in EpicGames/PixelStreamingInfrastructure#438
• Small signalling server fixes. by @mcottontensor in EpicGames/PixelStreamingInfrastructure#443
• Fix warnings about GamepadButtonReleased by @Belchy06 in EpicGames/PixelStreamingInfrastructure#451
• Fix for build-all script dependencies by @kroecks in EpicGames/PixelStreamingInfrastructure#453
• Export NO_SUDO so it's available for use in launched processes by @Belchy06 in EpicGames/PixelStreamingInfrastructure#472
• Fix touch events not working on iOS by @Belchy06 in EpicGames/PixelStreamingInfrastructure#486
• Bug Fix TCP Relay event to only be emitted once by @david-macpherson in EpicGames/PixelStreamingInfrastructure#490

Security

• Bump webpack-dev-middleware from 5.3.3 to 5.3.4 in /Frontend/implementations/typescript by @dependabot in #37
• Bump webpack-dev-middleware from 5.3.3 to 5.3.4 in /Frontend/implementations/react by @dependabot in #39
• Bump follow-redirects from 1.15.4 to 1.15.6 in /Frontend/implementations/typescript by @dependabot in #41
• Bump follow-redirects from 1.15.4 to 1.15.6 in /Frontend/implementations/react by @dependabot in #43
• Bump express from 4.18.2 to 4.19.2 in /SignallingWebServer by @dependabot in #65
• Bump express from 4.18.2 to 4.19.2 in /Matchmaker by @dependabot in #70
• Bump express in from 4.18.2 to 4.19.2 /Frontend/implementations/typescript by @dependabot in #73
• Bump express from 4.18.2 to 4.19.2 in /Frontend/implementations/react by @dependabot in #79
• Bump postcss from 8.4.21 to 8.4.31 in /Frontend/implementations/typescript (#380) by @dependabot in EpicGames/PixelStreamingInfrastructure#383
• Bump postcss from 8.4.21 to 8.4.31 in /Frontend/implementations/react (#379) by @dependabot in EpicGames/PixelStreamingInfrastructure#386
• Bump @babel/traverse from 7.21.3 to 7.23.2 in /Frontend/library (#384) by @dependabot in EpicGames/PixelStreamingInfrastructure#388
• Bump follow-redirects from 1.15.2 to 1.15.4 in /Frontend/implementations/typescript by @dependabot in EpicGames/PixelStreamingInfrastructure#465
• Bump follow-redirects from 1.15.2 to 1.15.4 in /Frontend/implementations/react by @dependabot in EpicGames/PixelStreamingInfrastructure#464

UE 5.3

Features

• Protocol structures can now contain strings by @Belchy06 in EpicGames/PixelStreamingInfrastructure#336
• Added the ability for the frontend peer to auto connect when a new streamer is available by @mcottontensor in EpicGames/PixelStreamingInfrastructure#358

Enhancements

• Upgrade 5.2 to 5.3 in libraries, docs, log messages, build pipelines by @lukehb in EpicGames/PixelStreamingInfrastructure#262
• Include create, reconnect, and update events (with associated tests) by @jibranabsarulislam in EpicGames/PixelStreamingInfrastructure#273
• Add github action for PR and Issue management by @Belchy06 in EpicGames/PixelStreamingInfrastructure#304
• Update stale.yml by @Belchy06 in EpicGames/PixelStreamingInfrastructure#305
• Update stale workflow to also auto close stale issues and PRs by @Belchy06 in EpicGames/PixelStreamingInfrastructure#306
• Show player count in stats panel by @Belchy06 in EpicGames/PixelStreamingInfrastructure#303
• Change implementations/EpicGames to implementations/typescript #166 by @gunsha in EpicGames/PixelStreamingInfrastructure#177
• Refactor SignallingWebServer to a single docker file by @Belchy06 in EpicGames/PixelStreamingInfrastructure#337
• Update LatencyTest handler to accept input data by @Belchy06 in EpicGames/PixelStreamingInfrastructure#340
• Add contribution guideline CONTRIBUTING.md by @DenisTensorWorks in EpicGames/PixelStreamingInfrastructure#352
• New matchmaker queue screen with easy customization by @kasp1 in EpicGames/PixelStreamingInfrastructure#211
• Updated CONTRIBUTING.md with backport rules by @Belchy06 in EpicGames/PixelStreamingInfrastructure#357

Documentation

• Signaling message reference doc by @mcottontensor in EpicGames/PixelStreamingInfrastructure#271
• Update SignallingProtocol.md by @mcottontensor in EpicGames/PixelStreamingInfrastructure#288

Bug fixes

• Fixed auto reconnect to not reconnect when the page is refreshed. by @mcottontensor in EpicGames/PixelStreamingInfrastructure#285
• Fixed iOS touch when settings panel is open by @Belchy06 in EpicGames/PixelStreamingInfrastructure#274
• Fixed Firefox console errors TypeError: this.preferredCodec.split is not a function by @Belchy06 in EpicGames/PixelStreamingInfrastructure#310
• Fixed ensuring touch is relative to absolute location of parent rect by @StomyPX in EpicGames/PixelStreamingInfrastructure#316
• Fixed injecting new params into SDP to get stereo back on Chrome by @StomyPX in EpicGames/PixelStreamingInfrastructure#332
• Fixed matchmaker asking for OS authentication instead of erroring out with EACCESS by @StomyPX in EpicGames/PixelStreamingInfrastructure#333
• Fixed consuming the context menu event instead of sending a mouse up by @StomyPX in EpicGames/PixelStreamingInfrastructure#354

Security

• Bump tough-cookie from 4.1.2 to 4.1.3 in /Frontend/library by @dependabot in EpicGames/PixelStreamingInfrastructure#290
• Bump word-wrap from 1.2.3 to 1.2.4 in /Frontend/library by @dependabot in EpicGames/PixelStreamingInfrastructure#320
• Bump word-wrap from 1.2.3 to 1.2.5 in /Frontend/ui-library by @dependabot in EpicGames/PixelStreamingInfrastructure#327
• Bump Node.js to latest LTS by @StomyPX in EpicGames/PixelStreamingInfrastructure#321

UE 5.2

Features

• Added minimal sample React implementation by @hmuurine in EpicGames/PixelStreamingInfrastructure#159
• Added a new frontend for the Pixel Streaming Demo showcase project by @lukehb in EpicGames/PixelStreamingInfrastructure#158
• Added multiple streamer support by @mcottontensor in EpicGames/PixelStreamingInfrastructure#74
• Added DefaultToHover being parsed as a config option in InitialSettings message by @StomyPX in EpicGames/PixelStreamingInfrastructure#68
• Added indication to the signalling server when the browser intends to send the offer by @Belchy06 in EpicGames/PixelStreamingInfrastructure#75
• Added experimental support for WebXR based experiences by @Belchy06 in EpicGames/PixelStreamingInfrastructure#85

Docs

• New general docs page/ToC + new security page. by @MWillWallT in EpicGames/PixelStreamingInfrastructure#254
• Update README to mention container images require being part of Epic's Github org by @mcottontensor in EpicGames/PixelStreamingInfrastructure#248
• Update platform_scripts readme.md to explain the different scripts by @lukehb in EpicGames/PixelStreamingInfrastructure#224
• Improve signalling Server readme @DenisTensorWorks in EpicGames/PixelStreamingInfrastructure#223
• Adding microphone feature documentation for UE5.2 by @DenisTensorWorks in EpicGames/PixelStreamingInfrastructure#228
• Adding microphone feature documentation by @DenisTensorWorks in EpicGames/PixelStreamingInfrastructure#208
• Added new general docs page/ToC + new security page. by @MWillWallT in EpicGames/PixelStreamingInfrastructure#254
• Settings Panel Documentation by @MWillWallT in EpicGames/PixelStreamingInfrastructure#135
• Customised Pixel Streaming Player Page by @MWillWallT in EpicGames/PixelStreamingInfrastructure#90
• Updated Signalling Server docs by @DenisTensorWorks in EpicGames/PixelStreamingInfrastructure#223
• Updated docs for frontend for settings and TURN by @lukehb in EpicGames/PixelStreamingInfrastructure#224
• Adding docs for microphone feature by @DenisTensorWorks in EpicGames/PixelStreamingInfrastructure#228
• Updated README to mention container images require being part of Epic's Github org by @mcottontensor in EpicGames/PixelStreamingInfrastructure#248
• Updated the Frontend Docs to move some material from UE docs official to this repo by @StomyPX in EpicGames/PixelStreamingInfrastructure#152
• Update Docs to remove broken links by @Belchy06 in EpicGames/PixelStreamingInfrastructure#122

Enhancements

• Add repository health status in the form of Github badges table on readme.md by @lukehb in EpicGames/PixelStreamingInfrastructure#265
• Re-enable iOS and iPadOS fullscreen by @Belchy06 in EpicGames/PixelStreamingInfrastructure#266
• Changed forwarded logs to Cyan, added warning for missing playerId by @StomyPX in EpicGames/PixelStreamingInfrastructure#253
• Added "media-playout" to prevent spam in Aggregated Stats by @chasse20 in EpicGames/PixelStreamingInfrastructure#232
• Added 'stat PixelStreamingGraphs' to showcase frontend #229 by @devrajgadhvi in EpicGames/PixelStreamingInfrastructure#238
• Bump socket.io-parser from 4.2.2 to 4.2.4 in /Matchmaker by @dependabot in EpicGames/PixelStreamingInfrastructure#244
• Bump engine.io from 6.4.0 to 6.4.2 in /Matchmaker by @mcottontensor in EpicGames/PixelStreamingInfrastructure#220
• Allow inheritance of webrtcPlayerController and webXrController by @Belchy06 in EpicGames/PixelStreamingInfrastructure#209
• Pass command line args when calling run_local.bat by @lukehb in EpicGames/PixelStreamingInfrastructure#109
• Customize frontend styles through UI API by @hmuurine in EpicGames/PixelStreamingInfrastructure#133
• Force URL param settings when receiving initial application settings by @Belchy06 in EpicGames/PixelStreamingInfrastructure#134
• Added ability to pass HTTPS certificate locations via Cirrus configuration by @marcinbiegun in EpicGames/PixelStreamingInfrastructure#149
• Added unit tests for library by @hmuurine in EpicGames/PixelStreamingInfrastructure#156
• Converted frontend javascript to typescript and refactor. by @lukehb in EpicGames/PixelStreamingInfrastructure#63
• Removed useless code, make code style more consistent by @Senseme in EpicGames/PixelStreamingInfrastructure#59
• Multi-streamer QOL improvements by @Belchy06 in EpicGames/PixelStreamingInfrastructure#88
• Removing the player id from forwarded messages by @mcottontensor in EpicGames/PixelStreamingInfrastructure#91
• Added a QOL message when multiple streamers are detected by @Belchy06 in EpicGames/PixelStreamingInfrastructure#94
• Added dev and prod configs to webpack by @lukehb in EpicGames/PixelStreamingInfrastructure#102
• Added github actions to create an NPM package for frontend library and make a release for the repo by @lukehb in EpicGames/PixelStreamingInfrastructure#103
• Neaten up install scripts by @Belchy06 in EpicGames/PixelStreamingInfrastructure#106
• Added 'stat PixelStreamingGraphs' to showcase frontend #229 by @devrajgadhvi in EpicGames/PixelStreamingInfrastructure#238
• Changed forwarded logs to Cyan, added warning for missing playerId by @StomyPX in EpicGames/PixelStreamingInfrastructure#253
• Allow inheritance of webrtcPlayerController and webXrController by @Belchy06 in EpicGames/PixelStreamingInfrastructure#209
• Alter reconnection flow to request streamer message list and fail out after N attempts. by @Belchy06 in EpicGames/PixelStreamingInfrastructure#195
• Added exports for UI configuration types by @kass-kass in EpicGames/PixelStreamingInfrastructure#193
• Added ability to optionally disable certain frontend elements by @kass-kass in EpicGames/PixelStreamingInfrastructure#161
• Added support for programmatically changing peer layers when using the SFU by @Belchy06 in EpicGames/PixelStreamingInfrastructure#179
• Improved frontend API support for UE communication by @hmuurine in EpicGames/PixelStreamingInfrastructure#132
• Added ability in frontend to Enable/disable user input devices by @hmuurine in EpicGames/PixelStreamingInfrastructure#136
• Exposed websocketController and webXRController to public API by @lukehb in EpicGames/PixelStreamingInfrastructure#124
• Added XR events: xrSessionStarted, xrSessionEnded, xrFrame by @lukehb in EpicGames/PixelStreamingInfrastructure#125
• Decouple UI from the frontend library by @hmuurine in EpicGames/PixelStreamingInfrastructure#110
• Replaced hardcoded log path with given parameter path by @Mirmidion in EpicGames/PixelStreamingInfrastructure#39

Bug fixes

• Fixed viewport resizing not always working due to improperly calling timer. by @mcottontensor in EpicGames/PixelStreamingInfrastructure#247
• Fixed hovering mouse mode set in URL being overridden on refresh. by @mcottontensor in EpicGames/PixelStreamingInfrastructure#246
• Fixed matchmaker directing users to http when the signalling server is using https by @mcottontensor in EpicGames/PixelStreamingInfrastructure#245
• Fixed reconnects will be attempted even when a disconnect is triggered by afk timeout by @Belchy06 in EpicGames/PixelStreamingInfrastructure#215
• Fixed datachannels not working when using the SFU by @mcottontensor in EpicGames/PixelStreamingInfrastructure#137
• Fixed SFU having clashing datachannel/stream ids, now using mediasoup's internal stream ids for SCTP by @StomyPX in EpicGames/PixelStreamingInfrastructure#129
• Fixed controller indices from multiple peers would clash by @Belchy06 in EpicGames/PixelStreamingInfrastructure#165
• Fixed Connecting to Unreal 5.1 app with the 5.2 frontend crashes on connect by @Belchy06 in EpicGames/PixelStreamingInfrastructure#180
• Fixed sfu player would try subscribing when sfu disconnected by @Belchy06 in EpicGames/PixelStreamingInfrastructure#172
• Fixed bug where stress tester would leave orphaned Pixel Streaming connections by @lukehb in EpicGames/PixelStreamingInfrastructure#185
• Fixed bug where reconnects were being attempted even when a disconnect is triggered by afk timeout by @Belchy06 in EpicGames/PixelStreamingInfrastructure#215
• Fixed viewport resizing not always working due to improperly calling timer. by @mcottontensor in EpicGames/PixelStreamingInfrastructure#247
• Fixed log spam caused by missing "media-playout" in Aggregated Stats by @chasse20 in EpicGames/PixelStreamingInfrastructure#232
• Fixed hovering mouse mode set in URL being overridden on refresh. by @mcottontensor in EpicGames/PixelStreamingInfrastructure#246
• Fixed matchmaker directing users to http when the signalling server is using https by @mcottontensor in EpicGames/PixelStreamingInfrastructure#245
• Fixed frontend library not building on Linux due to incorrect casing by @StomyPX in EpicGames/PixelStreamingInfrastructure#96
• Fixed SFU peer datachannels aren't being created by @Belchy06 in EpicGames/PixelStreamingInfrastructure#95 and EpicGames/PixelStreamingInfrastructure#97
• Fixed crash on browsers where the xr object wasn't on the navigator by @Belchy06 in EpicGames/PixelStreamingInfrastructure#93
• Fixed Preferred codec selector causes no stream if application launched without -PixelStreamingNegotiateCodecs by @Belchy06 in EpicGames/PixelStreamingInfrastructure#83
• Fixed adding the rest of the browsers supported codecs after setting the preferred codec (#83) by @lukehb in EpicGames/PixelStreamingInfrastructure#84
• Fixed delayed mic input by @Belchy06 in EpicGames/PixelStreamingInfrastructure#77 and @lukehb in EpicGames/PixelStreamingInfrastructure#78
• Fixed syntax error by @mcianni in EpicGames/PixelStreamingInfrastructure#44
• Fixed check if KeyboardEvent.keyCode deprecated then use KeyboardEvent.code + mapping instead. by @lukehb in EpicGames/PixelStreamingInfrastructure#48
• Fixed bug when negating property in and removing duplicate property by @lukehb in EpicGames/PixelStreamingInfrastructure#49
• Fixed incorrect login page path when using authentication by @Belchy06 in EpicGames/PixelStreamingInfrastructure#55
• Fixed handling of "defaultToHover" field in offer by @StomyPX in EpicGames/PixelStreamingInfrastructure#60
• Fixed Pixel Streaming session disconnecting entirely when using the new frontend by @hmuurine in EpicGames/PixelStreamingInfrastructure#141
• Fixed input would not entirely unregister when using the new frontend by @lukehb in EpicGames/PixelStreamingInfrastructure#144
• Fixed frontend not working with older NodeJS versions due ts-jest and jest by @hmuurine in EpicGames/PixelStreamingInfrastructure#168
• Fixed webpack was double bundling frontend lib into the final bundle (#117) by @lukehb in EpicGames/PixelStreamingInfrastructure#118 @hmuurine in EpicGames/PixelStreamingInfrastructure#117
• Fixed cirrus Dockerfile that resulting in a non-functional signalling server by @Belchy06 in EpicGames/PixelStreamingInfrastructure#123

Security

• Various security updates by @mcottontensor in EpicGames/PixelStreamingInfrastructure#220
• Security updates for default turn server configuration. by @gingernaz in EpicGames/PixelStreamingInfrastructure#196
• Bumped qs and express in /SignallingWebServer by @dependabot in EpicGames/PixelStreamingInfrastructure#69
• Bumped qs and express in /Matchmaker by @dependabot in EpicGames/PixelStreamingInfrastructure#70
• Bumped passport from 0.4.1 to 0.6.0 in /SignallingWebServer by @dependabot in EpicGames/PixelStreamingInfrastructure#71
• Bumped engine.io and socket.io in /Matchmaker by @dependabot in EpicGames/PixelStreamingInfrastructure#72
• Bumped socket.io-parser from 4.2.2 to 4.2.4 in /Matchmaker by @dependabot in EpicGames/PixelStreamingInfrastructure#244
• Fixed insufficient validation when decoding a Socket packet by @iot-defcon
• @ CVE-2022-25896 by @mik-patient in EpicGames/PixelStreamingInfrastructure#35
• Bump webpack from 5.75.0 to 5.76.0 in /Frontend/library by @dependabot in EpicGames/PixelStreamingInfrastructure#153
• Bump webpack from 5.75.0 to 5.76.0 in /Frontend/ui-library by @dependabot in EpicGames/PixelStreamingInfrastructure#155
• Bump webpack from 5.75.0 to 5.76.0 in /Frontend/implementations/EpicGames by @dependabot in EpicGames/PixelStreamingInfrastructure#154
• Fixing security warnings. by @mcottontensor in EpicGames/PixelStreamingInfrastructure#163
• Moved all package.json under @epicgames-ps scope to avoid package confusion by @lukehb in EpicGames/PixelStreamingInfrastructure#187

UE 5.1

Bug fixes

• 3b1b84 Fix black screen flickering when receiving freeze frames.
• 853625 Fix CSS to show AFK overlay.
• c897e1 Fix pointerlock errors on platforms like iOS where it doesn't exist.

Features

• 980208 Add handling for mouse double click.
• 6b8f31 Expose freeze frame delay as a configurable option.
• fe5c4c Added Dockerfile for the 5.1 Signalling Server container.

UE 5.0

Bug fixes

• 3d641a Fixed MatchViewportWidth not working if toggled repeatedly.
• ca6644 Fix controller button messages not being sent.
• bb4063 Fix missing let in loops.
• b59bfb Fix removeResponseEventListener using remove instead of delete.
• 4fee8a Fix missing initialization for unquantizeAndDenormalizeUnsigned.
• 42fa91 Move to standardized onwheel browser event.

Features

• b23cba Added a MaxPlayerCount configuration option to the signalling server to restrict participant numbers (default -1: no upper limit).
• e46c4d Added support for handling websocket messages sent as binary.
• 616f07 Added offerToReceive toggle/flag to indicate browser should/or should not make the SDP offer.
• 845ab1 Added ability to send handle a "input protocol", which is a protocol specification for data channel messages sent by the UE side. This allows the frontend need no extra handling to support custom data channel messages (of course the user must still bind a handler if they wish to do anything with the message).
• 1c1fe0 Added ability to request keyframes on the frontend.

UE 4.27 (End of life)

Backported 5.0 frontend to support 4.27:

• Removed SFU support as this is not supported in 4.27.
• Ignore playerConnected message as not supported in 4.27.
• Force frontend to generate the WebRTC offer as 4.27 expects this.

UE 4.26 (Unsupported)

Backported 5.0 frontend to support 4.26:

• Removed SFU support as this is not supported in 4.26.
• Ignore playerConnected message as not supported in 4.26.
• Force frontend to generate the WebRTC offer as 4.26 expects this.
• Remove Linux scripts as Linux Pixel Streaming was not supported in 4.26.
• Force the removal of extmap-allow-mixed from the SDP as WebRTC version UE used in 4.26 did not support it.

Previous versions

Versions prior to UE 4.26 are not tracked here as this repository has never supported those versions.