gstreamer/docs/gst/tmpl/gstregistry.sgml
Stefan Kost e719825726 more api documentation better error signaling and logging
Original commit message from CVS:
more api documentation
better error signaling and logging
2004-10-13 13:03:25 +00:00

273 lines
3.5 KiB
Text

<!-- ##### SECTION Title ##### -->
GstRegistry
<!-- ##### SECTION Short_Description ##### -->
Abstract base class for management of #GstPlugin objects.
<!-- ##### SECTION Long_Description ##### -->
<para>
One registry holds the metadata of a set of plugins.
All registries build the #GstRegistryPool.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GstPlugin, #GstPluginFeature
</para>
<!-- ##### STRUCT GstRegistry ##### -->
<para>
</para>
<!-- ##### MACRO GLOBAL_REGISTRY_DIR ##### -->
<para>
</para>
<!-- ##### MACRO GLOBAL_REGISTRY_FILE ##### -->
<para>
</para>
<!-- ##### MACRO GLOBAL_REGISTRY_FILE_TMP ##### -->
<para>
</para>
<!-- ##### MACRO LOCAL_REGISTRY_DIR ##### -->
<para>
</para>
<!-- ##### MACRO LOCAL_REGISTRY_FILE ##### -->
<para>
</para>
<!-- ##### MACRO LOCAL_REGISTRY_FILE_TMP ##### -->
<para>
</para>
<!-- ##### MACRO REGISTRY_DIR_PERMS ##### -->
<para>
</para>
<!-- ##### MACRO REGISTRY_TMPFILE_PERMS ##### -->
<para>
</para>
<!-- ##### MACRO REGISTRY_FILE_PERMS ##### -->
<para>
</para>
<!-- ##### ENUM GstRegistryReturn ##### -->
<para>
The return value of registry operations
</para>
@GST_REGISTRY_OK: The registry reported no error.
@GST_REGISTRY_LOAD_ERROR: There was a load error
@GST_REGISTRY_SAVE_ERROR: There was an error saving the registry
@GST_REGISTRY_PLUGIN_LOAD_ERROR: There was an error loading a plugin
@GST_REGISTRY_PLUGIN_SIGNATURE_ERROR: There was an error saving a plugin
<!-- ##### ENUM GstRegistryFlags ##### -->
<para>
Flags for the registry
</para>
@GST_REGISTRY_READABLE: The registry can be read
@GST_REGISTRY_WRITABLE: The registry can be written to
@GST_REGISTRY_EXISTS: The registry exists
@GST_REGISTRY_REMOTE: The registry is remote and might be slower
@GST_REGISTRY_DELAYED_LOADING: The registry will be loaded on demand.
<!-- ##### FUNCTION gst_registry_load ##### -->
<para>
</para>
@registry:
@Returns:
<!-- ##### FUNCTION gst_registry_is_loaded ##### -->
<para>
</para>
@registry:
@Returns:
<!-- ##### FUNCTION gst_registry_save ##### -->
<para>
</para>
@registry:
@Returns:
<!-- ##### FUNCTION gst_registry_rebuild ##### -->
<para>
</para>
@registry:
@Returns:
<!-- ##### FUNCTION gst_registry_unload ##### -->
<para>
</para>
@registry:
@Returns:
<!-- ##### FUNCTION gst_registry_add_path ##### -->
<para>
</para>
@registry:
@path:
<!-- ##### FUNCTION gst_registry_get_path_list ##### -->
<para>
</para>
@registry:
@Returns:
<!-- ##### FUNCTION gst_registry_clear_paths ##### -->
<para>
</para>
@registry:
<!-- ##### FUNCTION gst_registry_add_plugin ##### -->
<para>
</para>
@registry:
@plugin:
@Returns:
<!-- ##### FUNCTION gst_registry_remove_plugin ##### -->
<para>
</para>
@registry:
@plugin:
<!-- ##### FUNCTION gst_registry_plugin_filter ##### -->
<para>
</para>
@registry:
@filter:
@first:
@user_data:
@Returns:
<!-- ##### FUNCTION gst_registry_feature_filter ##### -->
<para>
</para>
@registry:
@filter:
@first:
@user_data:
@Returns:
<!-- ##### FUNCTION gst_registry_find_plugin ##### -->
<para>
</para>
@registry:
@name:
@Returns:
<!-- ##### FUNCTION gst_registry_find_feature ##### -->
<para>
</para>
@registry:
@name:
@type:
@Returns:
<!-- ##### FUNCTION gst_registry_load_plugin ##### -->
<para>
</para>
@registry:
@plugin:
@Returns:
<!-- ##### FUNCTION gst_registry_unload_plugin ##### -->
<para>
</para>
@registry:
@plugin:
@Returns:
<!-- ##### FUNCTION gst_registry_update_plugin ##### -->
<para>
</para>
@registry:
@plugin:
@Returns: