[ruby-gnome2-doc-cvs] [Hiki] update - Gst::Registry

Zurück zum Archiv-Index

ruby-****@sourc***** ruby-****@sourc*****
2003年 8月 26日 (火) 03:42:10 JST


-------------------------
REMOTE_ADDR = 81.249.77.79
REMOTE_HOST = 
        URL = http://ruby-gnome2.sourceforge.jp/?Gst%3A%3ARegistry
-------------------------
  = class Gst::Registry
  Abstract class for managing plugins.
  
  == Class Methods
+ --- Gst::Registry.add(aRegistry, aPriority) 
+     Add the registry to the pool with the given priority (as a Fixnum).
+ 
+ --- Gst::Registry.add_plugin(aPlugin) 
+     Add the plugin to the global pool of plugins.
+ 
  --- Gst::Registry.each { |aRegistryObject| block } 
      Calls the block for each registries in the pool, passing a reference to
      the Gst::Registry as parameter.
      
      Always returns nil.
  
+ --- Gst::Registry.each_feature(aFeatureType) { |aPluginFeature| block } 
+     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.
+ 
  --- Gst::Registry.each_plugin { |aPlugin| block } 
      Calls the block for each plugin in the pool, passing a reference to
      the Gst::Plugin as parameter.
      
      Always returns nil.
  
+ --- Gst::Registry.find_feature(aName, aFeatureType) 
+     Find 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.
+ 
  --- 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.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_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.load_all 
+     Load all the registries in the pool. 
+     Registries with the Gst::Registry::DELAYED_LOADING flag on will not be loaded.
+ 
  --- Gst::Registry.plugins 
      Get a list of all plugins in the pool, in 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.remove(aRegistry) 
+     Remove the registry from the pool.
  
+ 
  == Instance Methods
+ --- add_path(aPath) 
+     Add the given path (as a String) to the registry. 
+     The syntax of the path is specific to the registry. 
+     If the path has already been added, do nothing.
+ 
+ --- 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.
+ 
+ --- clear_paths 
+     Clear the paths of the registry.
+ 
  --- details 
      Gets some details about the registry, as a String.  
      Returns nil if the registry has no details.
  
  --- each_path { |aString| block } 
      Calls the block for each path of the registry, passing a reference to
      the path String as parameter.
      
      Always returns 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_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.
+ 
+ --- load 
+     Load 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.
+ 
  --- loaded? 
      Checks if the registry is currently loaded.
  
  --- name 
      Gets the name of the registry, as a String.
  
  --- paths 
      Gets a list of paths of the registry, in an Array of String objects.
  
+ --- rebuild 
+     Rebuild the registry.  Returns true on success, otherwise false.
+ 
+ --- remove_plugin(aPlugin) 
+     Remove a plugin (as a Gst::Plugin reference) from the registry.
+ 
+ --- save 
+     Save the contents of the registry.  Returns true on success, 
+     otherwise false.
+ 
+ --- unload 
+     Unload 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.
+ 
+ --- 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.
+ 
+ 
+ == Constants
+ --- DELAYED_LOADING
+     The registry will be loaded on demand.
+ 
+ --- EXISTS
+     The registry exists.
+ 
+ --- 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
  
  - ((<lrz>))





ruby-gnome2-cvs メーリングリストの案内
Zurück zum Archiv-Index