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
  53 <!-- ##### FUNCTION gst_registry_load ##### -->
  54 <para>
  55
  56 </para>
  57
  58 @registry:
  59 @Returns:
  60
  61
  62 <!-- ##### FUNCTION gst_registry_is_loaded ##### -->
  63 <para>
  64
  65 </para>
  66
  67 @registry:
  68 @Returns:
  69
  70
  71 <!-- ##### FUNCTION gst_registry_save ##### -->
  72 <para>
  73
  74 </para>
  75
  76 @registry:
  77 @Returns:
  78
  79
  80 <!-- ##### FUNCTION gst_registry_rebuild ##### -->
  81 <para>
  82
  83 </para>
  84
  85 @registry:
  86 @Returns:
  87
  88
  89 <!-- ##### FUNCTION gst_registry_unload ##### -->
  90 <para>
  91
  92 </para>
  93
  94 @registry:
  95 @Returns:
  96
  97
  98 <!-- ##### FUNCTION gst_registry_add_path ##### -->
  99 <para>
 100
 101 </para>
 102
 103 @registry:
 104 @path:
 105
 106
 107 <!-- ##### FUNCTION gst_registry_get_path_list ##### -->
 108 <para>
 109
 110 </para>
 111
 112 @registry:
 113 @Returns:
 114
 115
 116 <!-- ##### FUNCTION gst_registry_clear_paths ##### -->
 117 <para>
 118
 119 </para>
 120
 121 @registry:
 122
 123
 124 <!-- ##### FUNCTION gst_registry_add_plugin ##### -->
 125 <para>
 126
 127 </para>
 128
 129 @registry:
 130 @plugin:
 131 @Returns:
 132
 133
 134 <!-- ##### FUNCTION gst_registry_remove_plugin ##### -->
 135 <para>
 136
 137 </para>
 138
 139 @registry:
 140 @plugin:
 141
 142
 143 <!-- ##### FUNCTION gst_registry_find_plugin ##### -->
 144 <para>
 145
 146 </para>
 147
 148 @registry:
 149 @name:
 150 @Returns:
 151
 152
 153 <!-- ##### FUNCTION gst_registry_find_feature ##### -->
 154 <para>
 155
 156 </para>
 157
 158 @registry:
 159 @name:
 160 @type:
 161 @Returns:
 162
 163
 164 <!-- ##### FUNCTION gst_registry_load_plugin ##### -->
 165 <para>
 166
 167 </para>
 168
 169 @registry:
 170 @plugin:
 171 @Returns:
 172
 173
 174 <!-- ##### FUNCTION gst_registry_unload_plugin ##### -->
 175 <para>
 176
 177 </para>
 178
 179 @registry:
 180 @plugin:
 181 @Returns:
 182
 183
 184 <!-- ##### FUNCTION gst_registry_update_plugin ##### -->
 185 <para>
 186
 187 </para>
 188
 189 @registry:
 190 @plugin:
 191 @Returns:
 192
 193
 194 <!-- ##### FUNCTION gst_registry_pool_list ##### -->
 195 <para>
 196
 197 </para>
 198
 199 @Returns:
 200
 201
 202 <!-- ##### FUNCTION gst_registry_pool_add ##### -->
 203 <para>
 204
 205 </para>
 206
 207 @registry:
 208 @priority:
 209
 210
 211 <!-- ##### FUNCTION gst_registry_pool_remove ##### -->
 212 <para>
 213
 214 </para>
 215
 216 @registry:
 217
 218
 219 <!-- ##### FUNCTION gst_registry_pool_add_plugin ##### -->
 220 <para>
 221
 222 </para>
 223
 224 @plugin:
 225
 226
 227 <!-- ##### FUNCTION gst_registry_pool_load_all ##### -->
 228 <para>
 229
 230 </para>
 231
 232
 233
 234 <!-- ##### FUNCTION gst_registry_pool_plugin_list ##### -->
 235 <para>
 236
 237 </para>
 238
 239 @Returns:
 240
 241
 242 <!-- ##### FUNCTION gst_registry_pool_feature_list ##### -->
 243 <para>
 244
 245 </para>
 246
 247 @type:
 248 @Returns:
 249
 250
 251 <!-- ##### FUNCTION gst_registry_pool_find_plugin ##### -->
 252 <para>
 253
 254 </para>
 255
 256 @name:
 257 @Returns:
 258
 259
 260 <!-- ##### FUNCTION gst_registry_pool_find_feature ##### -->
 261 <para>
 262
 263 </para>
 264
 265 @name:
 266 @type:
 267 @Returns:
 268
 269
 270 <!-- ##### FUNCTION gst_registry_pool_get_prefered ##### -->
 271 <para>
 272
 273 </para>
 274
 275 @flags:
 276 @Returns:
 277
 278