From 4763ca1376fc136158e576de94dc1cf6c6584973 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Sun, 21 Nov 2004 21:31:28 +0000 Subject: Comment some more files git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@309 fefdeb5f-60dc-0310-8127-8f9354f1896f --- polyp/modargs.h | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'polyp/modargs.h') diff --git a/polyp/modargs.h b/polyp/modargs.h index 53753ba7..07db6ae5 100644 --- a/polyp/modargs.h +++ b/polyp/modargs.h @@ -28,14 +28,22 @@ struct pa_modargs; -struct pa_modargs *pa_modargs_new(const char *args, const char* const* keys); +/* A generic parser for module arguments */ + +/* Parse the string args. The NULL-terminated array keys contains all valid arguments. */ +struct pa_modargs *pa_modargs_new(const char *args, const char* const keys[]); void pa_modargs_free(struct pa_modargs*ma); +/* Return the module argument for the specified name as a string. If + * the argument was not specified, return def instead.*/ const char *pa_modargs_get_value(struct pa_modargs *ma, const char *key, const char *def); + +/* Return a module argument as unsigned 32bit value in *value */ int pa_modargs_get_value_u32(struct pa_modargs *ma, const char *key, uint32_t *value); int pa_modargs_get_value_s32(struct pa_modargs *ma, const char *key, int32_t *value); int pa_modargs_get_value_boolean(struct pa_modargs *ma, const char *key, int *value); +/* Return sample spec data from the three arguments "rate", "format" and "channels" */ int pa_modargs_get_sample_spec(struct pa_modargs *ma, struct pa_sample_spec *ss); #endif -- cgit