Viz Arc User Guide

Version 1.8 | Published October 13, 2023 ©

Profiles

  1. Profiles: Used to configure the different groups of Viz or Unreal Engines available for control by the user; these groups are called Channels.

  2. Engine and Channel Settings: Used to configure Program/Preview, the concept and an execution delay each Engine.

  3. Engines list: Viz Arc is capable of controlling more than one Viz Engine at the same time. For example, when working with multiple tracked cameras. This menu contains all the Engines assigned to a given channel.

  4. Enabled Layers: Layers enabled in the Scene Tools when selecting a channel and selecting into which layer a scene is loaded.

  5. Channels: A channel is a group of Viz Engines (or Unreal Engines) that receive the same commands at the same time. For example, when executing actions or loading a scene.

To access the Profile config menu, press the Profiles icon on the left of the window in the Config panel:

images/download/attachments/81477249/profiles_main.png

This section covers the following topics:

Note: To connect Viz Arc to an Unreal Engine you need to copy the VizArc folder to \Epic Games\UE_4.20\Engine\Plugins.

Profile Configuration

To Add a New Profile

images/download/thumbnails/81477249/arc_pg_cp.jpg

Press the CREATE PROFILE icon in the middle of the window or the plus icon images/download/thumbnails/81477249/arc_pg_plus_ico.jpg next to the existing profiles.

To Rename a Profile

images/download/thumbnails/81477249/arc_pg_ren.jpg

  1. Double-click on the profile name.

  2. Insert the desired name.

  3. Click ENTER.

To Delete a Profile

images/download/thumbnails/81477249/arc_pg_del.jpg

  1. Right-click on the profile name.

  2. Select Delete Profile in the context menu.

Engine Configuration

Note: The Engines List is global for all Profiles configured in Viz Arc.

Add a Viz Engine

  1. images/download/thumbnails/81477249/arc_pg_adde.jpg Press the NEW ENGINE icon on the right of the window or the add icon images/download/thumbnails/81477249/arc_pg_newe_ico.jpg at the top of the Viz Engines list.

  2. Enter the display name, host/IP and port in the box that appears.

    The Feedback Port is the command_feedback_port as configured on the VizEngine (default 7476).

  3. Press ENTER

To Add an Unreal Engine

  1. images/download/thumbnails/81477249/arc_pg_adde.jpg Press the NEW ENGINE icon on the right of the window or the add icon images/download/thumbnails/81477249/arc_pg_newe_ico.jpg at the top of the Unreal Engines list.

  2. Enter the display name, host/IP and Viz Arc Unreal Engine plug-in port and the Launcher Port in the boxes that appear.

    images/download/thumbnails/81477249/unrealengine.png
  3. Press ENTER.

To Rename or Edit an Engine

images/download/thumbnails/81477249/arc_pg_rene.jpg

  1. Right-click on the Engine name.

  2. Select Edit Engine in the context menu or press the Edit icon images/download/thumbnails/81477249/arc_pg_edit_ico.jpg next to the Engine name.

  3. Enter display name, host/IP and port.

    images/download/thumbnails/81477249/arc_pg_aed.jpg
  4. Press ENTER.

Configure and Engine settings

images/download/thumbnails/81477249/programpreview.png It's possible to assign every Engine as a Program or Preview engine.

images/download/thumbnails/81477249/editingengine.png An Engine can also be set as Editing Engine, which means the Engine is used for a scene tree load, or to select and objectify a Transition Logic scene, for example.

images/download/attachments/81477249/conceptdelay.png The Concept determines which scene concept is used by the engine when a scene is loaded through the Scene Loader Action or a Template Action. The Execution Delay can be used to delay all commands that are sent to the engine. This can be useful for set-ups involving e.g. AR and Videowall engines where output runtimes of the various subsystems are not uniform.

Warning: Setting an Engine that is On Air into editing mode may load a scene tree while another scene is On Air.

To Delete an Engine

images/download/thumbnails/81477249/arc_pg_dele.jpg

  1. Right-click on the Engine name.

  2. Select Delete Engine in the context menu.

  3. Confirm by pressing Yes.

Channel Configuration

To Add a Channel

images/download/thumbnails/81477249/arc_pg_ach.jpg

Press the NEW CHANNEL icon in the middle of the profiles section or the Add icon images/download/thumbnails/81477249/arc_pg_newch.jpg at the top of the Channel’s list.

Note: It's possible to create multiple channels and assign a unique name to each channel.

To Assign Engines to Channels

images/download/thumbnails/81477249/arc_pg_e2c.jpg

Drag and drop Engines from the Engines list (right).

To Rename a Channel

images/download/thumbnails/81477249/arc_pg_rench.jpg

  1. Double-click on the channel name.

  2. Enter the desired name.

  3. Press ENTER.

To Delete a Channel

images/download/thumbnails/81477249/arc_pg_delch.jpg

  1. Right-click on the channel name.

  2. Select Remove Channel in the context menu.

  3. Confirm by pressing Yes.

To Enable Available Viz Layers

images/download/attachments/81477249/layers.png

Select one or more layers by pressing them in the Channel menu.

Note: Layers let you send scenes and commands to different output levels within Viz Engine. The main layers are FRONT LAYER , MAIN LAYER and BACK LAYER. graphics are usually sent to the MAIN LAYER. If you want to view a graphic On Air you need to have at least one layer enabled.

To Select Unreal Engine Version

If the channel consists of one or more Unreal Engines, the Channel menu looks like this:

images/download/attachments/81477249/unrealchannel.png

For each Engine, select the Unreal Version to be used by selecting it from the drop down menu. The adjacent start/restart button starts the respective Unreal version.

Note: The Launcher Port must be configured properly and the Viz Arc Unreal Loader service must run on the target machine. See Unreal Loader for more on setting up and configuring Loader service.

images/download/attachments/81477249/unrealchannel2.png

  • Host/Port: The hostname or IP address running the Unreal Engine and the port on which the Viz Arc Unreal plug-in is configured to listen to.

  • Launcher Port: The port used by the Viz Unreal Loader service.

  • Web Interface Port: The port where UE exposes the Remote Control A PI (UE Version >= 4.26 only).

  • WebSocket Port: The web socket port where UE exposes the Remote Control Web Interface (UE Version >= 4.26 only).

WebSocket Port and Web Interface Port are only relevant when the UE Preset actions are used.

To Select a Profile

Once you have created a profile, you can select it from the drop down menu at the bottom left corner of the UI. All channels containing the selected profile are displayed on the right.

images/download/attachments/81477249/arc_pg_psel.png

Click on a channel to see which Engines it contains.

images/download/attachments/81477249/arc_pg_cheng.png

If the channel is an Unreal channel, you can select a different version to run or start/restart the Unreal Engine.

images/download/attachments/81477249/image2020-4-1_13-44-47.png

Click on the small triangle at the right of each Engine to see more details about the current Engine configuration. The first two entries show the shared memory communication port settings, which can be used with scripting or SHM. To configure the Shared Memory ports on Viz Engine, go to Viz Engine configuration under Communication > Shared Memory where you can configure UDP and TCP ports for Shared Memory updates.

images/download/attachments/81477249/arc_pg_comm.png