summaryrefslogtreecommitdiffstats
path: root/src/pulse/proplist.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/pulse/proplist.h')
-rw-r--r--src/pulse/proplist.h38
1 files changed, 32 insertions, 6 deletions
diff --git a/src/pulse/proplist.h b/src/pulse/proplist.h
index c23ef238..203a28c5 100644
--- a/src/pulse/proplist.h
+++ b/src/pulse/proplist.h
@@ -26,6 +26,7 @@
#include <pulse/cdecl.h>
#include <pulse/gccmacro.h>
+#include <pulse/version.h>
PA_C_DECL_BEGIN
@@ -75,8 +76,10 @@ PA_C_DECL_BEGIN
* device.connector isa, pci, usb, firewire, bluetooth
* device.access_mode mmap, mmap_rewrite, serial
* device.master_device
- * device.bufferin.buffer_size
- * device.bufferin.fragment_size
+ * device.buffering.buffer_size
+ * device.buffering.fragment_size
+ * device.profile.name analog-stereo, analog-surround-40, iec958-stereo, ...
+ * device.profile.description "Analog Stereo", ...
*/
#define PA_PROP_MEDIA_NAME "media.name"
#define PA_PROP_MEDIA_TITLE "media.title"
@@ -124,6 +127,12 @@ PA_C_DECL_BEGIN
#define PA_PROP_DEVICE_MASTER_DEVICE "device.master_device"
#define PA_PROP_DEVICE_BUFFERING_BUFFER_SIZE "device.buffering.buffer_size"
#define PA_PROP_DEVICE_BUFFERING_FRAGMENT_SIZE "device.buffering.fragment_size"
+#define PA_PROP_DEVICE_PROFILE_NAME "device.profile.name"
+#define PA_PROP_DEVICE_PROFILE_DESCRIPTION "device.profile.description"
+#define PA_PROP_MODULE_AUTHOR "module.author"
+#define PA_PROP_MODULE_DESCRIPTION "module.description"
+#define PA_PROP_MODULE_USAGE "module.usage"
+#define PA_PROP_MODULE_VERSION "module.version"
/** A property list object. Basically a dictionary with UTF-8 strings
* as keys and arbitrary data as values. \since 0.9.11 */
@@ -153,7 +162,7 @@ int pa_proplist_setf(pa_proplist *p, const char *key, const char *format, ...) P
* internal copy of the data passed is made. \since 0.9.11 */
int pa_proplist_set(pa_proplist *p, const char *key, const void *data, size_t nbytes);
-/* Return a string entry for the specified key. Will return NULL if
+/** Return a string entry for the specified key. Will return NULL if
* the data is not valid UTF-8. Will return a NUL-terminated string in
* an internally allocated buffer. The caller should make a copy of
* the data before accessing the property list again. \since 0.9.11 */
@@ -209,11 +218,22 @@ int pa_proplist_unset_many(pa_proplist *p, const char * const keys[]);
* have any particular order. \since 0.9.11 */
const char *pa_proplist_iterate(pa_proplist *p, void **state);
-/** Format the property list nicely as a human readable string. Call pa_xfree() on the result. \since
- * 0.9.11 */
+/** Format the property list nicely as a human readable string. This
+ * works very much like pa_proplist_to_string_sep() and uses a newline
+ * as seperator and appends one final one. Call pa_xfree() on the
+ * result. \since 0.9.11 */
char *pa_proplist_to_string(pa_proplist *p);
-/** Returns 1 if an entry for the specified key is existant in the
+/** Format the property list nicely as a human readable string and
+ * choose the seperator. Call pa_xfree() on the result. \since
+ * 0.9.15 */
+char *pa_proplist_to_string_sep(pa_proplist *p, const char *sep);
+
+/** Allocate a new property list and assign key/value from a human
+ * readable string. \since 0.9.15 */
+pa_proplist *pa_proplist_from_string(const char *str);
+
+ /** Returns 1 if an entry for the specified key is existant in the
* property list. \since 0.9.11 */
int pa_proplist_contains(pa_proplist *p, const char *key);
@@ -224,6 +244,12 @@ void pa_proplist_clear(pa_proplist *p);
* the specific list. \since 0.9.11 */
pa_proplist* pa_proplist_copy(pa_proplist *t);
+/** Return the number of entries on the property list. \since 0.9.15 */
+unsigned pa_proplist_size(pa_proplist *t);
+
+/** Returns 0 when the proplist is empty, positive otherwise \since 0.9.15 */
+int pa_proplist_isempty(pa_proplist *t);
+
PA_C_DECL_END
#endif