ruby-****@sourc*****
ruby-****@sourc*****
2004年 3月 2日 (火) 05:53:16 JST
-------------------------
REMOTE_ADDR = 217.117.55.140
REMOTE_HOST =
URL = http://ruby-gnome2.sourceforge.jp/?Gst%3A%3ARegistry
-------------------------
= class Gst::Registry
Abstract class for managing plugins.
+ == Object Hierarchy
+ * Object
+ * GLib::Instantiatable
+ * GLib::Object
+ * Gst::Registry
+
== Class Methods
- --- Gst::Registry.add(aRegistry, aPriority)
- Add the registry to the pool with the given priority (as a Fixnum).
+ --- Gst::Registry.add(registry, priority)
+ Adds the registry to the pool with the given priority.
+ * priority: the priority (as a Fixnum).
+ * registry: a Gst::Registry.
+ * Returns: always nil.
- --- Gst::Registry.add_plugin(aPlugin)
- Add the plugin to the global pool of plugins.
+ --- Gst::Registry.add_plugin(plugin)
+ Adds the plugin to the global pool of plugins.
+ * plugin: a Gst::Plugin.
+ * Returns: always nil.
- --- Gst::Registry.each { |aRegistryObject| block }
+ --- Gst::Registry.each { |registry| ... } -> nil
Calls the block for each registries in the pool, passing a reference to
the Gst::Registry as parameter.
-
- Always returns nil.
+ * Returns: always nil.
- --- Gst::Registry.each_feature(aFeatureType) { |aPluginFeature| block }
+ --- Gst::Registry.each_feature(feature_type) { |plugin_feature| ... }
Calls the block for each plugin features of the given type in the pool,
passing a reference to the Gst::PluginFeature as parameter.
-
- Valid class types are:
- * Gst::AutoplugFactory;
- * Gst::ElementFactory;
- * Gst::IndexFactory;
- * Gst::SchedulerFactory;
- * Gst::TypeFactory.
-
- Always returns nil.
+ Valid features types are:
+ * Gst::AutoplugFactory;
+ * Gst::ElementFactory;
+ * Gst::IndexFactory;
+ * Gst::SchedulerFactory;
+ * Gst::TypeFactory.
+ * Returns: always nil.
- --- Gst::Registry.each_plugin { |aPlugin| block }
+ --- Gst::Registry.each_plugin { |plugin| ... }
Calls the block for each plugin in the pool, passing a reference to
the Gst::Plugin as parameter.
-
- Always returns nil.
+ * Returns: always nil.
- --- Gst::Registry.find_feature(aName, aFeatureType)
- Find the plugin feature with the given name and type from the pool of
+ --- Gst::Registry.find_feature(feature_name, feature_type)
+ Finds the plugin feature with the given name and type from the pool of
registries, as a Gst::PluginFeature reference.
-
- Returns nil if the named plugin feature is not found.
-
- Valid class types are:
- * Gst::AutoplugFactory;
- * Gst::ElementFactory;
- * Gst::IndexFactory;
- * Gst::SchedulerFactory;
- * Gst::TypeFactory.
+ Valid features types are:
+ * Gst::AutoplugFactory;
+ * Gst::ElementFactory;
+ * Gst::IndexFactory;
+ * Gst::SchedulerFactory;
+ * Gst::TypeFactory.
+ * feature_name: a name of a feature.
+ * feature_type: a type of a feature.
+ * Returns: a Gst::PluginFeature reference, or nil if the named plugin feature is not found.
- --- Gst::Registry.find_plugin(aNameString)
- Find the plugin with the given name in the registry.
- If founds, returns a reference to the Gst::Plugin object, otherwise
- returns nil.
+ --- Gst::Registry.find_plugin(name)
+ Finds the plugin with the given name in the registry.
+ * name: a plugin name.
+ * Returns: a reference to the Gst::Plugin object if found, otherwise returns nil.
- --- Gst::Registry.get_features(aFeatureType)
- Get a list of all plugin features of the given type in the pool, as
- an array of Gst::PluginFeature objects.
-
- Valid class types are:
- * Gst::AutoplugFactory;
- * Gst::ElementFactory;
- * Gst::IndexFactory;
- * Gst::SchedulerFactory;
- * Gst::TypeFactory.
+ --- Gst::Registry.get_features(feature_type)
+ Gets a list of all plugin features of the given type in the pool.
+ Valid features types are:
+ * Gst::AutoplugFactory;
+ * Gst::ElementFactory;
+ * Gst::IndexFactory;
+ * Gst::SchedulerFactory;
+ * Gst::TypeFactory.
+ * feature_type: a feature type.
+ * Returns: an array of Gst::PluginFeature objects.
- --- Gst::Registry.get_prefered(someFlags)
- Get the prefered registry with the given flags.
- Valid flags are:
- * Gst::Registry::READABLE;
- * Gst::Registry::WRITABLE;
- * Gst::Registry::EXISTS;
- * Gst::Registry::REMOVE;
- * Gst::Registry::DELAYED_LOADING.
+ --- Gst::Registry.get_prefered(flags)
+ This method returns the prefered registry with the given flags.
+ * flags: registry flags (see ((<GstRegistryFlags|Gst::Registry#GstRegistryFlags>))).
+ * Returns: the prefered registry with the given flags.
- --- Gst::Registry.load_all
- Load all the registries in the pool.
+ --- Gst::Registry.load_all
+ Loads all the registries in the pool.
Registries with the Gst::Registry::DELAYED_LOADING flag on will not be loaded.
+ * Returns: always nil.
- --- Gst::Registry.plugins
- Get a list of all plugins in the pool, in an array of Gst::Plugin objects.
+ --- Gst::Registry.plugins
+ Gets a list of all plugins in the pool.
+ * Returns: an array of Gst::Plugin objects.
- --- Gst::Registry.registries
- Gets a list of all registries in the pool, in an Array
- of Gst::Registry objects.
+ --- Gst::Registry.registries
+ Gets a list of all registries in the pool.
+ * Returns: an Array of Gst::Registry objects.
- --- Gst::Registry.remove(aRegistry)
- Remove the registry from the pool.
+ --- Gst::Registry.remove(registry)
+ Removes the registry from the pool.
+ * registry: a Gst::Registry.
+ * Returns: always nil.
-
== Instance Methods
- --- add_path(aPath)
- Add the given path (as a String) to the registry.
+ --- add_path(path)
+ Add the given path to the registry.
The syntax of the path is specific to the registry.
If the path has already been added, do nothing.
+ * path: a path (a String object).
+ * Returns: self.
- --- add_plugin(aPlugin)
- Add a plugin (as a Gst::Plugin reference) to the registry.
- The 'plugin-added' signal will be emitted.
-
- Returns true on success, false otherwise.
+ --- add_plugin(plugin)
+ Adds a plugin to the registry. The 'plugin-added' signal will be emitted.
+ * plugin: a Gst::Plugin.
+ * Returns: true on success, false otherwise.
- --- clear_paths
- Clear the paths of the registry.
+ --- clear_paths
+ Clears the paths of the registry.
+ * Returns: self.
- --- details
- Gets some details about the registry, as a String.
- Returns nil if the registry has no details.
+ --- details
+ This method returns some details about the registry, or nil if the registry has no details.
+ * Returns: some details about the registry, or nil if the registry has no details.
- --- each_path { |aString| block }
+ --- each_path { |path| ... }
Calls the block for each path of the registry, passing a reference to
- the path String as parameter.
-
- Always returns nil.
+ the path (a String object) as parameter.
+ * Returns: always nil.
- --- find_feature(aName, aFeatureType)
- Find the plugin feature with the given name and type in the registry,
- as a Gst::PluginFeature reference. Returns nil if the named plugin
- feature is not found.
-
- Valid class types are:
- * Gst::AutoplugFactory;
- * Gst::ElementFactory;
- * Gst::IndexFactory;
- * Gst::SchedulerFactory;
- * Gst::TypeFactory.
+ --- find_feature(feature_name, feature_type)
+ Finds the plugin feature with the given name and type in the registry.
+ Valid features types are:
+ * Gst::AutoplugFactory;
+ * Gst::ElementFactory;
+ * Gst::IndexFactory;
+ * Gst::SchedulerFactory;
+ * Gst::TypeFactory.
+ * feature_name: a feature name.
+ * feature_type: a feature type.
+ * Returns: a reference to a Gst::PluginFeature on success, or nil if the named plugin feature is not found.
- --- find_plugin(aName)
- Find the plugin with the given name (as a String) in the registry.
- Returns a reference to a Gst::Plugin object if found,
- otherwise returns nil.
+ --- find_plugin(name)
+ Finds the plugin with the given name in the registry.
+ * name: a plugin name.
+ * Returns: a reference to a Gst::Plugin object if found, otherwise returns nil.
- --- load
- Load the registry. Returns true on success, otherwise false.
+ --- load
+ Loads the registry.
+ * Returns: true on success, otherwise false.
- --- load_plugin(aPlugin)
- Bring the plugin (as a Gst::Plugin reference) from the registry into
- memory.
-
- Returns a Fixnum code indicating the result, which may be:
- * Gst::Registry::OK;
- * Gst::Registry::LOAD_ERROR;
- * Gst::Registry::SAVE_ERROR;
- * Gst::Registry::PLUGIN_LOAD_ERROR;
- * Gst::Registry::PLUGIN_SIGNATURE_ERROR.
+ --- load_plugin(plugin)
+ Brings the specified plugin from the registry into memory.
+ * plugin: a Gst::Plugin.
+ * Returns: a code indicating the result (see ((<GstRegistryReturn|Gst::Registry#GstRegistryReturn>))).
- --- loaded?
- Checks if the registry is currently loaded.
+ --- loaded?
+ This method returns true if the registry is currently loaded, false otherwise.
+ * Returns: true if the registry is currently loaded, false otherwise.
- --- name
- Gets the name of the registry, as a String.
+ --- name
+ This method returns the name of the registry.
+ * Returns: the name of the registry.
- --- paths
- Gets a list of paths of the registry, in an Array of String objects.
+ --- paths
+ Gets a list of paths of the registry.
+ * Returns: an array of strings.
- --- rebuild
- Rebuild the registry. Returns true on success, otherwise false.
+ --- rebuild
+ Rebuilds the registry.
+ * Returns: true on success, otherwise false.
- --- remove_plugin(aPlugin)
- Remove a plugin (as a Gst::Plugin reference) from the registry.
+ --- remove_plugin(plugin)
+ Removes a plugin from the registry.
+ * plugin: a Gst::Plugin.
+ * Returns: self.
- --- save
- Save the contents of the registry. Returns true on success,
- otherwise false.
+ --- save
+ Saves the contents of the registry.
+ * Returns: true on success, otherwise false.
- --- unload
- Unload the registry. Returns true on success, otherwise false.
+ --- unload
+ Unloads the registry.
+ * Returns: true on success, otherwise false.
- --- unload_plugin(aPlugin)
- Unload a plugin (as a Gst::Plugin reference) from the registry.
-
- Returns a Fixnum code indicating the result, which may be:
- * Gst::Registry::OK;
- * Gst::Registry::LOAD_ERROR;
- * Gst::Registry::SAVE_ERROR;
- * Gst::Registry::PLUGIN_LOAD_ERROR;
- * Gst::Registry::PLUGIN_SIGNATURE_ERROR.
+ --- unload_plugin(plugin)
+ Unloads a plugin from the registry.
+ * plugin: a Gst::Plugin.
+ * Returns: a code indicating the result (see ((<GstRegistryReturn|Gst::Registry#GstRegistryReturn>))).
- --- update_plugin(aPlugin)
- Unload a plugin (as a Gst::Plugin reference) in the registry.
-
- Returns a Fixnum code indicating the result, which may be:
- * Gst::Registry::OK;
- * Gst::Registry::LOAD_ERROR;
- * Gst::Registry::SAVE_ERROR;
- * Gst::Registry::PLUGIN_LOAD_ERROR;
- * Gst::Registry::PLUGIN_SIGNATURE_ERROR.
+ --- update_plugin(plugin)
+ Updates a plugin in the registry.
+ * plugin: a Gst::Plugin.
+ * Returns: a code indicating the result (see ((<GstRegistryReturn|Gst::Registry#GstRegistryReturn>))).
-
== Constants
+ === GstRegistryFlags
--- DELAYED_LOADING
- The registry will be loaded on demand.
-
--- EXISTS
- The registry exists.
+ --- READABLE
+ --- REMOTE
+ --- WRITABLE
+ === GstRegistryReturn
--- LOAD_ERROR
- There was a load error.
-
--- OK
- The registry reported no error.
-
--- PLUGIN_LOAD_ERROR
- There was an error loading a plugin.
-
--- PLUGIN_SIGNATURE_ERROR
- There was an error saving a plugin.
-
- --- READABLE
- The registry can be read.
-
- --- REMOTE
- The registry is remote and might be slower.
-
--- SAVE_ERROR
- There was an error saving the registry.
- --- WRITABLE
- The registry can be written to.
-
-
== Signals
--- plugin-added
+
+ == See Also
+ ((<Gst>)).
- ((<lrz>))