summaryrefslogtreecommitdiff
path: root/docs/gst/tmpl/gstplugin.sgml
blob: 1b67696aa1c03d899bc0797d7c2726acc3ea3f95 (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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
<!-- ##### SECTION Title ##### -->
GstPlugin

<!-- ##### SECTION Short_Description ##### -->
Dynamically loadable Elements

<!-- ##### SECTION Long_Description ##### -->
<para>
GStreamer is extensible so <classname>GstElements</classname> can be loaded at runtime. A plugin
system can provide one or more of the following basic <application>GStreamer</application> 
objects factories:
 <itemizedlist>
  <listitem>
   <para>
    A #GstElementFactory: the components to build a pipeline.
   </para>
  </listitem>
  <listitem>
   <para>
    A #GstTypeFactory: A MIME type and an optional typefind function.
   </para>
  </listitem>
  <listitem>
   <para>
    A #GstAutoplugFactory: An object used to automatically construct pipelines.
   </para>
  </listitem>
 </itemizedlist>
</para>
<para>
A new plugin is created with gst_plugin_new(). this function will return a handle
to the GstPlugin or NULL if the plugin could not be created.
</para>
<para>
Once a GstPlugin element has been created, you can add the different types of factories
to it with gst_plugin_add_factory(), gst_plugin_add_type(), gst_plugin_add_autoplugger().
</para>
<para>
<application>Gstreamer</application> plugins should have a method plugin_init that is called
by the loader.
</para>
<para>
use gst_plugin_find(), gst_plugin_get_list(), gst_plugin_get_factory_list(), gst_plugin_get_type_list() and
gst_plugin_get_autoplug_list() to query the plugin repository.
</para>
<para>
Plugins are always automaticlly loaded  so you don't need to call gst_plugin_load() explicitly 
to bring it into memory. 
</para>

<!-- ##### SECTION See_Also ##### -->
<para>
#GstElement, #GstType, #GstAutoplug
</para>

<!-- ##### STRUCT GstPlugin ##### -->
<para>

</para>

@name: 
@longname: 
@filename: 
@types: 
@numtypes: 
@elements: 
@numelements: 
@autopluggers: 
@numautopluggers: 
@loaded: 

<!-- ##### USER_FUNCTION GstPluginInitFunc ##### -->
<para>
A plugin should implement this function called plugin_init. It will be called
by the loader at statup.
</para>

@module: The <classname>GModule</classname> it was loaded from
@plugin: 
@Returns: The plugin or NULL is an error was detected.


<!-- ##### STRUCT GstPluginDesc ##### -->
<para>

</para>

@major_version: 
@minor_version: 
@name: 
@plugin_init: 

<!-- ##### FUNCTION gst_plugin_new ##### -->
<para>

</para>

@name: 
@major: 
@minor: 
@Returns: 


<!-- ##### FUNCTION gst_plugin_set_name ##### -->
<para>

</para>

@plugin: 
@name: 


<!-- ##### FUNCTION gst_plugin_get_name ##### -->
<para>

</para>

@plugin: 
@Returns: 


<!-- ##### FUNCTION gst_plugin_get_longname ##### -->
<para>

</para>

@plugin: 
@Returns: 


<!-- ##### FUNCTION gst_plugin_set_longname ##### -->
<para>

</para>

@plugin: 
@longname: 


<!-- ##### FUNCTION gst_plugin_get_filename ##### -->
<para>

</para>

@plugin: 
@Returns: 


<!-- ##### FUNCTION gst_plugin_is_loaded ##### -->
<para>

</para>

@plugin: 
@Returns: 


<!-- ##### FUNCTION gst_plugin_load_all ##### -->
<para>

</para>



<!-- ##### FUNCTION gst_plugin_load ##### -->
<para>

</para>

@name: 
@Returns: 


<!-- ##### FUNCTION gst_plugin_load_absolute ##### -->
<para>

</para>

@name: 
@Returns: 


<!-- ##### FUNCTION gst_plugin_add_path ##### -->
<para>

</para>

@path: 


<!-- ##### FUNCTION gst_library_load ##### -->
<para>

</para>

@name: 
@Returns: 


<!-- ##### FUNCTION gst_plugin_add_factory ##### -->
<para>

</para>

@plugin: 
@factory: 


<!-- ##### FUNCTION gst_plugin_add_type ##### -->
<para>

</para>

@plugin: 
@factory: 


<!-- ##### FUNCTION gst_plugin_add_autoplugger ##### -->
<para>

</para>

@plugin: 
@factory: 


<!-- ##### FUNCTION gst_plugin_find ##### -->
<para>

</para>

@name: 
@Returns: 


<!-- ##### FUNCTION gst_plugin_get_list ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION gst_plugin_get_factory_list ##### -->
<para>

</para>

@plugin: 
@Returns: 


<!-- ##### FUNCTION gst_plugin_get_type_list ##### -->
<para>

</para>

@plugin: 
@Returns: 


<!-- ##### FUNCTION gst_plugin_get_autoplug_list ##### -->
<para>

</para>

@plugin: 
@Returns: 


<!-- ##### FUNCTION gst_plugin_load_elementfactory ##### -->
<para>

</para>

@name: 
@Returns: 


<!-- ##### FUNCTION gst_plugin_load_typefactory ##### -->
<para>

</para>

@mime: 


<!-- ##### FUNCTION gst_plugin_load_autoplugfactory ##### -->
<para>

</para>

@name: 
@Returns: 


<!-- ##### FUNCTION gst_plugin_load_thyself ##### -->
<para>

</para>

@parent: 


<!-- ##### FUNCTION gst_plugin_save_thyself ##### -->
<para>

</para>

@parent: 
@Returns: