diff options
Diffstat (limited to 'build/doc/html/classpw__introspect.html')
| -rw-r--r-- | build/doc/html/classpw__introspect.html | 346 |
1 files changed, 346 insertions, 0 deletions
diff --git a/build/doc/html/classpw__introspect.html b/build/doc/html/classpw__introspect.html new file mode 100644 index 00000000..f82d746d --- /dev/null +++ b/build/doc/html/classpw__introspect.html @@ -0,0 +1,346 @@ +<!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_introspect 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('classpw__introspect.html','');}); +/* @license-end */ +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> </div> + <div class="headertitle"> +<div class="title">pw_introspect Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>The introspection methods and structures are used to get information about the object in the PipeWire server. + <a href="classpw__introspect.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:a10cfbc658d844b76a5d3f3528cd2f345"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__introspect.html#a10cfbc658d844b76a5d3f3528cd2f345">pw_direction_as_string</a> (enum <a class="el" href="introspect_8h.html#a6e9e847059d68cbdb608abc8eb6b631d">pw_direction</a> direction)</td></tr> +<tr class="memdesc:a10cfbc658d844b76a5d3f3528cd2f345"><td class="mdescLeft"> </td><td class="mdescRight">Convert a <a class="el" href="introspect_8h.html#a6e9e847059d68cbdb608abc8eb6b631d">pw_direction</a> to a readable string. <a href="#a10cfbc658d844b76a5d3f3528cd2f345">More...</a><br /></td></tr> +<tr class="separator:a10cfbc658d844b76a5d3f3528cd2f345"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af9ef57e634a1d3ba60e47a65608db03f"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structpw__core__info.html">pw_core_info</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__introspect.html#af9ef57e634a1d3ba60e47a65608db03f">pw_core_info_update</a> (struct <a class="el" href="structpw__core__info.html">pw_core_info</a> *info, const struct <a class="el" href="structpw__core__info.html">pw_core_info</a> *update)</td></tr> +<tr class="memdesc:af9ef57e634a1d3ba60e47a65608db03f"><td class="mdescLeft"> </td><td class="mdescRight">Update and existing <a class="el" href="structpw__core__info.html">pw_core_info</a> with <em>update</em>. <a href="#af9ef57e634a1d3ba60e47a65608db03f">More...</a><br /></td></tr> +<tr class="separator:af9ef57e634a1d3ba60e47a65608db03f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acd6e564b199ca16be48656e77cb5003a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__introspect.html#acd6e564b199ca16be48656e77cb5003a">pw_core_info_free</a> (struct <a class="el" href="structpw__core__info.html">pw_core_info</a> *info)</td></tr> +<tr class="memdesc:acd6e564b199ca16be48656e77cb5003a"><td class="mdescLeft"> </td><td class="mdescRight">Free a <a class="el" href="structpw__core__info.html">pw_core_info</a>. <a href="#acd6e564b199ca16be48656e77cb5003a">More...</a><br /></td></tr> +<tr class="separator:acd6e564b199ca16be48656e77cb5003a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab941c4159785bfa9cf253f9658b82d8f"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structpw__module__info.html">pw_module_info</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__introspect.html#ab941c4159785bfa9cf253f9658b82d8f">pw_module_info_update</a> (struct <a class="el" href="structpw__module__info.html">pw_module_info</a> *info, const struct <a class="el" href="structpw__module__info.html">pw_module_info</a> *update)</td></tr> +<tr class="memdesc:ab941c4159785bfa9cf253f9658b82d8f"><td class="mdescLeft"> </td><td class="mdescRight">Update and existing <a class="el" href="structpw__module__info.html">pw_module_info</a> with <em>update</em>. <a href="#ab941c4159785bfa9cf253f9658b82d8f">More...</a><br /></td></tr> +<tr class="separator:ab941c4159785bfa9cf253f9658b82d8f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8c4bfe6ad4da2e2443ba7985ae7527cb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__introspect.html#a8c4bfe6ad4da2e2443ba7985ae7527cb">pw_module_info_free</a> (struct <a class="el" href="structpw__module__info.html">pw_module_info</a> *info)</td></tr> +<tr class="memdesc:a8c4bfe6ad4da2e2443ba7985ae7527cb"><td class="mdescLeft"> </td><td class="mdescRight">Free a <a class="el" href="structpw__module__info.html">pw_module_info</a>. <a href="#a8c4bfe6ad4da2e2443ba7985ae7527cb">More...</a><br /></td></tr> +<tr class="separator:a8c4bfe6ad4da2e2443ba7985ae7527cb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:adddbb259795b02f6b8f3c25afb03996c"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structpw__device__info.html">pw_device_info</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__introspect.html#adddbb259795b02f6b8f3c25afb03996c">pw_device_info_update</a> (struct <a class="el" href="structpw__device__info.html">pw_device_info</a> *info, const struct <a class="el" href="structpw__device__info.html">pw_device_info</a> *update)</td></tr> +<tr class="memdesc:adddbb259795b02f6b8f3c25afb03996c"><td class="mdescLeft"> </td><td class="mdescRight">Update and existing <a class="el" href="structpw__device__info.html">pw_device_info</a> with <em>update</em>. <a href="#adddbb259795b02f6b8f3c25afb03996c">More...</a><br /></td></tr> +<tr class="separator:adddbb259795b02f6b8f3c25afb03996c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa520fd3279ad8c1b34adb414f7726864"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__introspect.html#aa520fd3279ad8c1b34adb414f7726864">pw_device_info_free</a> (struct <a class="el" href="structpw__device__info.html">pw_device_info</a> *info)</td></tr> +<tr class="memdesc:aa520fd3279ad8c1b34adb414f7726864"><td class="mdescLeft"> </td><td class="mdescRight">Free a <a class="el" href="structpw__device__info.html">pw_device_info</a>. <a href="#aa520fd3279ad8c1b34adb414f7726864">More...</a><br /></td></tr> +<tr class="separator:aa520fd3279ad8c1b34adb414f7726864"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a534848e70aa11c5f41df3c8c9751c2bf"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structpw__client__info.html">pw_client_info</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__introspect.html#a534848e70aa11c5f41df3c8c9751c2bf">pw_client_info_update</a> (struct <a class="el" href="structpw__client__info.html">pw_client_info</a> *info, const struct <a class="el" href="structpw__client__info.html">pw_client_info</a> *update)</td></tr> +<tr class="memdesc:a534848e70aa11c5f41df3c8c9751c2bf"><td class="mdescLeft"> </td><td class="mdescRight">Update and existing <a class="el" href="structpw__client__info.html">pw_client_info</a> with <em>update</em>. <a href="#a534848e70aa11c5f41df3c8c9751c2bf">More...</a><br /></td></tr> +<tr class="separator:a534848e70aa11c5f41df3c8c9751c2bf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0052817a42d359a4b306d77717e2bec9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__introspect.html#a0052817a42d359a4b306d77717e2bec9">pw_client_info_free</a> (struct <a class="el" href="structpw__client__info.html">pw_client_info</a> *info)</td></tr> +<tr class="memdesc:a0052817a42d359a4b306d77717e2bec9"><td class="mdescLeft"> </td><td class="mdescRight">Free a <a class="el" href="structpw__client__info.html">pw_client_info</a>. <a href="#a0052817a42d359a4b306d77717e2bec9">More...</a><br /></td></tr> +<tr class="separator:a0052817a42d359a4b306d77717e2bec9"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>The introspection methods and structures are used to get information about the object in the PipeWire server. </p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="a0052817a42d359a4b306d77717e2bec9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a0052817a42d359a4b306d77717e2bec9">◆ </a></span>pw_client_info_free()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void pw_client_info_free </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="structpw__client__info.html">pw_client_info</a> * </td> + <td class="paramname"><em>info</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Free a <a class="el" href="structpw__client__info.html">pw_client_info</a>. </p> + +</div> +</div> +<a id="a534848e70aa11c5f41df3c8c9751c2bf"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a534848e70aa11c5f41df3c8c9751c2bf">◆ </a></span>pw_client_info_update()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="structpw__client__info.html">pw_client_info</a> * pw_client_info_update </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="structpw__client__info.html">pw_client_info</a> * </td> + <td class="paramname"><em>info</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const struct <a class="el" href="structpw__client__info.html">pw_client_info</a> * </td> + <td class="paramname"><em>update</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Update and existing <a class="el" href="structpw__client__info.html">pw_client_info</a> with <em>update</em>. </p> + +</div> +</div> +<a id="acd6e564b199ca16be48656e77cb5003a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#acd6e564b199ca16be48656e77cb5003a">◆ </a></span>pw_core_info_free()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void pw_core_info_free </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="structpw__core__info.html">pw_core_info</a> * </td> + <td class="paramname"><em>info</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Free a <a class="el" href="structpw__core__info.html">pw_core_info</a>. </p> + +</div> +</div> +<a id="af9ef57e634a1d3ba60e47a65608db03f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#af9ef57e634a1d3ba60e47a65608db03f">◆ </a></span>pw_core_info_update()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="structpw__core__info.html">pw_core_info</a> * pw_core_info_update </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="structpw__core__info.html">pw_core_info</a> * </td> + <td class="paramname"><em>info</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const struct <a class="el" href="structpw__core__info.html">pw_core_info</a> * </td> + <td class="paramname"><em>update</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Update and existing <a class="el" href="structpw__core__info.html">pw_core_info</a> with <em>update</em>. </p> + +</div> +</div> +<a id="aa520fd3279ad8c1b34adb414f7726864"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa520fd3279ad8c1b34adb414f7726864">◆ </a></span>pw_device_info_free()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void pw_device_info_free </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="structpw__device__info.html">pw_device_info</a> * </td> + <td class="paramname"><em>info</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Free a <a class="el" href="structpw__device__info.html">pw_device_info</a>. </p> + +</div> +</div> +<a id="adddbb259795b02f6b8f3c25afb03996c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#adddbb259795b02f6b8f3c25afb03996c">◆ </a></span>pw_device_info_update()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="structpw__device__info.html">pw_device_info</a> * pw_device_info_update </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="structpw__device__info.html">pw_device_info</a> * </td> + <td class="paramname"><em>info</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const struct <a class="el" href="structpw__device__info.html">pw_device_info</a> * </td> + <td class="paramname"><em>update</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Update and existing <a class="el" href="structpw__device__info.html">pw_device_info</a> with <em>update</em>. </p> + +</div> +</div> +<a id="a10cfbc658d844b76a5d3f3528cd2f345"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a10cfbc658d844b76a5d3f3528cd2f345">◆ </a></span>pw_direction_as_string()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char * pw_direction_as_string </td> + <td>(</td> + <td class="paramtype">enum <a class="el" href="introspect_8h.html#a6e9e847059d68cbdb608abc8eb6b631d">pw_direction</a> </td> + <td class="paramname"><em>direction</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Convert a <a class="el" href="introspect_8h.html#a6e9e847059d68cbdb608abc8eb6b631d">pw_direction</a> to a readable string. </p> + +<p class="reference">Referenced by <a class="el" href="node_8c.html#abcd651256965089972ad5a23f81564fc">pw_node_find_port()</a>, <a class="el" href="node_8c.html#a120175714bc1c60ca330a4354d7c288e">pw_node_get_free_port_id()</a>, and <a class="el" href="port_8c.html#ac1c4179741acea62bcf7bbb08ad9415b">pw_port_new()</a>.</p> + +</div> +</div> +<a id="a8c4bfe6ad4da2e2443ba7985ae7527cb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a8c4bfe6ad4da2e2443ba7985ae7527cb">◆ </a></span>pw_module_info_free()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void pw_module_info_free </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="structpw__module__info.html">pw_module_info</a> * </td> + <td class="paramname"><em>info</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Free a <a class="el" href="structpw__module__info.html">pw_module_info</a>. </p> + +</div> +</div> +<a id="ab941c4159785bfa9cf253f9658b82d8f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab941c4159785bfa9cf253f9658b82d8f">◆ </a></span>pw_module_info_update()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="structpw__module__info.html">pw_module_info</a> * pw_module_info_update </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="structpw__module__info.html">pw_module_info</a> * </td> + <td class="paramname"><em>info</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const struct <a class="el" href="structpw__module__info.html">pw_module_info</a> * </td> + <td class="paramname"><em>update</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Update and existing <a class="el" href="structpw__module__info.html">pw_module_info</a> with <em>update</em>. </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="introspect_8h_source.html">introspect.h</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="classpw__introspect.html">pw_introspect</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> |