Vz:Doc:IpControl

From M1Research

(Difference between revisions)
Jump to: navigation, search
(Commands)
Line 4: Line 4:
==Commands==
==Commands==
-
Each command sent to VZ has javascript-like structure
+
<b>NOTE!</b> Tune your telnet program for UTF-8 characters.
-
*<code>tree.function.<function_id>.<parameter_name>=<value></code>
+
Each command sent to VZ has javascript-like structure.
 +
*<code>renderman.load(<scene_name>)</code>
 +
Perform scene loading into rendering engine, for example:
 +
<pre>vz in$> renderman.load(./projects/demo1.xml)
 +
vz out$> OK!Load</pre>
-
<b>NOTE!</b> Tune your telnet program for UTF-8 characters.
+
*<code>tree.function.<function_id>.<parameter_name>=<value></code>
 +
perform parameter setting for function, for example:
 +
<pre>vz in$> scene.tree.function.text_1.s_text=Maksym Veremeyenko
 +
vz out$> OK</pre>
==Connecting==
==Connecting==

Revision as of 20:14, 24 March 2007

IP Control protocol is simplest way for VZ control.

By default VZ uses 8001 IP port for that service. To connect to this port and send commands you need a telnet client program. Find appropriate "telnet" program for operating. "putty" is nice free program.

Commands

NOTE! Tune your telnet program for UTF-8 characters. Each command sent to VZ has javascript-like structure.

  • renderman.load(<scene_name>)

Perform scene loading into rendering engine, for example:

vz in$> renderman.load(./projects/demo1.xml)
vz out$> OK!Load
  • tree.function.<function_id>.<parameter_name>=<value>

perform parameter setting for function, for example:

vz in$> scene.tree.function.text_1.s_text=Maksym Veremeyenko
vz out$> OK

Connecting

[verem@elbrus reports]$ telnet vz-dev 8001
Trying 10.1.5.23...
Connected to vz-dev.internal.m1stereo.tv (10.1.5.23).
Escape character is '^]'.
ViZualizator (vz-1.0-release) [tcpserver]

vz in$>

As use can see vz service is online and is ready to accept commands.

Personal tools