summaryrefslogtreecommitdiff
path: root/polyp/autoload.h
diff options
context:
space:
mode:
Diffstat (limited to 'polyp/autoload.h')
-rw-r--r--polyp/autoload.h17
1 files changed, 15 insertions, 2 deletions
diff --git a/polyp/autoload.h b/polyp/autoload.h
index 8537173cf..234756845 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);