af8c1a1b6bb718d5e68d523bb590f2853bdff86a
[platform/upstream/gstreamer.git] / docs / gst / tmpl / gstregistry.sgml
1 <!-- ##### SECTION Title ##### -->
2 GstRegistry
3
4 <!-- ##### SECTION Short_Description ##### -->
5 Abstract class for managing plugins.
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9 The registry holds the available plugins in the system.
10 </para>
11
12 <!-- ##### SECTION See_Also ##### -->
13 <para>
14 #GstPlugin, #GstPluginFeature
15 </para>
16
17 <!-- ##### ENUM GstRegistryReturn ##### -->
18 <para>
19 The return value of registry operations
20 </para>
21
22 @GST_REGISTRY_OK: The registry reported no error.
23 @GST_REGISTRY_LOAD_ERROR: There was a load error
24 @GST_REGISTRY_SAVE_ERROR: There was an error saving the registry
25 @GST_REGISTRY_PLUGIN_LOAD_ERROR: There was an error loading a plugin
26 @GST_REGISTRY_PLUGIN_SIGNATURE_ERROR: There was an error saving a plugin
27
28 <!-- ##### ENUM GstRegistryFlags ##### -->
29 <para>
30 Flags for the registry
31 </para>
32
33 @GST_REGISTRY_READABLE: The registry can be read
34 @GST_REGISTRY_WRITABLE: The registry can be written to
35 @GST_REGISTRY_EXISTS: The registry exists
36 @GST_REGISTRY_REMOTE: The registry is remote and might be slower
37 @GST_REGISTRY_DELAYED_LOADING: The registry will be loaded on demand.
38
39 <!-- ##### STRUCT GstRegistry ##### -->
40 <para>
41 The registry object
42 </para>
43
44 @object: 
45 @priority: 
46 @flags: 
47 @name: 
48 @details: 
49 @loaded: 
50 @plugins: 
51 @paths: 
52 @_gst_reserved: 
53
54 <!-- ##### FUNCTION gst_registry_load ##### -->
55 <para>
56
57 </para>
58
59 @registry: 
60 @Returns: 
61
62
63 <!-- ##### FUNCTION gst_registry_is_loaded ##### -->
64 <para>
65
66 </para>
67
68 @registry: 
69 @Returns: 
70
71
72 <!-- ##### FUNCTION gst_registry_save ##### -->
73 <para>
74
75 </para>
76
77 @registry: 
78 @Returns: 
79
80
81 <!-- ##### FUNCTION gst_registry_rebuild ##### -->
82 <para>
83
84 </para>
85
86 @registry: 
87 @Returns: 
88
89
90 <!-- ##### FUNCTION gst_registry_unload ##### -->
91 <para>
92
93 </para>
94
95 @registry: 
96 @Returns: 
97
98
99 <!-- ##### FUNCTION gst_registry_add_path ##### -->
100 <para>
101
102 </para>
103
104 @registry: 
105 @path: 
106
107
108 <!-- ##### FUNCTION gst_registry_get_path_list ##### -->
109 <para>
110
111 </para>
112
113 @registry: 
114 @Returns: 
115
116
117 <!-- ##### FUNCTION gst_registry_clear_paths ##### -->
118 <para>
119
120 </para>
121
122 @registry: 
123
124
125 <!-- ##### FUNCTION gst_registry_add_plugin ##### -->
126 <para>
127
128 </para>
129
130 @registry: 
131 @plugin: 
132 @Returns: 
133
134
135 <!-- ##### FUNCTION gst_registry_remove_plugin ##### -->
136 <para>
137
138 </para>
139
140 @registry: 
141 @plugin: 
142
143
144 <!-- ##### FUNCTION gst_registry_find_plugin ##### -->
145 <para>
146
147 </para>
148
149 @registry: 
150 @name: 
151 @Returns: 
152
153
154 <!-- ##### FUNCTION gst_registry_find_feature ##### -->
155 <para>
156
157 </para>
158
159 @registry: 
160 @name: 
161 @type: 
162 @Returns: 
163
164
165 <!-- ##### FUNCTION gst_registry_load_plugin ##### -->
166 <para>
167
168 </para>
169
170 @registry: 
171 @plugin: 
172 @Returns: 
173
174
175 <!-- ##### FUNCTION gst_registry_unload_plugin ##### -->
176 <para>
177
178 </para>
179
180 @registry: 
181 @plugin: 
182 @Returns: 
183
184
185 <!-- ##### FUNCTION gst_registry_update_plugin ##### -->
186 <para>
187
188 </para>
189
190 @registry: 
191 @plugin: 
192 @Returns: 
193
194