Vz:Doc:IpControl

IP Control protocol is simplest way for <b>VZ</b> control.

By default <b>VZ</b> 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.

==Connecting==
<pre>
[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$>
</pre>
As use can see vz service is online and is ready to accept commands.

==Commands==
<b>NOTE!</b> Tune your telnet program for UTF-8 characters.

Each command sent to VZ has javascript-like structure. I try to descibe most usefull commands format with examples.

*<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>

*<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=Prived Medved
vz out$> OK
vz in$> scene.tree.function.text_2.s_text=Hi Man!
vz out$> OK</pre>

*<code>tree.container.<container_id>.visible=<value></code>
Container visibility control

*<code>tree.motion.director.<director_id>.start([<position>])</code>
*<code>tree.motion.director.<director_id>.stop()</code>
*<code>tree.motion.director.<director_id>.continue()</code>
*<code>tree.motion.director.<director_id>.reset([<position>])</code>
Directors (animation) control

For example:

Start animation on director <code>main</code>.<pre>vz in$> scene.tree.motion.director.main.start()
vz out$> OK</pre>

Continue animation on director <code>main</code> after pausing.<pre>vz in$> scene.tree.motion.director.main.cont()
vz out$> OK</pre>

*<code>tree.motion.timeline.<timeline_id>.<t1|t2|y1|y2>=<value></code>
timeline modification.