PipeWire: pipewire/properties.h File Reference

PipeWire 1.4.7

Loading...
Searching...
No Matches
properties.h File Reference
Utilities » Properties

pipewire/properties.h More...

Go to the source code of this file.

## Data Structures
struct | pw_properties

## Macros
#define | PW_API_PROPERTIES static inline
#define | PW_PROPERTIES_FLAG_NL (1<<0)
#define | PW_PROPERTIES_FLAG_RECURSE (1<<1)
#define | PW_PROPERTIES_FLAG_ENCLOSE (1<<2)
#define | PW_PROPERTIES_FLAG_ARRAY (1<<3)
#define | PW_PROPERTIES_FLAG_COLORS (1<<4)

## Functions
struct pw_properties * | pw_properties_new (const char *key,...)
| Make a new properties object.
struct pw_properties * | pw_properties_new_dict (const struct spa_dict *dict)
| Make a new properties object from the given dictionary.
struct pw_properties * | pw_properties_new_string (const char *args)
| Make a new properties object from the given str.
struct pw_properties * | pw_properties_new_string_checked (const char *args, size_t size, struct spa_error_location *loc)
struct pw_properties * | pw_properties_copy (const struct pw_properties *properties)
| Copy a properties object.
int | pw_properties_update_keys (struct pw_properties *props, const struct spa_dict *dict, const char *const keys[])
| Copy multiple keys from one property to another.
int | pw_properties_update_ignore (struct pw_properties *props, const struct spa_dict *dict, const char *const ignore[])
int | pw_properties_update (struct pw_properties *props, const struct spa_dict *dict)
| Update properties.
int | pw_properties_update_string (struct pw_properties *props, const char *str, size_t size)
| Update the properties from the given string, overwriting any existing keys with the new values from str.
int | pw_properties_update_string_checked (struct pw_properties *props, const char *str, size_t size, struct spa_error_location *loc)
| Check str is a well-formed properties JSON string and update the properties on success.
int | pw_properties_add (struct pw_properties *oldprops, const struct spa_dict *dict)
| Add properties.
int | pw_properties_add_keys (struct pw_properties *oldprops, const struct spa_dict *dict, const char *const keys[])
| Add keys.
void | pw_properties_clear (struct pw_properties *properties)
| Clear a properties object.
void | pw_properties_free (struct pw_properties *properties)
| Free a properties object.
int | pw_properties_set (struct pw_properties *properties, const char *key, const char *value)
| Set a property value.
int | pw_properties_setf (struct pw_properties *properties, const char *key, const char *format,...)
| Set a property value by format.
int | pw_properties_setva (struct pw_properties *properties, const char *key, const char *format, va_list args)
const char * | pw_properties_get (const struct pw_properties *properties, const char *key)
| Get a property.
int | pw_properties_fetch_uint32 (const struct pw_properties *properties, const char *key, uint32_t *value)
| Fetch a property as uint32_t.
int | pw_properties_fetch_int32 (const struct pw_properties *properties, const char *key, int32_t *value)
| Fetch a property as int32_t.
int | pw_properties_fetch_uint64 (const struct pw_properties *properties, const char *key, uint64_t *value)
| Fetch a property as uint64_t.
int | pw_properties_fetch_int64 (const struct pw_properties *properties, const char *key, int64_t *value)
| Fetch a property as int64_t.
int | pw_properties_fetch_bool (const struct pw_properties *properties, const char *key, bool *value)
| Fetch a property as boolean value.
PW_API_PROPERTIES uint32_t | pw_properties_get_uint32 (const struct pw_properties *properties, const char *key, uint32_t deflt)
PW_API_PROPERTIES int32_t | pw_properties_get_int32 (const struct pw_properties *properties, const char *key, int32_t deflt)
PW_API_PROPERTIES uint64_t | pw_properties_get_uint64 (const struct pw_properties *properties, const char *key, uint64_t deflt)
PW_API_PROPERTIES int64_t | pw_properties_get_int64 (const struct pw_properties *properties, const char *key, int64_t deflt)
PW_API_PROPERTIES bool | pw_properties_get_bool (const struct pw_properties *properties, const char *key, bool deflt)
const char * | pw_properties_iterate (const struct pw_properties *properties, void **state)
| Iterate property values.
int | pw_properties_serialize_dict (FILE *f, const struct spa_dict *dict, uint32_t flags)
PW_API_PROPERTIES bool | pw_properties_parse_bool (const char *value)
PW_API_PROPERTIES int | pw_properties_parse_int (const char *value)
PW_API_PROPERTIES int64_t | pw_properties_parse_int64 (const char *value)
PW_API_PROPERTIES uint64_t | pw_properties_parse_uint64 (const char *value)
PW_API_PROPERTIES float | pw_properties_parse_float (const char *value)
PW_API_PROPERTIES double | pw_properties_parse_double (const char *value)

## Detailed Description

pipewire/properties.h

## Macro Definition Documentation

## ◆ PW_API_PROPERTIES

#define PW_API_PROPERTIES static inline