= Veejay - sayVIMS =

sayVIMS is a commandline utility used to send messages over TCP/IP to Veejay and is mostly 
used for testing Veejay's functionality.
The protocol for the messages is called 'VIMS' , which stands for Veejay's Internal Message System.
GVeejay uses VIMS to communicate with Veejay.

The message format is described as

'''<Selector>''' ''':''' ''<Arguments>'' ''';''' 

= Selector =

The Selector identifies which Action veejay will execute.
You can type

{{{
  veejay -u |less
}}}

for a listing of all Selectors with a short description.
A part from the list of VIMS selectors you will also find the full OSC Adress space
and a table of all effects with names, id's and parameter ranges.


The message
{{{
   sayVIMS "600:;"
}}}

will tell Veejay to Quit (without saving).

= Arguments =

When using VIMS to modify a Sample, you must identify which Sample you wish to perform the Action upon.
For all sample related VIMS messages, this is always the first argument.
In case of FX Chain editing, the second argument will identify the Index to be used for the Effect.
Thus, for presetting an Effect (with customized parameters) the third argument will be the Effect number
, the fourth will be Effect Parameter 0, the fifth ... etc.
If you dont care what sample is playing, or what effect might be overwritten , you can use default values.

The message belows add the magic mirror effect to the current chain entry on the current playing sample:
{{{
 sayVIMS "361:0 -1 151 1 2 3 4;"
}}}

Table with default values:

|| argument    || value || description       ||
|| sample_id   || 0     || current playing   ||
|| sample_id   || -1    || highest sample_id ||
|| chain entry || -1    || current entry     ||
|| stream_id   || 0     || current playing   ||
|| stream_id   || -1    || highest stream_id ||
|| playback    || 0     || editlist          ||
||             || 1     || stream            ||
||             || 2     || sample            ||
|| looptype    || 0     || no looping        ||
||             || 1     || normal looping    ||
||             || 2     || pingpong looping  ||
|| dataformat  || yv16  || YUV 4:2:2 AVI     ||
||             || mjpeg || Motion JPEG       ||
||             || yv12  || YUV 4:2:0 AVI     ||
||             || i420  ||                   ||
||             || dvsd  || DV Video          ||


If you have SDL:
|| key modifier|| 0     || none              ||
||             || 1     || alt               ||
||             || 2     || ctrl              ||
||             || 3     || shift             ||

= sayVIMS commandline options =

{{{
    -p         Veejay port (3490)
    -g         Veejay groupname (224.0.0.31)
    -h         Veejay hostname (localhost)
}}}


For example, stop Veejay running on the remote computer 'pc2' 

{{{
 $ sayVIMS -h pc2 "600:;"
}}}


= Examples =


{{{

 $ cd veejay-current/test/examples
 $ perl magicmirror.nl | sayVIMS

}}}

{{{
 $ sayVIMS "600:;"
}}}