3e31202d06ab29207be0a8a2c47e299d0a5fc969
[platform/upstream/gstreamer.git] / docs / gst / tmpl / gst.sgml
1 <!-- ##### SECTION Title ##### -->
2 Gstreamer
3
4 <!-- ##### SECTION Short_Description ##### -->
5 Media library supporting arbitrary formats and filter graphs.
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9 GStreamer is a framework for constructing graphs of various filters
10 (termed elements here) that will handle streaming media.  Any discreet
11 (packetizable) media type is supported, with provisions for automatically
12 determining source type.  Metadata can be passed with all data to provide
13 formatting/framing information.  Plugins are heavily used to provide for
14 all elements, allowing one to construct plugins outside of the GST
15 library, even released binary-only if license require (please don't).
16 </para>
17
18 <para>
19 GStreamer borrows heavily from both the <ulink 
20 url="http://www.cse.ogi.edu/sysl/">OGI media pipeline</ulink> and
21 Microsoft's DirectShow, hopefully taking the best of both and leaving the
22 cruft behind.  Its interface is still very fluid (I've redesigned the
23 metadata handling twice already), and thus can be changed to increase the
24 sanity/noise ratio.
25 </para>
26
27 <!-- ##### SECTION See_Also ##### -->
28 <para>
29 Check out both <ulink url="http://www.cse.ogi.edu/sysl/">OGI's
30 pipeline</ulink> and Microsoft's DirectShow for some background.
31 </para>
32
33 <!-- ##### FUNCTION gst_init ##### -->
34 <para>
35
36 </para>
37
38 @argc: 
39 @argv: 
40
41
42 <!-- ##### FUNCTION gst_version ##### -->
43 <para>
44
45 </para>
46
47 @major: 
48 @minor: 
49 @micro: 
50
51
52 <!-- ##### FUNCTION gst_main ##### -->
53 <para>
54
55 </para>
56
57
58
59 <!-- ##### FUNCTION gst_main_quit ##### -->
60 <para>
61
62 </para>
63
64
65
66 <!-- ##### MACRO GST_VERSION_MAJOR ##### -->
67 <para>
68 The major version of GStreamer at compile time
69 </para>
70
71
72
73 <!-- ##### MACRO GST_VERSION_MINOR ##### -->
74 <para>
75 The minor version of GStreamer at compile time
76 </para>
77
78
79
80 <!-- ##### MACRO GST_VERSION_MICRO ##### -->
81 <para>
82 The micro version of GStreamer at compile time
83 </para>
84
85
86