Skip to content

Commit 40b1d53

Browse files
committed
Improve Help ( game-stop#76 wip) : review veejay-HOWTO.md - progress
* todo from 4.3 to end
1 parent 2f46604 commit 40b1d53

File tree

1 file changed

+65
-58
lines changed

1 file changed

+65
-58
lines changed

veejay-current/veejay-server/doc/veejay-HOWTO.md

Lines changed: 65 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -645,76 +645,83 @@ Some reserved numbers:
645645
------------------------------
646646

647647
sayVIMS is a commandline utility distributed with the veejay package, it
648-
allows you to give short commands in interactive mode
649-
650-
*$ sayVIMS -i -h localhost -p 3490*
651-
652-
Typing '?' followed by pressing ENTER gives the list of command below:
653-
654-
vi [file] Open video4linux device
655-
fi [file] Open Y4M stream for input
656-
fo [file] Open Y4M stream for output
657-
av [file] Open (almost any) video file using FFmpeg
658-
mc [address] [port] Open a multicast UDP video stream
659-
pr [hostname][port] Open a unicast TCP video stream
660-
cl [file] Load cliplist from file
661-
cn [n1] [n2] New clip from frames n1 to n2
662-
cd [n] Delete clip n1
663-
sd [n] Delete Stream n1
664-
cs [file] Save cliplist to file
665-
es [file] Save editlist to file
666-
ec [n1] [n2] Cut frames n1 - n2 to buffer
667-
ed [n1] [n2] Del franes n1 - n2
668-
ep [n] Paste from buffer at frame n1
669-
ex [n1] [n2] Copy frames n1 - n2 to buffer
670-
er [n1] [n2] Crop frames n1 - n2
671-
al [file] Action file Load
672-
as [file] Action file save
673-
de Toggle debug level (default off)
674-
be Toggle bezerk mode (default on)
675-
676-
Also, you can send messages in VIMS format (or files, containing VIMS
677-
messages )
678-
679-
For example, add the Pixelate effect on the Effect Chain of the current
680-
playing stream or clip:
681-
682-
sayVIMS -h localhost -p 3490 "361:0 0 150 3;"
683-
684-
685-
Last but not least, sayVIMS can parse files containing VIMS messages.
686-
See the test/examples directory of the package for a list of perl
687-
scripts that output a VIMS script.
648+
allows you to send to a veejay server short commands in interactive mode,
649+
single VIMS message or files containing VIMS messages.
688650

689-
sayVIMS -f advocate.vims -h localhost -p 3490
651+
In the following examples, lets say a veejay instance is running on host
652+
`localhost` using port `3490` (its default values).
690653

691-
692-
Alternativly, you can start a secundary veejay and stream from peer to
693-
peer in uncompressed video:
694-
695-
$ veejay -d -p 5000
696-
697-
$ sayVIMS -h localhost -p 5000 "245:localhost 3490;"
654+
**Interactive Mode**
655+
```
656+
$ sayVIMS -i -h localhost -p 3490
657+
```
658+
In interactive mode, after a connection is establish with a veejay server,
659+
a prompt wait you to enter VIMS commands. Press `ENTER` to send it.
660+
The connection remain open until you exit by typing `quit`.
698661

699-
(press 'F7' in veejay to display the stream, prob. stream 7)
662+
Typing '?' followed by pressing `ENTER` gives the list of command below:
663+
```
664+
vi [file] Open video4linux device
665+
fi [file] Open Y4M stream for input
666+
fo [file] Open Y4M stream for output
667+
av [file] Open (almost any) video file using FFmpeg
668+
mc [address] [port] Open a multicast UDP video stream
669+
pr [hostname][port] Open a unicast TCP video stream
670+
cl [file] Load cliplist from file
671+
cn [n1] [n2] New clip from frames n1 to n2
672+
cd [n] Delete clip n1
673+
sd [n] Delete Stream n1
674+
cs [file] Save cliplist to file
675+
es [file] Save editlist to file
676+
ec [n1] [n2] Cut frames n1 - n2 to buffer
677+
ed [n1] [n2] Del franes n1 - n2
678+
ep [n] Paste from buffer at frame n1
679+
ex [n1] [n2] Copy frames n1 - n2 to buffer
680+
er [n1] [n2] Crop frames n1 - n2
681+
al [file] Action file Load
682+
as [file] Action file save
683+
de Toggle debug level (default off)
684+
be Toggle bezerk mode (default on)
685+
```
700686

701-
Or for multicast:
687+
**Single VIMS message**
702688

703-
$ veejay -V 224.0.0.50 -p 5000 -n -L movie1.avi
689+
Also, you can send single VIMS format message.
704690

705-
$ veejay -d
691+
For example, add the Pixelate effect on the Effect Chain of the current
692+
playing stream or clip :
693+
```
694+
sayVIMS -h localhost -p 3490 -m "361:0 0 100 3;"
695+
```
706696

707-
$ sayVIMS -h localhost -p 3490 "246:224.0.0.50 5000;"
697+
**Using files**
708698

709-
$ veejay -d -p 4000
699+
Last but not least, sayVIMS can parse files containing VIMS messages.
710700

711-
$ sayVIMS -h localhost -p 4000 "246:224.0.0.50 5000;"
701+
See the `veejay-server/test/examples` directory of the package for a list of perl
702+
scripts that output a VIMS script.
703+
```
704+
sayVIMS -f advocate.vims -h localhost -p 3490
705+
```
712706

713-
Or, if you want to play a XVID movie (or any other compressed format
714-
that is not I frame only):
707+
**Others examples**
715708

716-
$ sayVIMS -h localhost -p 3490 "244:/tmp/my-XVID-movie.avi;"
709+
Alternativly, you can start a secundary veejay and stream from peer to
710+
peer in uncompressed video :
711+
```
712+
$ veejay -d -p 5000
713+
$ sayVIMS -h localhost -p 5000 -m "245:localhost 3490;"
717714
715+
(press 'F7' in veejay to display the stream, prob. stream 7)
716+
```
717+
Or for multicast:
718+
```
719+
$ veejay -V 224.0.0.50 -p 5000 -n -L movie1.avi
720+
$ veejay -d
721+
$ sayVIMS -h localhost -p 3490 -m "246:224.0.0.50 5000;"
722+
$ veejay -d -p 4000
723+
$ sayVIMS -h localhost -p 4000 -m "246:224.0.0.50 5000;"
724+
```
718725
<span id="4.3">4.3 The keyboard interface</span>
719726
------------------------------------------------
720727

0 commit comments

Comments
 (0)