Share

Web Interface

The Web Interface (think of it as the web server) is the web browser interface that communicates with VRED via the HTTP protocol (localhost:8888). Access VRED through any modern web browser, without the need for plugins or specific software installations. Now, it's easier for a wider audience to participate in design reviews and interact with the 3D visualizations.

Web Interface

The web browser interface is provided by a built-in web server, which is a remote procedure-call API (RPC API) that is built on the same base as the Python API v2, and accessible via JavaScript. Use it to access the following:

  • Streaming App - Opens the Streaming App to live streams rendered images from the VRED renderview, using the provided controls to switch viewpoints and variants. This is for users running VRED 2024 or newer. It is optimized for mobile devices and was created to replace the legacy version. See Using the VRED Streaming App for further details.

    Streaming App in use

  • Streaming App legacy - Opens the version of the Streaming App available before VRED 2024 for users running VRED 2023 and older.

    Streaming App legacy

  • Stream - Opens a live stream of the VRED viewport displaying an HD version in the browser. Choose from the following:

    • H264 HD - Opens a live stream of the VRED viewport displaying an H264 HD version in the browser.

    • JPEG HD - Opens a live stream of the VRED viewport displaying a JPEG HD version of the scene image in the browser.

    Stream with JPEG HD selected

  • Navigation App - Opens the VRED App to navigate your VRED scene and switch between variant sets, using a network-connected device, such as a tablet or phone, as a remote control.

  • Terminal - Opens the VRED Hub terminal for scripting in the web interface, instead of switching to VRED on your local machine.

    Terminal web interface

  • More - Provides a list of options to access a web interface for the Scenegraph (http://localhost:8888/treeview) and Python API (http://localhost:8888/pythonapi). Use the functions and parameters found in Python API v2 documentation for the web interface and Python API.

    Note:

    The ChangList option accessible through clicking Icon in front of More More is legacy functionality that will be removed in the future.

    Scenegraph Python API
    Web interface for the Scenegraph Web interface for the Python API
    Tip:

    To add a web interface to a sceneplate in your scene, see Streaming the VRED Stream App to a Sceneplate.

Video Player is loading.
Current Time 0:00
/
Duration 0:49
Loaded: 0%
0:00
Progress: 0%
 
1x

Web Interface Redesign Video Captions: In VRED 2021.1, we have redesigned the Web Interface home page, which has a much cleaner look and also scales to different devices and different window sizes. Additionally, we added more options within the VRED Stream App and the ability to switch between JPEG and H264 codec, if you have it installed. You can also change bit rates and quality settings to adjust to your connection speed. Other options are fps limitations and window scale options, lock resolutions for all devices, and our new downscale toggle when being in raytracing mode. All these options improve the user experience and gives you more flexibility when using the Stream App.

See more

learnMore icon For information on using the Web Interface, see the following:

Updates

  • In 2026.2, for hardware accelerated streaming, we added support for the AV1 and H.265 video codecs. Find these in the Streaming App > Settings > Codec section.

  • In 2026.1, we added web interface support for hardware accelerated streaming.

How to Open the Web Interface

With a scene loaded into your version of VRED, in a browser, enter localhost: followed by the port number set in the preferences. For example, the default port is 8888; therefore, in the browser, you would enter localhost:8888 to access the Web Interface.

New Web Interface UI

How to Configure the Web Interface

Use the WebInterface preferences to set the port for accessing the web interface through your browser.

Cross-Origin Resource Sharing (CORS)

Here is information regarding Cross-Origin Resource Sharing (CORS) in the VRED Web Interface. It has also been implemented for the VREDServer.

Tip:

Set the Cross-Origin Resource Sharing (CORS) default behavior used by VRED in the General Settings > Web Interface > Cross-Origin Resource Sharing (CORS) preferences.

HTTP Headers for CORS

These are the HTTP headers for cross-origin request sharing:

Preflight (OPTIONS)

Access-Control-Allow-Origin: *

Access Control Allow methods: GET,HEAD,PUT,PATCH,POST,DELETE

Access Control Allow Headers: content-type

Actual request (GET)

Access-Control-Allow-Origin: *

How This Works

If the HOST or PORT is not the same as the one under which the current website/web application is running, and the web application tries to send a request to this other host via Javascript, then this, the HOST, will agree to the request. Otherwise, the browser will not send the request.

This is the procedure:

  1. The browser asks the different HOST or PORT in a preflight request with the HTTP method "OPTIONS", if the HOST agrees. If it responds with the HTTP headers as in Preflight above, then it looks to the actual request.

  2. The browser sends the actual request. Here, too, an HTTP header must be included as above in Actual request. This must be set; otherwise, the browser will not process the response.

For additional information on the headers and how they work visit Access-Control-Allow-Origin and Cross-Origin Resource Sharing (CORS).

Was this information helpful?