Documentation Center

Viz Channel Branding User Guide

Version 5.1 | Published October 26, 2023 ©

Preview Server

Preview Server is used in multiple Vizrt client applications to fetch previews of overlay graphics for the Timeline Editor and also, in situations where Viz Engine provides frames for snapshot or thumbnail generation.

Preview Server can manage a pool of Viz Engines. Clients can query it for a Viz Engine that matches a specific video mode. Preview Server provides load balancing, video mode matching and can be used to create a redundant renderer pool. This section covers the following topics:

See Also

Preview Server Web Interface

images/download/attachments/140817687/previewserver_previewserver_config.png

Accessing the Preview Server Web Interface

  • Open the Preview Server Web Interface by navigating the File Explorer to All Programs > Vizrt > Preview Server > Preview Server Config.

  • Alternatively, access the Preview Server Web Interface in a web browser, using the host name of the machine running Preview Server, and port 54000. For example, http://<hostname>:54000/.

    The Preview Server menu bar has links to the following pages:

  • Config

  • Frame API

  • Testing

  • Logs

  • About

Config

Preview Server can interact with one or more Viz Engines. These can be configured on the home page of the Preview Server web interface.

http://<hostname>:54000/

Adding a Viz Engine

  • Enter the Viz Engine hostname or IP address in the Configuration field, and click Add Renderer.

    Tip: Click the arrow next to the Viz Engine entity or the Expand All link to see information on video mode, aspect ratio and Viz Graphic Hub connection.

    Note: If not specified, Viz Engine is added with the default port 50007. When using Viz Engines in a dual channel setup, it is possible to run multiple instances of Viz Engine on a single host. Each instance uses a unique port, which means that two Viz Engines are only considered duplicates when both the hostnames and port numbers are identical. When referring to Viz Engines in a dual channel setup, type the port number after the host name (for example VizEngine1:51007).

Removing a Viz Engine

  • Click Delete next to the Viz Engine entity that is to be removed.

Frame API

The Preview Server REST API page displays the REST API provided by the Preview Server and includes information on the Resource Types and Data Types that are used in the interface.

http://<hostname>:54000/doc/rest_manual

Testing

This page provides:

  • Snapshot Testing - Test snapshot service.

  • Snapshot Set Testing - Test snapshot service with set of positions.

To use these features, enter the snapshot XML data, payload XML data and the path to a scene. When the Test this data button is pressed, a feed is returned containing links to the requested snapshots.

http://<hostname>:54000/testing

Logs

This page provides a feed with links to Preview Server logs.

http://<hostname>:54000/logs

About

Click to see information on Preview Server version and Third Party Component Credits.

Installing and Configuring Preview Server

This section covers:

Requirements

Preview Server requires Microsoft .NET version 4 or newer. The free .NET 4.0 bootstrap installer may be downloaded directly from Microsoft.

Installation

Preview Server is a separate installer and can be downloaded from ftp.vizrt.com in the products/VizPreviewServerConnectionBroker/Latest Version folder. Please read the Release Notes before installing the product.

Installing or Upgrading Preview Server

As a user with Administrative rights:

  1. Run the installer Preview Server-<version>.msi.

  2. Click Next.

    • Optional: Select the location of the installed files.

  3. Click Next.

  4. Click Install to start the installation process.

  5. Click Finish.
    The installer will install the Preview Server as an automatically started Windows service and start the service. This could require the user to open the Preview Server port if using a Firewall.

To check that the service is correctly installed and running, go to Windows: Control Panel > System and Security > Administrative Tools > Services and check that the Preview Service is running and set to automatically start.

Configuration

Preview Server Service

Preview Server is a Windows Service. It sets up an HTTP REST service on port 54000 on the host it is running on. This service accepts requests for graphical snapshots of playout elements from a Viz Engine.

Viz Engines

Although Preview Server can run on the same machine as a Viz Engine (also used for the Newsroom Component data element preview), it is also possible to specify additional Viz Engines in order to spread the load. Frame requests will be balanced across available Viz engines in a way that will minimize the memory load of each engine.

The pool of Viz Engines is configured on the Preview Server Web Interface Config page.

Scaling of the system should be monitored to avoid excessive client waiting time and potential overload of the Viz Engines.

Frame Cache

Frames are cached in memory, allowing quicker responses when requesting frames that have been requested previously. By default, frames will be cached for a maximum of one day. This behavior can be changed by modifying the CacheMaxAge setting in the Preview Server.exe.config file, which specifies the maximum number of seconds to retain cached results.