Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.streampixel.io/llms.txt

Use this file to discover all available pages before exploring further.

Overview

Customize how users interact with your streamed experience. The Frontend Settings panel allows you to fine-tune user input, UI elements, and interactivity options for your Unreal Engine application streamed through StreamPixel. This enables a tailored, user-friendly experience aligned with your application type—whether it’s simulation, configurator, or multi-user exploration.

What it does?

This module lets you control:
  • Which input devices are supported (mouse, keyboard, touch, gamepad, XR)
  • Which UI elements appear (volume button, fullscreen, resolution, etc.)
  • How users interact with the stream (hover, fake touch, mic, etc.)

Why It Matters

Enabling or disabling the right frontend options helps you:
  • Deliver a streamlined and distraction-free user interface
  • Prevent unintended inputs for kiosk or enterprise setups
  • Allow or block advanced control types (e.g., XR, mic, gamepads)
  • Customize interactivity per application type (e.g., touch-first vs. keyboard-first)

Key Options & Features

SettingDescription
Show Fullscreen ButtonToggle visibility of the fullscreen control button in the stream UI.
Show Volume ButtonToggle visibility of the volume button in the stream UI.
Show Info ButtonToggle Visibility of Info button which displays stream diagnostic and metadata (FPS, resolution, etc.) for advanced users or debugging.
Mic SettingEnable/disable microphone input. Needed only for voice-based interactions.
Mouse Input SettingToggles mouse input.
Keyboard Input SettingToggles keyboard input.
Touch Input SettingToggles touch input on devices.
Fake Mouse TouchSimulates mouse input via touch gestures — useful when your application is designed for desktop but accessed on touch devices. Enable this only if your application does not have native touch input logic implemented.
Gamepad Input SettingEnable if your experience supports gamepad controllers.
XR Input SettingEnables XR-specific inputs (for WebXR integration). Keep disabled unless using VR/AR.
Hovering Mouse SettingAllows cursor hovering behavior to trigger interactions
Show Resolution SettingDisplays the resolution selector in the UI, allowing users to view and manually change the streaming resolution based on their preferences or network conditions.

How to Use

1

Open the Frontend Settings tab

Go to the Frontend Settings tab in your project dashboard.
2

Toggle elements based on your needs

Enable or disable elements based on the needs of your experience.
3

Save your changes

Click Save to apply changes. These settings update in real time.