Preview Server’s web interface, allows users to access features.

For details on how to open this interface, see Accessing the Preview Server Web Interface.

2025-03-21 13_00_41-Preview Server Configuration Tool.png

These are the menu options of the web interface:

Home

You can add, monitor and remove Media Sequencers and Viz Engines from a pool of renderers on the Home page. Preview Server can interact with one or more Media Sequencers and Viz Engines.

Note: The term Renderer Host is widely used in the Web Interface, it refers to a physical or virtual machine that runs an instance of Media Sequencer along with a Viz Engine attached to it.

Settings

The Settings page allows users to modify certain Preview Server settings that are crucial for the rendering process. These changes do not affect the behavior of the Windows Server itself and therefore do not require a service restart.

2025-03-21 13_08_29-Preview Server Configuration Tool.png

Frame API

Click the Frame API link in the Preview Server web interface to open the REST Frame API documentation, which describes the REST (Representational State Transfer) API over HTTP, provided by Preview Server, to request rendered frames from a Viz Engine.

The document also lists the Resources and Data Types that are used in the interface.

Example: http://<hostname>:21098/doc/rest_manual.

2025-03-21 13_10_55-Preview Server Configuration Tool.png

Connection Broker API

Click the Connection Broker API link in the Preview Server web interface to open the Connection Broker REST API documentation, which describes the REST (Representational State Transfer) API over HTTP, provided by the Connection Broker for requesting available Viz Engine instance for rendering.

The document also lists the Resources and Content Types that are used in the interface.

Example: http://localhost:21098/doc.

2025-03-21 13_22_21-Preview Server Configuration Tool.png

Licenses

The Licenses page displays the license texts of third-party components used in Preview Server.

2025-03-21 13_24_05-Preview Server Configuration Tool.png

About

Clicking the Information icon in the web interface opens the About Preview Server window, containing information on the installed version of Preview Server.

2025-03-21 13_26_29-Preview Server Configuration Tool.png

See Also