diff options
Diffstat (limited to 'build/doc/html/structpw__properties.html')
| -rw-r--r-- | build/doc/html/structpw__properties.html | 594 |
1 files changed, 594 insertions, 0 deletions
diff --git a/build/doc/html/structpw__properties.html b/build/doc/html/structpw__properties.html new file mode 100644 index 00000000..f4ea15cf --- /dev/null +++ b/build/doc/html/structpw__properties.html @@ -0,0 +1,594 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.15"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>PipeWire: pw_properties Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ + $(document).ready(initResizable); +/* @license-end */</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">PipeWire +  <span id="projectnumber">0.2.9</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.15 --> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(function() { + initMenu('',false,false,'search.php','Search'); +}); +/* @license-end */</script> +<div id="main-nav"></div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('structpw__properties.html','');}); +/* @license-end */ +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pub-attribs">Data Fields</a> </div> + <div class="headertitle"> +<div class="title">pw_properties Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>A collection of key/value pairs. + <a href="structpw__properties.html#details">More...</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:aea9bdd771760e44ca7d77b5113297610"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT struct <a class="el" href="structpw__properties.html">pw_properties</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__properties.html#aea9bdd771760e44ca7d77b5113297610">pw_properties_new</a> (const char *key,...)</td></tr> +<tr class="memdesc:aea9bdd771760e44ca7d77b5113297610"><td class="mdescLeft"> </td><td class="mdescRight">Make a new properties object. <a href="#aea9bdd771760e44ca7d77b5113297610">More...</a><br /></td></tr> +<tr class="separator:aea9bdd771760e44ca7d77b5113297610"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a24141a1a6b16b3da3edc1126935e3e44"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT struct <a class="el" href="structpw__properties.html">pw_properties</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__properties.html#a24141a1a6b16b3da3edc1126935e3e44">pw_properties_new_dict</a> (const struct spa_dict *<a class="el" href="structpw__properties.html#a70aa5816bde60f5511f2308971794881">dict</a>)</td></tr> +<tr class="memdesc:a24141a1a6b16b3da3edc1126935e3e44"><td class="mdescLeft"> </td><td class="mdescRight">Make a new properties object from the given dictionary. <a href="#a24141a1a6b16b3da3edc1126935e3e44">More...</a><br /></td></tr> +<tr class="separator:a24141a1a6b16b3da3edc1126935e3e44"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab8d32d79721d753deb979f2698fff034"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT struct <a class="el" href="structpw__properties.html">pw_properties</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__properties.html#ab8d32d79721d753deb979f2698fff034">pw_properties_new_string</a> (const char *str)</td></tr> +<tr class="memdesc:ab8d32d79721d753deb979f2698fff034"><td class="mdescLeft"> </td><td class="mdescRight">Make a new properties object from the given str. <a href="#ab8d32d79721d753deb979f2698fff034">More...</a><br /></td></tr> +<tr class="separator:ab8d32d79721d753deb979f2698fff034"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a674f4f6bd81ec0b229c0b6af88774b7a"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT struct <a class="el" href="structpw__properties.html">pw_properties</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__properties.html#a674f4f6bd81ec0b229c0b6af88774b7a">pw_properties_copy</a> (const struct <a class="el" href="structpw__properties.html">pw_properties</a> *properties)</td></tr> +<tr class="memdesc:a674f4f6bd81ec0b229c0b6af88774b7a"><td class="mdescLeft"> </td><td class="mdescRight">Copy a properties object. <a href="#a674f4f6bd81ec0b229c0b6af88774b7a">More...</a><br /></td></tr> +<tr class="separator:a674f4f6bd81ec0b229c0b6af88774b7a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7ab4c3f85931eab48ad91352d44be9d3"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__properties.html#a7ab4c3f85931eab48ad91352d44be9d3">pw_properties_clear</a> (struct <a class="el" href="structpw__properties.html">pw_properties</a> *properties)</td></tr> +<tr class="memdesc:a7ab4c3f85931eab48ad91352d44be9d3"><td class="mdescLeft"> </td><td class="mdescRight">Clear a properties object. <a href="#a7ab4c3f85931eab48ad91352d44be9d3">More...</a><br /></td></tr> +<tr class="separator:a7ab4c3f85931eab48ad91352d44be9d3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a15a72cca30ebffc472fb46cfa8b22c43"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__properties.html#a15a72cca30ebffc472fb46cfa8b22c43">pw_properties_update</a> (struct <a class="el" href="structpw__properties.html">pw_properties</a> *<a class="el" href="structprops.html">props</a>, const struct spa_dict *<a class="el" href="structpw__properties.html#a70aa5816bde60f5511f2308971794881">dict</a>)</td></tr> +<tr class="memdesc:a15a72cca30ebffc472fb46cfa8b22c43"><td class="mdescLeft"> </td><td class="mdescRight">Update properties. <a href="#a15a72cca30ebffc472fb46cfa8b22c43">More...</a><br /></td></tr> +<tr class="separator:a15a72cca30ebffc472fb46cfa8b22c43"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6473c3fdc688733f1db2e8d645ba94f4"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__properties.html#a6473c3fdc688733f1db2e8d645ba94f4">pw_properties_free</a> (struct <a class="el" href="structpw__properties.html">pw_properties</a> *properties)</td></tr> +<tr class="memdesc:a6473c3fdc688733f1db2e8d645ba94f4"><td class="mdescLeft"> </td><td class="mdescRight">Free a properties object. <a href="#a6473c3fdc688733f1db2e8d645ba94f4">More...</a><br /></td></tr> +<tr class="separator:a6473c3fdc688733f1db2e8d645ba94f4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a30bb01472ad7feccd59e8b589e2896ee"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__properties.html#a30bb01472ad7feccd59e8b589e2896ee">pw_properties_set</a> (struct <a class="el" href="structpw__properties.html">pw_properties</a> *properties, const char *key, const char *value)</td></tr> +<tr class="memdesc:a30bb01472ad7feccd59e8b589e2896ee"><td class="mdescLeft"> </td><td class="mdescRight">Set a property value. <a href="#a30bb01472ad7feccd59e8b589e2896ee">More...</a><br /></td></tr> +<tr class="separator:a30bb01472ad7feccd59e8b589e2896ee"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a24c715aa1d9eec46b7ebef61410d6f13"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__properties.html#a24c715aa1d9eec46b7ebef61410d6f13">pw_properties_setf</a> (struct <a class="el" href="structpw__properties.html">pw_properties</a> *properties, const char *key, const char *format,...)</td></tr> +<tr class="memdesc:a24c715aa1d9eec46b7ebef61410d6f13"><td class="mdescLeft"> </td><td class="mdescRight">Set a property value by format. <a href="#a24c715aa1d9eec46b7ebef61410d6f13">More...</a><br /></td></tr> +<tr class="separator:a24c715aa1d9eec46b7ebef61410d6f13"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aef040055887634f636bb26594091c31c"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__properties.html#aef040055887634f636bb26594091c31c">pw_properties_get</a> (const struct <a class="el" href="structpw__properties.html">pw_properties</a> *properties, const char *key)</td></tr> +<tr class="memdesc:aef040055887634f636bb26594091c31c"><td class="mdescLeft"> </td><td class="mdescRight">Get a property. <a href="#aef040055887634f636bb26594091c31c">More...</a><br /></td></tr> +<tr class="separator:aef040055887634f636bb26594091c31c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa31ae496c298076852173e46a8c58da5"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__properties.html#aa31ae496c298076852173e46a8c58da5">pw_properties_iterate</a> (const struct <a class="el" href="structpw__properties.html">pw_properties</a> *properties, void **state)</td></tr> +<tr class="memdesc:aa31ae496c298076852173e46a8c58da5"><td class="mdescLeft"> </td><td class="mdescRight">Iterate property values. <a href="#aa31ae496c298076852173e46a8c58da5">More...</a><br /></td></tr> +<tr class="separator:aa31ae496c298076852173e46a8c58da5"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> +Data Fields</h2></td></tr> +<tr class="memitem:a70aa5816bde60f5511f2308971794881"><td class="memItemLeft" align="right" valign="top">struct spa_dict </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__properties.html#a70aa5816bde60f5511f2308971794881">dict</a></td></tr> +<tr class="memdesc:a70aa5816bde60f5511f2308971794881"><td class="mdescLeft"> </td><td class="mdescRight">dictionary of key/values <a href="#a70aa5816bde60f5511f2308971794881">More...</a><br /></td></tr> +<tr class="separator:a70aa5816bde60f5511f2308971794881"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8003e978689f764bb7bd2a3ab2d46a87"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__properties.html#a8003e978689f764bb7bd2a3ab2d46a87">flags</a></td></tr> +<tr class="memdesc:a8003e978689f764bb7bd2a3ab2d46a87"><td class="mdescLeft"> </td><td class="mdescRight">extra flags <a href="#a8003e978689f764bb7bd2a3ab2d46a87">More...</a><br /></td></tr> +<tr class="separator:a8003e978689f764bb7bd2a3ab2d46a87"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>A collection of key/value pairs. </p> +<p>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. </p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="a7ab4c3f85931eab48ad91352d44be9d3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7ab4c3f85931eab48ad91352d44be9d3">◆ </a></span>pw_properties_clear()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT void pw_properties_clear </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="structpw__properties.html">pw_properties</a> * </td> + <td class="paramname"><em>properties</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Clear a properties object. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">properties</td><td>properties to clear </td></tr> + </table> + </dd> +</dl> + +<p class="reference">References <a class="el" href="array_8h.html#aa960ca693013e1b7fce13b0968db70b8">pw_array_for_each</a>.</p> + +<p class="reference">Referenced by <a class="el" href="structpw__properties.html#a6473c3fdc688733f1db2e8d645ba94f4">pw_properties_free()</a>.</p> + +</div> +</div> +<a id="a674f4f6bd81ec0b229c0b6af88774b7a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a674f4f6bd81ec0b229c0b6af88774b7a">◆ </a></span>pw_properties_copy()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT struct <a class="el" href="structpw__properties.html">pw_properties</a> * pw_properties_copy </td> + <td>(</td> + <td class="paramtype">const struct <a class="el" href="structpw__properties.html">pw_properties</a> * </td> + <td class="paramname"><em>properties</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Copy a properties object. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">properties</td><td>properties to copy </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a new properties object </dd></dl> + +<p class="reference">References <a class="el" href="structpw__properties.html#a70aa5816bde60f5511f2308971794881">dict</a>, and <a class="el" href="structpw__properties.html#a24141a1a6b16b3da3edc1126935e3e44">pw_properties_new_dict()</a>.</p> + +<p class="reference">Referenced by <a class="el" href="classpw__core.html#a149d054319a8cd3fb6206b233d2476cd">pw_core::pw_core_new()</a>.</p> + +</div> +</div> +<a id="a6473c3fdc688733f1db2e8d645ba94f4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6473c3fdc688733f1db2e8d645ba94f4">◆ </a></span>pw_properties_free()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT void pw_properties_free </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="structpw__properties.html">pw_properties</a> * </td> + <td class="paramname"><em>properties</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Free a properties object. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">properties</td><td>the properties to free </td></tr> + </table> + </dd> +</dl> + +<p class="reference">References <a class="el" href="structpw__properties.html#a7ab4c3f85931eab48ad91352d44be9d3">pw_properties_clear()</a>.</p> + +<p class="reference">Referenced by <a class="el" href="classpw__core.html#a3fe8a902e97223d11c0e8e4640c16379">pw_core::pw_core_destroy()</a>, <a class="el" href="device_8c.html#a413c1f742b769410a3400e4859d92588">pw_device_destroy()</a>, <a class="el" href="device_8c.html#afeed9a25db834399fafefcf0bc62dec3">pw_device_new()</a>, <a class="el" href="factory_8c.html#a3ec95397d9e642db23678f2a52800831">pw_factory_destroy()</a>, <a class="el" href="classpw__global.html#a70cf2ad61f1f9b7c1cb40a1ea6e73ce5">pw_global::pw_global_new()</a>, <a class="el" href="structpw__loop.html#ae7e5a8b4500832184aa06705d3569933">pw_loop::pw_loop_destroy()</a>, <a class="el" href="structpw__loop.html#a67a638da8a3914b6fa0aa6d9eda6b6e0">pw_loop::pw_loop_new()</a>, <a class="el" href="mem_8c.html#ab253128cb2d2bc7ad5203d2b65e762c8">pw_mempool_destroy()</a>, <a class="el" href="classpw__module.html#aeb91aaec73271350e79774d753202045">pw_module::pw_module_destroy()</a>, <a class="el" href="remote_8c.html#a0e927d9eff1cc1a6ae723617e4f4abec">pw_remote_destroy()</a>, and <a class="el" href="remote_8c.html#ab4d94be2412050ec56ad495ccf75f9b3">pw_remote_new()</a>.</p> + +</div> +</div> +<a id="aef040055887634f636bb26594091c31c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aef040055887634f636bb26594091c31c">◆ </a></span>pw_properties_get()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT const char * pw_properties_get </td> + <td>(</td> + <td class="paramtype">const struct <a class="el" href="structpw__properties.html">pw_properties</a> * </td> + <td class="paramname"><em>properties</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>key</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get a property. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">properties</td><td>a <a class="el" href="structpw__properties.html">pw_properties</a> </td></tr> + <tr><td class="paramname">key</td><td>a key </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the property for <em>key</em> or NULL when the key was not found</dd></dl> +<p>Get the property in <em>properties</em> with <em>key</em>. </p> + +<p class="reference">Referenced by <a class="el" href="classpw__core.html#a149d054319a8cd3fb6206b233d2476cd">pw_core::pw_core_new()</a>, <a class="el" href="device_8c.html#abd1484330b3aba2d6ea0ee994d27c5dc">pw_device_register()</a>, <a class="el" href="classpw__pipewire.html#aaa9f7d9822aeae824c0e006d34b926f5">pw_pipewire::pw_fill_remote_properties()</a>, <a class="el" href="structpw__loop.html#a67a638da8a3914b6fa0aa6d9eda6b6e0">pw_loop::pw_loop_new()</a>, <a class="el" href="node_8c.html#a113fdbfe9945521c737bfec4a77ecf6d">pw_node_register()</a>, <a class="el" href="remote_8c.html#ab4d94be2412050ec56ad495ccf75f9b3">pw_remote_new()</a>, and <a class="el" href="stream_8c.html#a4b67742e1d3106776f4a701958bcbb7d">pw_stream_new()</a>.</p> + +</div> +</div> +<a id="aa31ae496c298076852173e46a8c58da5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa31ae496c298076852173e46a8c58da5">◆ </a></span>pw_properties_iterate()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT const char * pw_properties_iterate </td> + <td>(</td> + <td class="paramtype">const struct <a class="el" href="structpw__properties.html">pw_properties</a> * </td> + <td class="paramname"><em>properties</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void ** </td> + <td class="paramname"><em>state</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Iterate property values. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">properties</td><td>a <a class="el" href="structpw__properties.html">pw_properties</a> </td></tr> + <tr><td class="paramname">state</td><td>state </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>The next key or NULL when there are no more keys to iterate.</dd></dl> +<p>Iterate over <em>properties</em>, returning each key in turn. <em>state</em> should point to a pointer holding NULL to get the first element and will be updated after each iteration. When NULL is returned, all elements have been iterated. </p> + +<p class="reference">References <a class="el" href="structpw__array.html#a0cfa9d60080b10e5256fb90979199132">pw_array::pw_array_check_index</a>, and <a class="el" href="structpw__array.html#ab0a7f1be44fce5380425b1ffcc674cf2">pw_array::pw_array_get_unchecked</a>.</p> + +</div> +</div> +<a id="aea9bdd771760e44ca7d77b5113297610"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aea9bdd771760e44ca7d77b5113297610">◆ </a></span>pw_properties_new()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT struct <a class="el" href="structpw__properties.html">pw_properties</a> * pw_properties_new </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>...</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Make a new properties object. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">key</td><td>a first key </td></tr> + <tr><td class="paramname">...</td><td>value and more keys NULL terminated </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a newly allocated properties object </dd></dl> + +<p class="reference">Referenced by <a class="el" href="classpw__client.html#aace8634f25e970be554644d5edd14c46">pw_client::pw_client_new()</a>, <a class="el" href="classpw__core.html#a149d054319a8cd3fb6206b233d2476cd">pw_core::pw_core_new()</a>, <a class="el" href="device_8c.html#afeed9a25db834399fafefcf0bc62dec3">pw_device_new()</a>, <a class="el" href="device_8c.html#abd1484330b3aba2d6ea0ee994d27c5dc">pw_device_register()</a>, <a class="el" href="factory_8c.html#a00cc60bc962f726a598e7b74fc55a76f">pw_factory_register()</a>, <a class="el" href="link_8c.html#a0e8395287b38de06906630600956891e">pw_link_register()</a>, <a class="el" href="node_8c.html#af2c3c203a64912b22a1e7f54ceea0daa">pw_node_new()</a>, <a class="el" href="node_8c.html#a113fdbfe9945521c737bfec4a77ecf6d">pw_node_register()</a>, <a class="el" href="port_8c.html#ac1c4179741acea62bcf7bbb08ad9415b">pw_port_new()</a>, <a class="el" href="remote_8c.html#ab4d94be2412050ec56ad495ccf75f9b3">pw_remote_new()</a>, and <a class="el" href="stream_8c.html#a4b67742e1d3106776f4a701958bcbb7d">pw_stream_new()</a>.</p> + +</div> +</div> +<a id="a24141a1a6b16b3da3edc1126935e3e44"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a24141a1a6b16b3da3edc1126935e3e44">◆ </a></span>pw_properties_new_dict()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT struct <a class="el" href="structpw__properties.html">pw_properties</a> * pw_properties_new_dict </td> + <td>(</td> + <td class="paramtype">const struct spa_dict * </td> + <td class="paramname"><em>dict</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Make a new properties object from the given dictionary. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">dict</td><td>a dictionary. keys and values are copied </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a new properties object </dd></dl> + +<p class="reference">Referenced by <a class="el" href="port_8c.html#ac1c4179741acea62bcf7bbb08ad9415b">pw_port_new()</a>, and <a class="el" href="structpw__properties.html#a674f4f6bd81ec0b229c0b6af88774b7a">pw_properties_copy()</a>.</p> + +</div> +</div> +<a id="ab8d32d79721d753deb979f2698fff034"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab8d32d79721d753deb979f2698fff034">◆ </a></span>pw_properties_new_string()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT struct <a class="el" href="structpw__properties.html">pw_properties</a> * pw_properties_new_string </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>str</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Make a new properties object from the given str. </p> +<p><em>str</em> should be a whitespace separated list of key=value strings.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">args</td><td>a property description </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a new properties object </dd></dl> + +</div> +</div> +<a id="a30bb01472ad7feccd59e8b589e2896ee"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a30bb01472ad7feccd59e8b589e2896ee">◆ </a></span>pw_properties_set()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT int pw_properties_set </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="structpw__properties.html">pw_properties</a> * </td> + <td class="paramname"><em>properties</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>value</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Set a property value. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">properties</td><td>the properties to change </td></tr> + <tr><td class="paramname">key</td><td>a key </td></tr> + <tr><td class="paramname">value</td><td>a value or NULL to remove the key </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>1 if the properties were changed. 0 if nothing was changed because the property already existed with the same value or because the key to remove did not exist.</dd></dl> +<p>Set the property in <em>properties</em> with <em>key</em> to <em>value</em>. Any previous value of <em>key</em> will be overwritten. When <em>value</em> is NULL, the key will be removed. </p> + +<p class="reference">Referenced by <a class="el" href="classpw__core.html#a149d054319a8cd3fb6206b233d2476cd">pw_core::pw_core_new()</a>, <a class="el" href="device_8c.html#abd1484330b3aba2d6ea0ee994d27c5dc">pw_device_register()</a>, <a class="el" href="factory_8c.html#a00cc60bc962f726a598e7b74fc55a76f">pw_factory_register()</a>, <a class="el" href="classpw__pipewire.html#aaa9f7d9822aeae824c0e006d34b926f5">pw_pipewire::pw_fill_remote_properties()</a>, <a class="el" href="node_8c.html#a113fdbfe9945521c737bfec4a77ecf6d">pw_node_register()</a>, <a class="el" href="port_8c.html#ac1c4179741acea62bcf7bbb08ad9415b">pw_port_new()</a>, <a class="el" href="structpw__properties.html#a15a72cca30ebffc472fb46cfa8b22c43">pw_properties_update()</a>, and <a class="el" href="stream_8c.html#a4b67742e1d3106776f4a701958bcbb7d">pw_stream_new()</a>.</p> + +</div> +</div> +<a id="a24c715aa1d9eec46b7ebef61410d6f13"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a24c715aa1d9eec46b7ebef61410d6f13">◆ </a></span>pw_properties_setf()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT int pw_properties_setf </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="structpw__properties.html">pw_properties</a> * </td> + <td class="paramname"><em>properties</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>format</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>...</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Set a property value by format. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">properties</td><td>a <a class="el" href="structpw__properties.html">pw_properties</a> </td></tr> + <tr><td class="paramname">key</td><td>a key </td></tr> + <tr><td class="paramname">format</td><td>a value </td></tr> + <tr><td class="paramname">...</td><td>extra arguments</td></tr> + </table> + </dd> +</dl> +<p>Set the property in <em>properties</em> with <em>key</em> to the value in printf style <em>format</em> Any previous value of <em>key</em> will be overwritten. </p> + +<p class="reference">References <a class="el" href="properties_8c.html#a45bb0212063f3daf407c3896f376e7b3">pw_properties_setva()</a>.</p> + +<p class="reference">Referenced by <a class="el" href="classpw__core.html#a149d054319a8cd3fb6206b233d2476cd">pw_core::pw_core_new()</a>, <a class="el" href="factory_8c.html#a00cc60bc962f726a598e7b74fc55a76f">pw_factory_register()</a>, <a class="el" href="classpw__pipewire.html#aaa9f7d9822aeae824c0e006d34b926f5">pw_pipewire::pw_fill_remote_properties()</a>, and <a class="el" href="link_8c.html#a0e8395287b38de06906630600956891e">pw_link_register()</a>.</p> + +</div> +</div> +<a id="a15a72cca30ebffc472fb46cfa8b22c43"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a15a72cca30ebffc472fb46cfa8b22c43">◆ </a></span>pw_properties_update()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT int pw_properties_update </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="structpw__properties.html">pw_properties</a> * </td> + <td class="paramname"><em>props</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const struct spa_dict * </td> + <td class="paramname"><em>dict</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Update properties. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">props</td><td>properties to update </td></tr> + <tr><td class="paramname">dict</td><td>new properties </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the number of changed properties</dd></dl> +<p>The properties in <em>props</em> are updated with <em>dict</em>. Keys in <em>dict</em> with NULL values are removed from <em>props</em>. </p> + +<p class="reference">References <a class="el" href="structpw__properties.html#a30bb01472ad7feccd59e8b589e2896ee">pw_properties_set()</a>.</p> + +<p class="reference">Referenced by <a class="el" href="classpw__client.html#aa6201ad8dcdedfef27774283860a4f1e">pw_client::pw_client_update_properties()</a>, <a class="el" href="classpw__core.html#a9f93e4947d5c6c6beba5030f6ca4c4d4">pw_core::pw_core_update_properties()</a>, <a class="el" href="module_8c.html#a1cb27f63a0f05dc9fff63fd78d239bf2">pw_module_update_properties()</a>, <a class="el" href="remote_8c.html#a13b046fa7cea5ce6e8dd87399b3ef0e6">pw_remote_update_properties()</a>, and <a class="el" href="stream_8c.html#a0d2ad73d654de2bc11afe6847474afcb">pw_stream_update_properties()</a>.</p> + +</div> +</div> +<h2 class="groupheader">Field Documentation</h2> +<a id="a70aa5816bde60f5511f2308971794881"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a70aa5816bde60f5511f2308971794881">◆ </a></span>dict</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct spa_dict pw_properties::dict</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>dictionary of key/values </p> + +<p class="reference">Referenced by <a class="el" href="classpw__core.html#a149d054319a8cd3fb6206b233d2476cd">pw_core::pw_core_new()</a>, <a class="el" href="device_8c.html#afeed9a25db834399fafefcf0bc62dec3">pw_device_new()</a>, <a class="el" href="factory_8c.html#a4d8b00f5376ac67de32c6e4947930f58">pw_factory_new()</a>, <a class="el" href="structpw__loop.html#a67a638da8a3914b6fa0aa6d9eda6b6e0">pw_loop::pw_loop_new()</a>, <a class="el" href="port_8c.html#ac1c4179741acea62bcf7bbb08ad9415b">pw_port_new()</a>, <a class="el" href="structpw__properties.html#a674f4f6bd81ec0b229c0b6af88774b7a">pw_properties_copy()</a>, and <a class="el" href="remote_8c.html#a13b046fa7cea5ce6e8dd87399b3ef0e6">pw_remote_update_properties()</a>.</p> + +</div> +</div> +<a id="a8003e978689f764bb7bd2a3ab2d46a87"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a8003e978689f764bb7bd2a3ab2d46a87">◆ </a></span>flags</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">uint32_t pw_properties::flags</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>extra flags </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="properties_8h_source.html">properties.h</a></li> +<li><a class="el" href="properties_8c.html">properties.c</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="structpw__properties.html">pw_properties</a></li> + <li class="footer">Generated by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li> + </ul> +</div> +</body> +</html> |