More info about the other tools.
[platform/upstream/gstreamer.git] / tools / README
1 gstreamer-launch
2 ================
3
4 This is a tool that will construct pipelines based on a command-line
5 syntax.  The syntax is rather complex to enable all the features I want it
6 to have, but should be easy to use for most people.  Multi-pathed and
7 feedback pipelines are the most complex.
8
9 A simple commandline looks like:
10
11  ./launch disksrc demo.mp3 | mp3parse | mpg123 | osssink
12
13 A more complex pipeline looks like:
14
15  ./launch disksrc redpill.vob | css-descramble | private_stream_1.0| \
16   (ac3parse | ac3dec | audioink-oss) video_0| (mpeg2dec | videosink)
17
18
19 gstreamer-complete
20 ==================
21
22 This is a simple utility which provides custom bash completion when
23 typing gstreamer-launch commands.
24
25 Simply run "gstreamer-compprep" to build the registry of completions, and
26 then put, in your .bashrc,
27 "complete -C gstreamer-complete gstreamer-launch"
28 (ensuring that gstreamer-complete is on your path).
29
30 You can then enjoy context sensitive tab-completion of gstreamer-launch
31 commands.
32
33
34 gstreamer-register
35 ==================
36
37 This tool will perform an introspection on all available plugins and will
38 create a registry file in /etc/gstreamer/reg.xml. Startup time will be
39 much faster since the gstreamer core doesn't have to bring all the plugins 
40 files into memory at startup.
41
42
43 gstreamer-inspect
44 =================
45
46 Allows you to check the properties of plugins and elements.
47
48  ./gstreamer-inspect 
49  
50 will show all the plugins available and the elements they contain.
51
52  ./gstreamer-inspect <pluginname/elementname>
53
54 shows more info about the plugin/element.
55
56