User guide

Viz Engine Administrator’s Guide

9.1.4 Command Interface

For small and single value changes the Command Interface of Viz Artist can be used.

For example, to update a headline in a Scene.

IMPORTANT! A command operation can block the renderer. If there are too many

commands, within a small time, or commands containing a large amount of data,

are sent, this can result in not rendering real-time anymore.

Note: Vizrt do not recommend this as a method for data import.

Any external program should consider the performance of the single or all connected

Viz Engines. If there is a burst of thousands of SHM variables this can have implications

on the Viz Engine rendering performance (Current (CUR) and Maximum (MAX)).

A full list of commands is at:

• C:\ProgramFiles\vizrt\Viz3\Documentation\CommandInterface\index.html

Note: Detailed path is for 32bit Windows. For 64bit Windows: C:

\ProgramFiles(x86)\vizrt\...

Note: From the list of commands, the commands, CLEAR, DELETE_ELEMENT and

PURGE_ELEMENT will only work when sent through the command interface of Viz

Artist.

IMPORTANT! The command CLEAR must be run on each Engine where the MAP is

to be reset (VIZ_COMMUNICATION*MAP CLEAR).

Whenever a new entry is made in the map (a new key-value pair) or values are

changed, then the change is propagated to the other Viz Engines through a database

messaging service to update the local copy of each Viz Engine’s map (this only works

when sent over the general communication port of Viz Engine (default port 6100)).

Command Examples

VIZ_COMMUNICATION*MAP can be used to access the map.

SET_DOUBLE_ELEMENT and GET_DOUBLE_ELEMENT

Example: VIZ_COMMUNICATION*MAP SET_DOUBLE_ELEMENT "my_double" 1.2

Example: VIZ_COMMUNICATION*MAP GET_DOUBLE_ELEMENT "my_double"