PipeWire  0.3.29
Key-Value pairs

Properties are used to pass around arbitrary key/value pairs. More...

Data Structures

struct  pw_properties
 

Functions

struct pw_propertiespw_properties_new (const char *key,...) SPA_SENTINEL
 
struct pw_propertiespw_properties_new_dict (const struct spa_dict *dict)
 
struct pw_propertiespw_properties_new_string (const char *args)
 
struct pw_propertiespw_properties_copy (const struct pw_properties *properties)
 
int pw_properties_update_keys (struct pw_properties *props, const struct spa_dict *dict, const char *keys[])
 
int pw_properties_update_ignore (struct pw_properties *props, const struct spa_dict *dict, const char *ignore[])
 
int pw_properties_update (struct pw_properties *oldprops, const struct spa_dict *dict)
 
int pw_properties_update_string (struct pw_properties *props, const char *str, size_t size)
 
int pw_properties_add (struct pw_properties *oldprops, const struct spa_dict *dict)
 
int pw_properties_add_keys (struct pw_properties *oldprops, const struct spa_dict *dict, const char *keys[])
 
void pw_properties_clear (struct pw_properties *properties)
 
void pw_properties_free (struct pw_properties *properties)
 
int pw_properties_set (struct pw_properties *properties, const char *key, const char *value)
 
int pw_properties_setf (struct pw_properties *properties, const char *key, const char *format,...) SPA_PRINTF_FUNC(3
 
int int pw_properties_setva (struct pw_properties *properties, const char *key, const char *format, va_list args) SPA_PRINTF_FUNC(3
 
int int const char * pw_properties_get (const struct pw_properties *properties, const char *key)
 
const char * pw_properties_iterate (const struct pw_properties *properties, void **state)
 
int pw_properties_serialize_dict (FILE *f, const struct spa_dict *dict, uint32_t flags)
 

Detailed Description

Properties are used to pass around arbitrary key/value pairs.

Both keys and values are strings which keeps things simple. Encoding of arbitrary values should be done by using a string serialization such as base64 for binary blobs.

Function Documentation

◆ pw_properties_add()

int pw_properties_add ( struct pw_properties oldprops,
const struct spa_dict dict 
)

◆ pw_properties_add_keys()

int pw_properties_add_keys ( struct pw_properties oldprops,
const struct spa_dict dict,
const char *  keys[] 
)

◆ pw_properties_clear()

void pw_properties_clear ( struct pw_properties properties)

◆ pw_properties_copy()

struct pw_properties* pw_properties_copy ( const struct pw_properties properties)

◆ pw_properties_free()

void pw_properties_free ( struct pw_properties properties)

◆ pw_properties_get()

int int const char* pw_properties_get ( const struct pw_properties properties,
const char *  key 
)

◆ pw_properties_iterate()

const char* pw_properties_iterate ( const struct pw_properties properties,
void **  state 
)

◆ pw_properties_new()

struct pw_properties* pw_properties_new ( const char *  key,
  ... 
)

◆ pw_properties_new_dict()

struct pw_properties* pw_properties_new_dict ( const struct spa_dict dict)

◆ pw_properties_new_string()

struct pw_properties* pw_properties_new_string ( const char *  args)

◆ pw_properties_serialize_dict()

int pw_properties_serialize_dict ( FILE *  f,
const struct spa_dict dict,
uint32_t  flags 
)

◆ pw_properties_set()

int pw_properties_set ( struct pw_properties properties,
const char *  key,
const char *  value 
)

◆ pw_properties_setf()

int pw_properties_setf ( struct pw_properties properties,
const char *  key,
const char *  format,
  ... 
)

◆ pw_properties_setva()

int int pw_properties_setva ( struct pw_properties properties,
const char *  key,
const char *  format,
va_list  args 
)

◆ pw_properties_update()

int pw_properties_update ( struct pw_properties oldprops,
const struct spa_dict dict 
)

◆ pw_properties_update_ignore()

int pw_properties_update_ignore ( struct pw_properties props,
const struct spa_dict dict,
const char *  ignore[] 
)

References spa_dict_for_each.

◆ pw_properties_update_keys()

int pw_properties_update_keys ( struct pw_properties props,
const struct spa_dict dict,
const char *  keys[] 
)

◆ pw_properties_update_string()