Pixel Streaming in Editor

Pixel Streaming Toolbar

The Pixel Streaming toolbar is your go to menu for controlling Pixel Streaming within the editor.

To access the Pixel Streaming toolbar, ensure you have the Pixel Streaming plugin enabled.

Use Remote Signalling Server

Toggling this option stops the editor from creating an embedded signalling server when you use the Level and Full editor streaming options. You will have to manually launch a signalling server external to the editor and specify its URL. The default values should be sufficient in most use cases however.

Embedded Signalling Server Options

These values specify the ports of the embedded signalling server that's created when you use the editor streaming functions. Unless you specifically need to change these, the default values should cover most use cases.

Virtual Camera

The virtual camera is a new experimental feature added to Pixel Streaming. For more detail on how to use this feature, please refer to the Virtual Camera page.

Codecs

These options will specify what encoder your stream will use. For more information about each codec as well as comparisons, please read refer to the Support Codecs page.

Editor Streaming

Editor streaming allows you to stream the Unreal Engine editor to any browsers, including mobile devices. This opens new potential for remote interaction with the editor as well as providing security benefits and enabling a new way for users to collaborate. Furthermore, eliminating the need to run the hardware locally can open up new, efficient work pipelines.

Editor streaming leverages the base Pixel Streaming module, meaning users who are familiar with Pixel Streaming their applications will feel right at home with editor streaming.

How do I use it?

Editor streaming is designed to be as easy to use as possible. To start editor streaming:

1. Ensure you have the Pixel Streaming plugin enabled.

   

2. Once the editor restarts, you'll notice a new "Pixel Streaming" menu on your toolbar.

   

3. Open up the menu and click "Stream Full Editor".

   

4. Voila! Your editor is now being streamed. Open a browser and navigate to your public IP (127.0.0.1 works for testing a local stream)

   

5. Open up the toolbar again and you'll notice a few IPs that you may be able to access your stream from (network configuration permitting)

   

The above mentioned steps will launch a signaling server that's embedded within the Unreal Engine. For users who are more familiar with a workflow in which they launch the signaling server found in the "PixelStreamingInfrastructure" repo (found here), simply check the "Use Remote Signaling Server" check box and enter the IP address of this signaling server before beginning streaming.

How do I stream my editor in the cloud?

Streaming the editor from a cloud instance can be achieved in much the same manner as streaming your regular pixel streamed applications, albeit with a few minor modifications:

• If you're application launch args contains: -res=1920x1080 or similar, you'll want to replace this with -EditorPixelStreamingRes=1920x1080
• If you're application launch args contains: -resx=1920 -resy=1080 or similar, you'll want to replace this with -EditorPixelStreamingResX=1920 -EditorPixelStreamingResY=1080
• If you're application launch args contains: -renderoffscreen, you'll want to add -EditorPixelStreamingStartOnLaunch=true to start streaming without needing to interact with the toolbar
• If you wish to use a signaling server that isn't the server embedded within the engine, you'll want to add -EditorPixelStreamingUseRemoteSignallingServer=true
• An example of what your final command will look like is: Engine\Binaries\Win64\UnrealEditor-Cmd.exe -project Path\To\Your\Project.uproject -RenderOffscreen -EditorPixelStreamingRes=1920x1080 -EditorPixelStreamingStartOnLaunch=true -PixelStreamingURL=ws://127.0.0.1:8888

Editor streaming when rendering off screen is currently experimental and may be unstable.

Stream Level Editor

Alongside full editor streaming, we've also added the option to exclusively stream the level viewport of the editor. With only the level viewport streamed, connected peers will not see any surrounding elements, including but not limited to the outliner, content browser and any and all pop up menus.

To use level streaming, simply select "Stream Level Editor" from the toolbar option instead of "Stream Full Editor"