updates
[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
45 <!-- ##### FUNCTION gst_registry_load ##### -->
46 <para>
47
48 </para>
49
50 @registry: 
51 @Returns: 
52
53
54 <!-- ##### FUNCTION gst_registry_is_loaded ##### -->
55 <para>
56
57 </para>
58
59 @registry: 
60 @Returns: 
61
62
63 <!-- ##### FUNCTION gst_registry_save ##### -->
64 <para>
65
66 </para>
67
68 @registry: 
69 @Returns: 
70
71
72 <!-- ##### FUNCTION gst_registry_rebuild ##### -->
73 <para>
74
75 </para>
76
77 @registry: 
78 @Returns: 
79
80
81 <!-- ##### FUNCTION gst_registry_unload ##### -->
82 <para>
83
84 </para>
85
86 @registry: 
87 @Returns: 
88
89
90 <!-- ##### FUNCTION gst_registry_add_path ##### -->
91 <para>
92
93 </para>
94
95 @registry: 
96 @path: 
97
98
99 <!-- ##### FUNCTION gst_registry_get_path_list ##### -->
100 <para>
101
102 </para>
103
104 @registry: 
105 @Returns: 
106
107
108 <!-- ##### FUNCTION gst_registry_clear_paths ##### -->
109 <para>
110
111 </para>
112
113 @registry: 
114
115
116 <!-- ##### FUNCTION gst_registry_add_plugin ##### -->
117 <para>
118
119 </para>
120
121 @registry: 
122 @plugin: 
123 @Returns: 
124
125
126 <!-- ##### FUNCTION gst_registry_remove_plugin ##### -->
127 <para>
128
129 </para>
130
131 @registry: 
132 @plugin: 
133
134
135 <!-- ##### FUNCTION gst_registry_find_plugin ##### -->
136 <para>
137
138 </para>
139
140 @registry: 
141 @name: 
142 @Returns: 
143
144
145 <!-- ##### FUNCTION gst_registry_find_feature ##### -->
146 <para>
147
148 </para>
149
150 @registry: 
151 @name: 
152 @type: 
153 @Returns: 
154
155
156 <!-- ##### FUNCTION gst_registry_load_plugin ##### -->
157 <para>
158
159 </para>
160
161 @registry: 
162 @plugin: 
163 @Returns: 
164
165
166 <!-- ##### FUNCTION gst_registry_unload_plugin ##### -->
167 <para>
168
169 </para>
170
171 @registry: 
172 @plugin: 
173 @Returns: 
174
175
176 <!-- ##### FUNCTION gst_registry_update_plugin ##### -->
177 <para>
178
179 </para>
180
181 @registry: 
182 @plugin: 
183 @Returns: 
184
185