summaryrefslogtreecommitdiff
path: root/docs/gst/gstreamer-docs.sgml
blob: 9f52596507c26b8135d5857e8815fc410c4bb3dd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [

<!entity gstreamer-cothreads SYSTEM "sgml/cothreads.sgml">
<!entity Gst SYSTEM "sgml/gst.sgml">
<!entity GstInfo SYSTEM "sgml/gstinfo.sgml">
<!entity GstBin SYSTEM "sgml/gstbin.sgml">
<!entity GstBuffer SYSTEM "sgml/gstbuffer.sgml">
<!entity GstBufferPool SYSTEM "sgml/gstbufferpool.sgml">
<!entity GstCpu SYSTEM "sgml/gstcpu.sgml">
<!entity GstElement SYSTEM "sgml/gstelement.sgml">
<!entity GstLog SYSTEM "sgml/gstlog.sgml">
<!entity GstMeta SYSTEM "sgml/gstmeta.sgml">
<!entity GstObject SYSTEM "sgml/gstobject.sgml">
<!entity GstPad SYSTEM "sgml/gstpad.sgml">
<!entity GstPipeline SYSTEM "sgml/gstpipeline.sgml">
<!entity GstAutoplug SYSTEM "sgml/gstautoplug.sgml">
<!entity GstParse SYSTEM "sgml/gstparse.sgml">
<!entity GstPlugin SYSTEM "sgml/gstplugin.sgml">
<!entity GstThread SYSTEM "sgml/gstthread.sgml">
<!entity GstTrace SYSTEM "sgml/gsttrace.sgml">
<!entity GstType SYSTEM "sgml/gsttype.sgml">
<!entity GstCaps SYSTEM "sgml/gstcaps.sgml">
<!entity GstProps SYSTEM "sgml/gstprops.sgml">
<!entity GstUtils SYSTEM "sgml/gstutils.sgml">
<!entity GstXML SYSTEM "sgml/gstxml.sgml">
<!entity GstQueue SYSTEM "sgml/gstqueue.sgml">
<!entity GstTypeFind SYSTEM "sgml/gsttypefind.sgml">
<!entity cothreads SYSTEM "sgml/cothreads.sgml">

<!entity GstFakeSrc SYSTEM "sgml/gstfakesrc.sgml">
<!entity GstFakeSink SYSTEM "sgml/gstfakesink.sgml">
<!entity GstDiskSrc SYSTEM "sgml/gstdisksrc.sgml">
<!entity GstAsyncDiskSrc SYSTEM "sgml/gstasyncdisksrc.sgml">
<!entity GstHttpSrc SYSTEM "sgml/gsthttpsrc.sgml">
<!entity GstFdSrc SYSTEM "sgml/gstfdsrc.sgml">
<!entity GstAudioSrc SYSTEM "sgml/gstaudiosrc.sgml">
<!entity GstSineSrc SYSTEM "sgml/gstsinesrc.sgml">
<!entity GstAudioSink SYSTEM "sgml/gstaudiosink.sgml">
<!entity GstFdSink SYSTEM "sgml/gstfdsink.sgml">
<!entity GstIdentity SYSTEM "sgml/gstidentity.sgml">
<!entity GstPipefilter SYSTEM "sgml/gstpipefilter.sgml">
<!entity GstTee SYSTEM "sgml/gsttee.sgml">

<!entity audioraw SYSTEM "sgml/audioraw.sgml">
<!entity spectrum SYSTEM "sgml/spectrum.sgml">
<!entity videoraw SYSTEM "sgml/videoraw.sgml">

<!entity gstreamer-tree-index SYSTEM "sgml/tree_index.sgml">
]>


<book>
  <bookinfo>
    <title>GStreamer Library Reference Manual (Core)</title>
  </bookinfo>
  <chapter id="gstreamer">
    <title>GStreamer Core Library</title>

    <para>libgst.la provides all the core GStreamer services,
including initialization, plugin management, types and metadata, as 
well as the object hiarchy that defines elements and bins, along
with some more specialized elements.</para>

    &Gst;
    &GstAutoplug;
    &GstBin;
    &GstBuffer;
    &GstBufferPool;
    &GstCaps;
    &GstCpu;
    &GstElement;
    &GstInfo;
    &GstMeta;
    &GstObject;
    &GstPad;
    &GstParse;
    &GstPipeline;
    &GstPlugin;
    &GstProps;
    &GstQueue;
    &GstThread;
    &GstTrace;
    &GstType;
    &GstTypeFind;
    &GstUtils;
    &GstXML;

    &cothreads;
  </chapter>

  <chapter id="element-types">
    <title>GStreamer Standard Elements</title>

    <para>
      libgstelements.la provide some basic elements like a disk source
      and sink. The use of these elements is strictly though the gtk_object_get() and
      gtk_object_set() functions and the GStreamer Core Library functions.
    </para>
    <para>
      Use the gst_elementfactory_find() and gst_elementfactory_create() functions
      to create these elements. 
    </para>
    <para>
      The following code example shows you how to create a GstDiskSrc element.
    </para>

    <para>
    <programlisting role="C">
      #include &lt;gst/gst.h&gt;

      GstElement *src;
      GstElementFactory *srcfactory;

      gst_init(&amp;argc,&amp;argv);

      srcfactory = gst_elementfactory_find("disksrc");
      g_return_if_fail(srcfactory != NULL);
      src = gst_elementfactory_create(srcfactory,"src");
      g_return_if_fail(src != NULL);
      ...
    </programlisting>
    </para>

    &GstFakeSrc;
    &GstFakeSink;

    &GstDiskSrc;
    &GstAsyncDiskSrc;
    &GstHttpSrc;
    
    &GstAudioSrc;
    &GstAudioSink;

    &GstSineSrc;

    &GstFdSrc;
    &GstFdSink;

    &GstPipefilter;
    &GstIdentity;

    &GstTee;
  </chapter>

  <chapter id="metatdata-types">
    <title>GStreamer MetaData Types</title>

    <para>MetaData is used to specify the content of buffers. See <classname>GstMeta</classname>. </para>

    &spectrum;
    &audioraw;
    &videoraw;
  </chapter>

  <chapter id="gst-index">
    <title>Index</title>

    <sect1>
      <title>Object Hierarchy</title>
      &gstreamer-tree-index;
    </sect1>
  </chapter>
</book>