Vz:Doc:IpControl

From M1Research

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.

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.

Commands

NOTE! 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.

• 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

• tree.container.<container_id>.visible=<value>

Container visibility control

• tree.motion.director.<director_id>.start([<position>])
• tree.motion.director.<director_id>.stop()
• tree.motion.director.<director_id>.continue()
• tree.motion.director.<director_id>.reset([<position>])

Directors (animation) control, for example:

vz in$> scene.tree.motion.director.main.start()
vz out$> OK

Start animation on director main.

vz in$> scene.tree.motion.director.main.cont()
vz out$> OK

Continue animation on director main after pausing.

• tree.motion.timeline.<timeline_id>.<t1|t2|y1|y2>=<value>

timeline modification.