Skip to content

Commit 7554138

Browse files
d-j-a-yd-j-a-y
committed
Improve help (game-stop#76) : veejay-howto.html --> veejay-howto.md
todo 4.5.3 network --> end
1 parent d1797f9 commit 7554138

File tree

1 file changed

+101
-115
lines changed

1 file changed

+101
-115
lines changed

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

Lines changed: 101 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -160,23 +160,23 @@ Veejay consists out of several packages:
160160
<tbody>
161161
<tr class="odd">
162162
<td><strong>veejay-server</strong></td>
163-
<td>This is veejay</td>
163+
<td>This is <strong>veejay</strong> !</td>
164164
</tr>
165165
<tr class="even">
166166
<td><strong>veejay-client</strong></td>
167-
<td>This is reloaded, the graphical user interface to veejay</td>
167+
<td><strong>reloaded</strong>, the graphical user interface to veejay</td>
168168
</tr>
169169
<tr class="odd">
170170
<td><strong>veejay-utils</strong></td>
171-
<td>Commandline utilities to interface with veejay</td>
171+
<td>Command-line interface with veejay, <strong>sayVIMS</strong></td>
172172
</tr>
173173
<tr class="even">
174174
<td><strong>sendVIMS</strong></td>
175175
<td>Simple VeeJay client for Pure Data</td>
176176
</tr>
177177
<tr class="odd">
178178
<td><strong>veejay-themes</strong></td>
179-
<td>Themepack for reloaded</td>
179+
<td>Theme-pack for reloaded</td>
180180
</tr>
181181
</tbody>
182182
</table>
@@ -691,7 +691,7 @@ Also, you can send single VIMS format message.
691691
For example, add the Pixelate effect on the Effect Chain of the current
692692
playing stream or clip :
693693
```
694-
sayVIMS -h localhost -p 3490 -m "361:0 0 100 3;"
694+
$ sayVIMS -h localhost -p 3490 -m "361:0 0 100 3;"
695695
```
696696

697697
**Using files**
@@ -701,7 +701,7 @@ Last but not least, sayVIMS can parse files containing VIMS messages.
701701
See the `veejay-server/test/examples` directory of the package for a list of perl
702702
scripts that output a VIMS script.
703703
```
704-
sayVIMS -f advocate.vims -h localhost -p 3490
704+
$ sayVIMS -f advocate.vims -h localhost -p 3490
705705
```
706706

707707
**Others examples**
@@ -728,157 +728,143 @@ $ sayVIMS -h localhost -p 4000 -m "246:224.0.0.50 5000;"
728728
Here is a quick overview for the most used default keys, if applied in
729729
order you will end up with a newly created video sample looping in some
730730
way (depending on how many times you press the asterix key)
731-
732-
733-
734-
#### Some keyboard bindings
735-
736-
*Description*
737-
738-
*SDL key*
739-
740-
*In plain english*
741-
742-
Set the starting position of a new sample
743-
744-
SDLK\_LEFTBRACKET
745-
746-
Left bracket
747-
748-
Set ending position and create a new sample
749-
750-
SDLK\_RIGHTBRACKET
751-
752-
Right bracket
753-
754-
Select and play sample **1**
755-
756-
SDLK\_F1
757-
758-
F1
759-
760-
Set playback speed to 3
761-
762-
SDLK\_d
763-
764-
d
765-
766-
Change looptype
767-
768-
SDLK\_KP\_MULTIPLY
769-
770-
asterix on numeric keypad
771-
772-
Play backward
773731

774-
SDLK\_KP\_4
775732

776-
Cursor left on numeric keypad
777-
778-
Play forward
779-
780-
SDLK\_KP\_6
781-
782-
Cursor right on numeric keypad
783-
784-
Skip 1 second
785-
786-
SDLK\_KP\_8
787-
788-
Cursor up on numeric keypad
789-
790-
Switch playmode to Plain
791-
792-
SDLK\_KP\_DIVIDE
793-
794-
Divide on numeric keypad
795-
796-
Print information about sample
797-
798-
SDLK\_HOME
799-
800-
Home
733+
<table>
734+
<tbody>
735+
<caption><strong>Some keyboard bindings</strong></caption>
736+
<tr class="">
737+
<td><strong>Description</strong></td>
738+
<td><strong>SDL key</strong></td>
739+
<td><strong>In plain english</strong></td>
740+
</tr>
741+
<tr class="odd">
742+
<td>Set the starting position of a new sample</td>
743+
<td>SDLK_LEFTBRACKET</td>
744+
<td>Left bracket</td>
745+
</tr>
746+
<tr class="odd">
747+
<td>Set ending position and create a new sample</td>
748+
<td>SDLK_RIGHTBRACKET</td>
749+
<td>Right bracket</td>
750+
</tr>
751+
<tr class="odd">
752+
<td>Select and play sample 1</td>
753+
<td>SDLK_F1</td>
754+
<td>F1</td>
755+
</tr>
756+
<tr class="odd">
757+
<td>Set playback speed to 3</td>
758+
<td>SDLK_d</td>
759+
<td>d</td>
760+
</tr>
761+
<tr class="odd">
762+
<td>Change looptype</td>
763+
<td>SDLK_KP_MULTIPLY</td>
764+
<td>asterix on numeric keypad</td>
765+
<tr class="odd">
766+
<td>Play backward</td>
767+
<td>SDLK_KP_4</td>
768+
<td>Cursor left on numeric keypad</td>
769+
</tr>
770+
<tr class="odd">
771+
<td>Play forward</td>
772+
<td>SDLK_KP_6</td>
773+
<td>Cursor right on numeric keypad</td>
774+
</tr>
775+
<tr class="odd">
776+
<td>Skip 1 second</td>
777+
<td>SDLK_KP_8</td>
778+
<td>Cursor up on numeric keypad</td>
779+
</tr>
780+
<tr class="odd">
781+
<td>Switch playmode to Plain</td>
782+
<td>SDLK_KP_DIVIDE</td>
783+
<td>Divide on numeric keypad</td>
784+
</tr>
785+
<tr class="odd">
786+
<td>Print information about sample</td>
787+
<td>SDLK_HOME</td>
788+
<td>Home</td>
789+
</tr>
790+
</tbody>
791+
</table>
801792

802-
803-
804793
The function keys **F1**...**F12** can be used to select sample **1**
805794
... **12**, use the keys **1**...**9** to select a sample range **1-12**
806795
... **108-120** and press one of the **F**-keys to play that sample.
807796

808797
Use **ESC** to switch between samples and streams. Press **ESC** again
809-
to switch back to the sample playmode
810-
You can create new input streams by using the console interface or by
811-
using GVeejay.
812-
All new input streams (and samples) are auto numbered.
813-
814-
798+
to switch back to the sample playmode.
799+
800+
You can create new input streams by using the console interface **sayVIMS** or by
801+
using the graphical user interface **reloaded**. All new input streams (and samples) are auto numbered.
815802

816803
<span id="4.4">4.4 Recording video</span>
817804
-----------------------------------------
818805

819-
You can record video to a new clip , by using the stream- or clip
820-
recorder functions.
821-
For example, to record a new clip from a playing clip in MJPG format:
822-
823-
302:mjpg;
806+
You can record video to a new clip, in a specified codec format, by using the stream or clip recorder functions.
824807

825-
Record 100 frames and start playing new clip when ready:
808+
For example, to select a MJPG codec to record a new clip from a playing clip:
809+
```
810+
$ sayVIMS -m "302:mjpg;"
811+
```
826812

827-
130:100 1;
813+
Record 100 frames and start playing (1 = auto-play) new clip when ready:
814+
```
815+
$ sayVIMS -m "130:100 1;"
816+
```
828817

829-
Record the whole clip and dont start playing new clip when ready:
818+
Record the whole clip and don't start playing new clip when ready:
819+
```
820+
$ sayVIMS -m "130:0 0;"
821+
```
830822

831-
130:0 0;
823+
If your Effect Chain is very CPU demanding, consider disabling audio and using the command-line parameter `-c 0` to disable synchronization correction.
832824

833-
If your Effect Chain is very CPU demanding , consider disabling audio
834-
and using the commandline parameter -c 0 to disable sync correction.
835-
836825
It is possible to start veejay headless and have it write all video data
837-
to a (special) file for further processing.
838-
839-
Refer to chapter [5.3](veejay-HOWTO.md#5.3) for some examples.
840-
826+
to a (special) file for further processing. Refer to chapter [5.1](veejay-HOWTO.md#5.1) for some examples.
841827

842828
<span id="4.5">4.5 Streaming video</span>
843829
-----------------------------------------
844830

845831
You can create an input stream to read video coming from a video4linux
846-
device, from a pipe or from a network socket (both unicast and
847-
multicast).
832+
device (USB webcam, TV tuner...), from a pipe or from a network socket (both unicast and multicast).
848833

849834
### <span id="4.5.1">4.5.1 video4linux</span>
850835

851-
To open a video4linux device use gveejay or type the command:
852-
853-
854-
$ sayVIMS 240:0 1;
836+
To open a video4linux device use reloaded or type the command:
837+
```
838+
$ sayVIMS -m "240:0 1;"
839+
```
855840

856-
The selector '240' tells veejay to open a video4linux device, the first
841+
The VIMS selector `240` tells veejay to open a video4linux device, the first
857842
argument '0' indicates the device number (i.e. /dev/video0) and the last
858843
argument '1' indicates the video in port of your capture card (in this
859844
case composite).
860-
Veejay will create a new stream see [chapter 4.4](#4.4) for activating
861-
the stream.
845+
Veejay will create a new stream see [chapter 4.3](#4.3) for activating
846+
the stream.
862847

863848
### <span id="4.5.2">4.5.2 pipe</span>
864849

865850
Veejay supports reading video data from a pipe (FIFO) by means of an
866851
input stream.
867852
The only supported transport format is yuv4mpeg (yuv 4:2:0). When
868853
playing YUV 4:2:2 the video stream will be sampled to YUV 4:2:0 and vice
869-
versa
870-
You can create the input stream by typing the command
854+
versa.
871855

872-
$ sayVIMS 243:/tmp/stream.yuv;
856+
You can create the input stream by typing the command
857+
```
858+
$ sayVIMS -m "243:/tmp/stream.yuv;"
859+
```
873860

874861
### <span id="4.5.3">4.5.3 network</span>
875862

876-
To get frames from another running veejay, use the command:
877-
878-
$ sayVIMS 245: ;
863+
To get frames from another running veejay, use the VIMS selector `245` with hostname (or IP number) and port:
864+
```
865+
$ sayVIMS 245:localhost 5000;
866+
```
879867

880-
For example, sayVIMS 245:localhost 5000;
881-
882868
If you want to send the same video to multiple running veejays accross
883869
the network, you can save bandwith by starting the veejay you wish to
884870
use as server with the -V option.

0 commit comments

Comments
 (0)