Changeset 5433:6a6c001574c0 in roaraudio


Ignore:
Timestamp:
03/20/12 13:31:32 (10 years ago)
Author:
phi
Branch:
default
Phase:
public
Message:

updated comments

File:
1 edited

Legend:

Unmodified
Added
Removed
  • include/libroar/plugincontainer.h

    r5432 r5433  
    4444struct roar_plugincontainer * roar_plugincontainer_new(struct roar_dl_librarypara * default_para); 
    4545#endif 
     46 
     47/* Create a new plugin container. 
     48 * Takes host application's appname and abiversion. 
     49 */ 
    4650struct roar_plugincontainer * roar_plugincontainer_new_simple(const char * appname, const char * abiversion); 
    4751 
     52// Increment the refrence counter. 
    4853int roar_plugincontainer_ref(struct roar_plugincontainer * cont); 
     54/* Decrement the refrence counter. 
     55 * Unloads all plugins and frees all resources when there are no refreneces left. 
     56 */ 
    4957int roar_plugincontainer_unref(struct roar_plugincontainer * cont); 
    5058 
    5159/* 
    5260 * stuff we still need: 
    53  * object creation, load plugin, get plugin handle, setting search path. 
     61 * object creation, get plugin handle. 
    5462 */ 
    5563 
    5664// plugin loading and unloading: 
     65 
     66// Load a plugin by name. 
    5767int                      roar_plugincontainer_load            (struct roar_plugincontainer * cont, 
    5868                                                               const char * name, 
    5969                                                               struct roar_dl_librarypara * para); 
     70 
     71/* Load a plugin by name with extra options. 
     72 * This is for advanced applications only. 
     73 */ 
    6074struct roar_dl_lhandle * roar_plugincontainer_load_lhandle    (struct roar_plugincontainer * cont, 
    6175                                                               const char * name, 
     
    6377                                                               int ra_init, 
    6478                                                               struct roar_dl_librarypara * para); 
     79/* Unload a plugin by name. 
     80 * NOTE: The name here is from the plugin and may not match the name you load 
     81 *       the plugin with. 
     82 */ 
    6583int                      roar_plugincontainer_unload          (struct roar_plugincontainer * cont, 
    6684                                                               const char * name); 
     85/* Load a plugin by roardl handle. 
     86 * This is for advanced applications only. 
     87 */ 
    6788int                      roar_plugincontainer_unload_lhandle  (struct roar_plugincontainer * cont, 
    6889                                                               struct roar_dl_lhandle * lhandle); 
     90/* Post ra_init plugins not yet inited. 
     91 * NOTE: This uses the default para, 
     92 *       not the one given with roar_plugincontainer_load_lhandle(). 
     93 * This is for advanced applications only. 
     94 */ 
    6995int                      roar_plugincontainer_ra_init         (struct roar_plugincontainer * cont); 
    7096 
    7197// appsched: 
     98// Trigger an application schedule event on all plugins. 
    7299int                      roar_plugincontainer_appsched_trigger(struct roar_plugincontainer * cont, enum roar_dl_appsched_trigger trigger); 
    73100 
Note: See TracChangeset for help on using the changeset viewer.