VIMS

VIMS is veejay’s internal message system – its simple and in plain ASCII.
All control data is distributed via VIMS. Each (atomical) message consists of an Action Identifier and a list of zero or more Arguments which can be used to control Video Clips, Video Streams, the Effect Chain and many other things.
Reloaded, veejay’s client, uses a dual socket to read status and write back VIMS
messages.

VIMS allows events to be triggered through:
SDL Keyboard Event (libsdl)
OSC (Open Sound Control)
And Itself

After intalling veejay, you will have a commandline utility ‘sayVIMS’ which you
can use to send text messages.

Use the command

$ veejay -u -n |less

to dump all VIMS messages.

The Message Format

A message is described as:

<Action Identifier> : <Argument List> ;

Examples:

	080:;
	099:0 0;

<Action Identifier>

The action identifier is a 3 digit number describing a Network Event
The colon is used to indicate the start of the Argument List and must be given.

<Argument List>

The Argument List is described by a printf() style formatted template
which describes the number and type of arguments to be used.

The semicolon must be given to indicate the end of this message

Reserved Values

Some reserved numbers:

clip id	0	select currently playing sample
clip id	-1	select highest sample number
chain entry	-1	select current chain entry
stream id	0	select currently playing stream
stream id	-1	select highest stream number
key modifier	0 = nonone, 1= alt , 2 = ctrl, 3 = shift
frame	-1	use highest possible frame number
playback mode	0 = clip, 1 = stream, 2 = plain
data format	yv16 (yuv 4:2:2 raw) , mpeg4, divx, msmpeg4v3,div3, dvvideo, dvsd, mjpeg, i420 and yv12 (yuv 4:2:0 raw)
loop type	0 = no looping, 1 = normal loop, 2 = pingpong (bounce) loop