Pixel Streaming WebSDK

Welcome to the @arcware-cloud/pixelstreaming-websdk, a robust solution tailored for integrating Unreal Engine's Pixel Streaming technology into web applications via Arcware Cloud.

The Arcware Pixel Streaming WebSDK is a JavaScript library that simplifies integrating Unreal Engine Pixel Streaming applications into web applications.

It builds on top of Epic Games’ Pixel Streaming frontend and adds features, improvements, and utilities tailored for the Arcware Cloud platform, while still allowing flexible integration into modern web applications.

The SDK handles the complexity of connecting to a Pixel Streaming session, managing WebRTC communication, and forwarding user input to the Unreal Engine application.

---

What the WebSDK Provides

The WebSDK provides a high-level interface for interacting with Pixel Streaming sessions and includes built-in support for:

• Video and audio streaming from Unreal Engine

• Keyboard, mouse, touch, and gamepad input forwarding

• Microphone input

• VR / WebXR support

• Session persistence and reconnection handling

• Framework-agnostic integration

• Built-in UI components or fully custom integrations

• Messaging between the browser and Unreal Engine

• Analytics and event tracking

• File transfer support

• White-labelling and branding customization

This allows developers to focus on building their application logic instead of managing the low-level streaming infrastructure.

---

Integration Modes

The WebSDK supports two integration approaches, depending on the level of customization required.

UI Integration (Recommended for most projects)

The simplest way to integrate Pixel Streaming is by using the SDK’s default UI setup.

With a single initialization call, the SDK will:

• Create and manage the streaming session

• Render the video stream

• Handle input forwarding

• Manage connection states and reconnections

This approach is ideal when you want to quickly embed a Pixel Streaming application into your website.

---

Core Integration (Advanced)

For applications that require full control over the UI and streaming lifecycle, the SDK also exposes a core/headless integration mode.

In this mode you can:

• Build your own UI

• Control the streaming lifecycle manually

• Handle events and messages directly

• Integrate deeply with frameworks like React, Vue, or Angular

This is recommended for advanced integrations or applications with highly customized interfaces.

---

Framework Agnostic

The WebSDK is designed to work with any modern frontend framework, including:

• React

• Vue

• Angular

• Svelte

• Vanilla JavaScript

It does not impose any framework-specific requirements, making it easy to integrate into existing applications.

---

Communication with Unreal Engine

The WebSDK enables bidirectional communication between the browser and the Unreal Engine application.

This allows you to:

• Send custom messages or commands from the browser

• Receive responses from Unreal Engine

• Trigger gameplay logic from web UI interactions

• Exchange structured data between frontend and application logic

---

When to Use the WebSDK

You should use the Arcware PixelStreaming WebSDK when you want to:

• Embed Unreal Engine applications into a web platform

• Build interactive 3D experiences accessible from a browser

• Integrate Pixel Streaming with existing web applications

• Create custom interfaces that interact with Unreal Engine in real time

---

Next Steps

To start integrating the SDK into your project, continue with:

Getting Started →