diff options
author | Lennart Poettering <lennart@poettering.net> | 2004-11-21 21:31:28 +0000 |
---|---|---|
committer | Lennart Poettering <lennart@poettering.net> | 2004-11-21 21:31:28 +0000 |
commit | 4763ca1376fc136158e576de94dc1cf6c6584973 (patch) | |
tree | 6f8d36ec68061a587883d94e9eacc52bbf707028 /polyp/autoload.h | |
parent | 2fb83d13f27214476f90fe619b26f5bbc8f520c8 (diff) |
Comment some more files
git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@309 fefdeb5f-60dc-0310-8127-8f9354f1896f
Diffstat (limited to 'polyp/autoload.h')
-rw-r--r-- | polyp/autoload.h | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/polyp/autoload.h b/polyp/autoload.h index 8537173c..23475684 100644 --- a/polyp/autoload.h +++ b/polyp/autoload.h @@ -24,19 +24,32 @@ #include "namereg.h" +/* Using the autoloading facility, modules by be loaded on-demand and + * synchronously. The user may register a "ghost sink" or "ghost + * source". Whenever this sink/source is requested but not available a + * specified module is loaded. */ + +/* An autoload entry, or "ghost" sink/source */ struct pa_autoload_entry { struct pa_core *core; uint32_t index; char *name; - enum pa_namereg_type type; - int in_action; + enum pa_namereg_type type; /* Type of the autoload entry */ + int in_action; /* Currently loaded */ char *module, *argument; }; +/* Add a new autoload entry of the given time, with the speicified + * sink/source name, module name and argument. Return the entry's + * index in *index */ int pa_autoload_add(struct pa_core *c, const char*name, enum pa_namereg_type type, const char*module, const char *argument, uint32_t *index); + +/* Free all autoload entries */ void pa_autoload_free(struct pa_core *c); int pa_autoload_remove_by_name(struct pa_core *c, const char*name, enum pa_namereg_type type); int pa_autoload_remove_by_index(struct pa_core *c, uint32_t index); + +/* Request an autoload entry by its name, effectively causing a module to be loaded */ void pa_autoload_request(struct pa_core *c, const char *name, enum pa_namereg_type type); const struct pa_autoload_entry* pa_autoload_get_by_name(struct pa_core *c, const char*name, enum pa_namereg_type type); |