po/, docs/gst/: Commit automatic changes to docs and po files.
[platform/upstream/gstreamer.git] / docs / gst / tmpl / gstelementfactory.sgml
1 <!-- ##### SECTION Title ##### -->
2 GstElementFactory
3
4 <!-- ##### SECTION Short_Description ##### -->
5 Create GstElements from a factory
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9 GstElementFactory is used to create instances of elements. A GstElementfactory
10 can be added to a #GstPlugin as it is also a #GstPluginFeature.
11 </para>
12 <para>
13 Use gst_element_factory_new() to create a new factory which can be added to a plugin 
14 with gst_plugin_add_feature().
15 </para>
16 <para>
17 gst_element_factory_add_pad_template() is used to add a padtemplate to the factory.
18 This function will enable the application to query for elementfactories that handle
19 a specific media type.
20 </para>
21 <para>
22 Use the gst_element_factory_find() and gst_element_factory_create() functions
23 to create element instances or use gst_element_factory_make() as a convenient 
24 shortcut.
25 </para>
26 <para>
27 The following code example shows you how to create a GstFileSrc element.
28 </para>
29
30 <para>
31   <programlisting role="C">
32   #include &lt;gst/gst.h&gt;
33
34   GstElement *src;
35   GstElementFactory *srcfactory;
36
37   gst_init(&amp;argc,&amp;argv);
38
39   srcfactory = gst_element_factory_find("filesrc");
40   g_return_if_fail(srcfactory != NULL);
41
42   src = gst_element_factory_create(srcfactory,"src");
43   g_return_if_fail(src != NULL);
44   ...
45   </programlisting>
46 </para>
47 <para>
48 An elementfactory can be assigned a rank with gst_element_factory_set_rank() 
49 so that the autopluggers can select a plugin more appropriatly
50 </para>
51
52 <!-- ##### SECTION See_Also ##### -->
53 <para>
54 #GstElement, #GstPlugin, #GstPluginFeature, #GstPadTemplate.
55 </para>
56
57 <!-- ##### STRUCT GstElementFactory ##### -->
58 <para>
59
60 </para>
61
62
63 <!-- ##### FUNCTION gst_element_register ##### -->
64 <para>
65
66 </para>
67
68 @plugin: 
69 @name: 
70 @rank: 
71 @type: 
72 @Returns: 
73 <!-- # Unused Parameters # -->
74 @elementname: 
75
76
77 <!-- ##### FUNCTION gst_element_factory_find ##### -->
78 <para>
79
80 </para>
81
82 @name: 
83 @Returns: 
84
85
86 <!-- ##### FUNCTION gst_element_factory_get_element_type ##### -->
87 <para>
88
89 </para>
90
91 @factory: 
92 @Returns: 
93
94
95 <!-- ##### FUNCTION gst_element_factory_get_longname ##### -->
96 <para>
97
98 </para>
99
100 @factory: 
101 @Returns: 
102
103
104 <!-- ##### FUNCTION gst_element_factory_get_klass ##### -->
105 <para>
106
107 </para>
108
109 @factory: 
110 @Returns: 
111
112
113 <!-- ##### FUNCTION gst_element_factory_get_description ##### -->
114 <para>
115
116 </para>
117
118 @factory: 
119 @Returns: 
120
121
122 <!-- ##### FUNCTION gst_element_factory_get_author ##### -->
123 <para>
124
125 </para>
126
127 @factory: 
128 @Returns: 
129
130
131 <!-- ##### FUNCTION gst_element_factory_get_num_pad_templates ##### -->
132 <para>
133
134 </para>
135
136 @factory: 
137 @Returns: 
138
139
140 <!-- ##### FUNCTION gst_element_factory_get_pad_templates ##### -->
141 <para>
142
143 </para>
144
145 @factory: 
146 @Returns: 
147
148
149 <!-- ##### FUNCTION gst_element_factory_get_uri_type ##### -->
150 <para>
151
152 </para>
153
154 @factory: 
155 @Returns: 
156
157
158 <!-- ##### FUNCTION gst_element_factory_get_uri_protocols ##### -->
159 <para>
160
161 </para>
162
163 @factory: 
164 @Returns: 
165
166
167 <!-- ##### FUNCTION gst_element_factory_create ##### -->
168 <para>
169
170 </para>
171
172 @factory: 
173 @name: 
174 @Returns: 
175
176
177 <!-- ##### FUNCTION gst_element_factory_make ##### -->
178 <para>
179
180 </para>
181
182 @factoryname: 
183 @name: 
184 @Returns: 
185
186