diff options
Diffstat (limited to 'build/doc/html/client_8h.html')
| -rw-r--r-- | build/doc/html/client_8h.html | 648 |
1 files changed, 648 insertions, 0 deletions
diff --git a/build/doc/html/client_8h.html b/build/doc/html/client_8h.html new file mode 100644 index 00000000..378a0465 --- /dev/null +++ b/build/doc/html/client_8h.html @@ -0,0 +1,648 @@ +<!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: client.h File 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('client_8h.html','');}); +/* @license-end */ +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#nested-classes">Data Structures</a> | +<a href="#define-members">Macros</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">client.h File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><div class="dynheader"> +Include dependency graph for client.h:</div> +<div class="dyncontent"> +<div class="center"><img src="client_8h__incl.png" border="0" usemap="#client_8h" alt=""/></div> +<map name="client_8h" id="client_8h"> +<area shape="rect" title=" " alt="" coords="371,5,441,32"/> +<area shape="rect" title=" " alt="" coords="131,304,257,331"/> +<area shape="rect" href="core_8h.html" title=" " alt="" coords="455,80,578,107"/> +<area shape="rect" href="introspect_8h.html" title=" " alt="" coords="905,155,1064,181"/> +<area shape="rect" href="properties_8h.html" title=" " alt="" coords="662,304,822,331"/> +<area shape="rect" href="global_8h.html" title=" " alt="" coords="325,229,460,256"/> +<area shape="rect" href="resource_8h.html" title=" " alt="" coords="5,229,156,256"/> +<area shape="rect" href="permission_8h.html" title=" " alt="" coords="648,80,815,107"/> +<area shape="rect" title=" " alt="" coords="805,229,927,256"/> +<area shape="rect" href="loop_8h.html" title=" " alt="" coords="581,155,703,181"/> +<area shape="rect" href="factory_8h.html" title=" " alt="" coords="218,155,357,181"/> +<area shape="rect" title=" " alt="" coords="951,229,1101,256"/> +<area shape="rect" title=" " alt="" coords="683,379,801,405"/> +<area shape="rect" title=" " alt="" coords="536,229,679,256"/> +</map> +</div> +</div><div class="textblock"><div class="dynheader"> +This graph shows which files directly or indirectly include this file:</div> +<div class="dyncontent"> +<div class="center"><img src="client_8h__dep__incl.png" border="0" usemap="#client_8hdep" alt=""/></div> +<map name="client_8hdep" id="client_8hdep"> +<area shape="rect" title=" " alt="" coords="1657,5,1727,32"/> +<area shape="rect" href="core_8h.html" title=" " alt="" coords="1225,80,1287,107"/> +<area shape="rect" href="pipewire_8h.html" title=" " alt="" coords="1188,453,1279,480"/> +<area shape="rect" href="global_8h.html" title=" " alt="" coords="1529,155,1604,181"/> +<area shape="rect" href="factory_8h.html" title=" " alt="" coords="1595,229,1674,256"/> +<area shape="rect" href="client_8c.html" title=" " alt="" coords="2003,379,2072,405"/> +<area shape="rect" href="resource_8h.html" title=" " alt="" coords="1729,155,1820,181"/> +<area shape="rect" href="control_8h.html" title=" " alt="" coords="278,304,357,331"/> +<area shape="rect" href="device_8h.html" title=" " alt="" coords="1699,229,1776,256"/> +<area shape="rect" href="core_8c.html" title=" " alt="" coords="284,528,345,555"/> +<area shape="rect" href="node_8h.html" title=" " alt="" coords="1133,229,1200,256"/> +<area shape="rect" href="port_8h.html" title=" " alt="" coords="674,304,734,331"/> +<area shape="rect" href="link_8h.html" title=" " alt="" coords="557,379,616,405"/> +<area shape="rect" href="remote_8h.html" title=" " alt="" coords="986,304,1067,331"/> +<area shape="rect" href="proxy_8c.html" title=" " alt="" coords="742,379,810,405"/> +<area shape="rect" href="module_8h.html" title=" " alt="" coords="431,304,513,331"/> +<area shape="rect" href="protocol_8h.html" title=" " alt="" coords="1213,155,1299,181"/> +<area shape="rect" href="control_8c.html" title=" " alt="" coords="94,379,173,405"/> +<area shape="rect" href="link_8c.html" title=" " alt="" coords="558,453,615,480"/> +<area shape="rect" href="device_8c.html" title=" " alt="" coords="1509,528,1585,555"/> +<area shape="rect" href="introspect_8c.html" title=" " alt="" coords="865,528,964,555"/> +<area shape="rect" href="loop_8c.html" title=" " alt="" coords="1103,528,1164,555"/> +<area shape="rect" href="pipewire_8c.html" title=" " alt="" coords="1189,528,1278,555"/> +<area shape="rect" href="port_8c.html" title=" " alt="" coords="699,528,757,555"/> +<area shape="rect" href="remote_8c.html" title=" " alt="" coords="1303,528,1383,555"/> +<area shape="rect" href="stream_8c.html" title=" " alt="" coords="995,528,1074,555"/> +<area shape="rect" href="global_8c.html" title=" " alt="" coords="1283,379,1357,405"/> +<area shape="rect" href="node_8c.html" title=" " alt="" coords="1142,379,1207,405"/> +<area shape="rect" href="stream_8h.html" title=" " alt="" coords="987,379,1067,405"/> +<area shape="rect" href="factory_8c.html" title=" " alt="" coords="1381,379,1459,405"/> +<area shape="rect" href="module_8c.html" title=" " alt="" coords="299,379,381,405"/> +<area shape="rect" href="proxy_8h.html" title=" " alt="" coords="1224,229,1293,256"/> +<area shape="rect" href="resource_8c.html" title=" " alt="" coords="1635,379,1725,405"/> +<area shape="rect" href="protocol_8c.html" title=" " alt="" coords="1022,229,1109,256"/> +<area shape="rect" href="interfaces_8h.html" title=" " alt="" coords="1204,304,1303,331"/> +</map> +</div> +</div> +<p><a href="client_8h_source.html">Go to the source code of this file.</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> +Data Structures</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__client__events.html">pw_client_events</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The events that a client can emit. <a href="structpw__client__events.html#details">More...</a><br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> +Macros</h2></td></tr> +<tr class="memitem:ab0377cbf13596f969016266bc277b60b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#ab0377cbf13596f969016266bc277b60b">PW_VERSION_CLIENT_EVENTS</a>   0</td></tr> +<tr class="separator:ab0377cbf13596f969016266bc277b60b"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:ac628bc52c1d96653c8b74c7de8e1cc63"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="classpw__client.html">pw_client</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#ac628bc52c1d96653c8b74c7de8e1cc63">pw_client_new</a> (struct <a class="el" href="classpw__core.html">pw_core</a> *core, struct <a class="el" href="structpw__properties.html">pw_properties</a> *properties, size_t user_data_size)</td></tr> +<tr class="memdesc:ac628bc52c1d96653c8b74c7de8e1cc63"><td class="mdescLeft"> </td><td class="mdescRight">Create a new client. <a href="#ac628bc52c1d96653c8b74c7de8e1cc63">More...</a><br /></td></tr> +<tr class="separator:ac628bc52c1d96653c8b74c7de8e1cc63"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a223158574f457695ae817c4e12b6256c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#a223158574f457695ae817c4e12b6256c">pw_client_destroy</a> (struct <a class="el" href="classpw__client.html">pw_client</a> *client)</td></tr> +<tr class="memdesc:a223158574f457695ae817c4e12b6256c"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a previously created client. <a href="#a223158574f457695ae817c4e12b6256c">More...</a><br /></td></tr> +<tr class="separator:a223158574f457695ae817c4e12b6256c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5bd5bff7c28d00963a1ed9cab02b7d66"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#a5bd5bff7c28d00963a1ed9cab02b7d66">pw_client_register</a> (struct <a class="el" href="classpw__client.html">pw_client</a> *client, struct <a class="el" href="classpw__client.html">pw_client</a> *owner, struct <a class="el" href="classpw__global.html">pw_global</a> *parent, struct <a class="el" href="structpw__properties.html">pw_properties</a> *properties)</td></tr> +<tr class="memdesc:a5bd5bff7c28d00963a1ed9cab02b7d66"><td class="mdescLeft"> </td><td class="mdescRight">Finish configuration and register a client. <a href="#a5bd5bff7c28d00963a1ed9cab02b7d66">More...</a><br /></td></tr> +<tr class="separator:a5bd5bff7c28d00963a1ed9cab02b7d66"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a44650bc0ee5b32b94564edd76b1ea05b"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#a44650bc0ee5b32b94564edd76b1ea05b">pw_client_get_user_data</a> (struct <a class="el" href="classpw__client.html">pw_client</a> *client)</td></tr> +<tr class="memdesc:a44650bc0ee5b32b94564edd76b1ea05b"><td class="mdescLeft"> </td><td class="mdescRight">Get the client user data. <a href="#a44650bc0ee5b32b94564edd76b1ea05b">More...</a><br /></td></tr> +<tr class="separator:a44650bc0ee5b32b94564edd76b1ea05b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abfa0b2ccd8213d4a1a498bf99f95cd2e"><td class="memItemLeft" align="right" valign="top">const struct <a class="el" href="structpw__client__info.html">pw_client_info</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#abfa0b2ccd8213d4a1a498bf99f95cd2e">pw_client_get_info</a> (struct <a class="el" href="classpw__client.html">pw_client</a> *client)</td></tr> +<tr class="memdesc:abfa0b2ccd8213d4a1a498bf99f95cd2e"><td class="mdescLeft"> </td><td class="mdescRight">Get the client information. <a href="#abfa0b2ccd8213d4a1a498bf99f95cd2e">More...</a><br /></td></tr> +<tr class="separator:abfa0b2ccd8213d4a1a498bf99f95cd2e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad59b5105cc7e1d595b1a86b4e7b0f3a2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#ad59b5105cc7e1d595b1a86b4e7b0f3a2">pw_client_update_properties</a> (struct <a class="el" href="classpw__client.html">pw_client</a> *client, const struct spa_dict *dict)</td></tr> +<tr class="memdesc:ad59b5105cc7e1d595b1a86b4e7b0f3a2"><td class="mdescLeft"> </td><td class="mdescRight">Update the client properties. <a href="#ad59b5105cc7e1d595b1a86b4e7b0f3a2">More...</a><br /></td></tr> +<tr class="separator:ad59b5105cc7e1d595b1a86b4e7b0f3a2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa0e39c39a833e97c54b6ce1e8d5eb3e2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#aa0e39c39a833e97c54b6ce1e8d5eb3e2">pw_client_update_permissions</a> (struct <a class="el" href="classpw__client.html">pw_client</a> *client, uint32_t n_permissions, const struct <a class="el" href="structpw__permission.html">pw_permission</a> *permissions)</td></tr> +<tr class="memdesc:aa0e39c39a833e97c54b6ce1e8d5eb3e2"><td class="mdescLeft"> </td><td class="mdescRight">Update the client permissions. <a href="#aa0e39c39a833e97c54b6ce1e8d5eb3e2">More...</a><br /></td></tr> +<tr class="separator:aa0e39c39a833e97c54b6ce1e8d5eb3e2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a61aebf7d8e7c43b7b5509d0ed94c0c91"><td class="memItemLeft" align="right" valign="top">const struct <a class="el" href="structpw__properties.html">pw_properties</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#a61aebf7d8e7c43b7b5509d0ed94c0c91">pw_client_get_properties</a> (struct <a class="el" href="classpw__client.html">pw_client</a> *client)</td></tr> +<tr class="memdesc:a61aebf7d8e7c43b7b5509d0ed94c0c91"><td class="mdescLeft"> </td><td class="mdescRight">Get the client properties. <a href="#a61aebf7d8e7c43b7b5509d0ed94c0c91">More...</a><br /></td></tr> +<tr class="separator:a61aebf7d8e7c43b7b5509d0ed94c0c91"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a92b0702f790b1c6c63ebf280aea38a46"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="classpw__core.html">pw_core</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#a92b0702f790b1c6c63ebf280aea38a46">pw_client_get_core</a> (struct <a class="el" href="classpw__client.html">pw_client</a> *client)</td></tr> +<tr class="memdesc:a92b0702f790b1c6c63ebf280aea38a46"><td class="mdescLeft"> </td><td class="mdescRight">Get the core used to create this client. <a href="#a92b0702f790b1c6c63ebf280aea38a46">More...</a><br /></td></tr> +<tr class="separator:a92b0702f790b1c6c63ebf280aea38a46"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2d9ebb7d254be581cd0818ed6f1193af"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="classpw__resource.html">pw_resource</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#a2d9ebb7d254be581cd0818ed6f1193af">pw_client_get_core_resource</a> (struct <a class="el" href="classpw__client.html">pw_client</a> *client)</td></tr> +<tr class="memdesc:a2d9ebb7d254be581cd0818ed6f1193af"><td class="mdescLeft"> </td><td class="mdescRight">Get the client core resource. <a href="#a2d9ebb7d254be581cd0818ed6f1193af">More...</a><br /></td></tr> +<tr class="separator:a2d9ebb7d254be581cd0818ed6f1193af"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6a3270c6d64be59137c0d40069059169"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="classpw__resource.html">pw_resource</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#a6a3270c6d64be59137c0d40069059169">pw_client_find_resource</a> (struct <a class="el" href="classpw__client.html">pw_client</a> *client, uint32_t id)</td></tr> +<tr class="memdesc:a6a3270c6d64be59137c0d40069059169"><td class="mdescLeft"> </td><td class="mdescRight">Get a resource with the given id. <a href="#a6a3270c6d64be59137c0d40069059169">More...</a><br /></td></tr> +<tr class="separator:a6a3270c6d64be59137c0d40069059169"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5523e67618e9df912146744a5cb9b2bf"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="classpw__global.html">pw_global</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#a5523e67618e9df912146744a5cb9b2bf">pw_client_get_global</a> (struct <a class="el" href="classpw__client.html">pw_client</a> *client)</td></tr> +<tr class="memdesc:a5523e67618e9df912146744a5cb9b2bf"><td class="mdescLeft"> </td><td class="mdescRight">Get the global associated with this client. <a href="#a5523e67618e9df912146744a5cb9b2bf">More...</a><br /></td></tr> +<tr class="separator:a5523e67618e9df912146744a5cb9b2bf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a82b0823127ba4ab4baf3f1aab5b3beb9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#a82b0823127ba4ab4baf3f1aab5b3beb9">pw_client_add_listener</a> (struct <a class="el" href="classpw__client.html">pw_client</a> *client, struct spa_hook *listener, const struct <a class="el" href="structpw__client__events.html">pw_client_events</a> *events, void *<a class="el" href="structdata.html">data</a>)</td></tr> +<tr class="memdesc:a82b0823127ba4ab4baf3f1aab5b3beb9"><td class="mdescLeft"> </td><td class="mdescRight">listen to events from this client <a href="#a82b0823127ba4ab4baf3f1aab5b3beb9">More...</a><br /></td></tr> +<tr class="separator:a82b0823127ba4ab4baf3f1aab5b3beb9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a097c0de3ead85df5988936a5f7411fa9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="client_8h.html#a097c0de3ead85df5988936a5f7411fa9">pw_client_set_busy</a> (struct <a class="el" href="classpw__client.html">pw_client</a> *client, bool busy)</td></tr> +<tr class="memdesc:a097c0de3ead85df5988936a5f7411fa9"><td class="mdescLeft"> </td><td class="mdescRight">Mark the client busy. <a href="#a097c0de3ead85df5988936a5f7411fa9">More...</a><br /></td></tr> +<tr class="separator:a097c0de3ead85df5988936a5f7411fa9"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Macro Definition Documentation</h2> +<a id="ab0377cbf13596f969016266bc277b60b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab0377cbf13596f969016266bc277b60b">◆ </a></span>PW_VERSION_CLIENT_EVENTS</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define PW_VERSION_CLIENT_EVENTS   0</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Function Documentation</h2> +<a id="a82b0823127ba4ab4baf3f1aab5b3beb9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a82b0823127ba4ab4baf3f1aab5b3beb9">◆ </a></span>pw_client_add_listener()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void pw_client_add_listener </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__client.html">pw_client</a> * </td> + <td class="paramname"><em>client</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">struct spa_hook * </td> + <td class="paramname"><em>listener</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const struct <a class="el" href="structpw__client__events.html">pw_client_events</a> * </td> + <td class="paramname"><em>events</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>data</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>listen to events from this client </p> + +</div> +</div> +<a id="a223158574f457695ae817c4e12b6256c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a223158574f457695ae817c4e12b6256c">◆ </a></span>pw_client_destroy()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void pw_client_destroy </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__client.html">pw_client</a> * </td> + <td class="paramname"><em>client</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Destroy a previously created client. </p> + +</div> +</div> +<a id="a6a3270c6d64be59137c0d40069059169"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6a3270c6d64be59137c0d40069059169">◆ </a></span>pw_client_find_resource()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="classpw__resource.html">pw_resource</a>* pw_client_find_resource </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__client.html">pw_client</a> * </td> + <td class="paramname"><em>client</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get a resource with the given id. </p> + +<p class="reference">References <a class="el" href="structpw__map.html#a9656703501cdaa5a82adb9db60f76fc6">pw_map::pw_map_lookup()</a>.</p> + +</div> +</div> +<a id="a92b0702f790b1c6c63ebf280aea38a46"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a92b0702f790b1c6c63ebf280aea38a46">◆ </a></span>pw_client_get_core()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="classpw__core.html">pw_core</a>* pw_client_get_core </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__client.html">pw_client</a> * </td> + <td class="paramname"><em>client</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the core used to create this client. </p> + +</div> +</div> +<a id="a2d9ebb7d254be581cd0818ed6f1193af"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2d9ebb7d254be581cd0818ed6f1193af">◆ </a></span>pw_client_get_core_resource()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="classpw__resource.html">pw_resource</a>* pw_client_get_core_resource </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__client.html">pw_client</a> * </td> + <td class="paramname"><em>client</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the client core resource. </p> + +</div> +</div> +<a id="a5523e67618e9df912146744a5cb9b2bf"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a5523e67618e9df912146744a5cb9b2bf">◆ </a></span>pw_client_get_global()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="classpw__global.html">pw_global</a>* pw_client_get_global </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__client.html">pw_client</a> * </td> + <td class="paramname"><em>client</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the global associated with this client. </p> + +</div> +</div> +<a id="abfa0b2ccd8213d4a1a498bf99f95cd2e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abfa0b2ccd8213d4a1a498bf99f95cd2e">◆ </a></span>pw_client_get_info()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const struct <a class="el" href="structpw__client__info.html">pw_client_info</a>* pw_client_get_info </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__client.html">pw_client</a> * </td> + <td class="paramname"><em>client</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the client information. </p> + +</div> +</div> +<a id="a61aebf7d8e7c43b7b5509d0ed94c0c91"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a61aebf7d8e7c43b7b5509d0ed94c0c91">◆ </a></span>pw_client_get_properties()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const struct <a class="el" href="structpw__properties.html">pw_properties</a>* pw_client_get_properties </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__client.html">pw_client</a> * </td> + <td class="paramname"><em>client</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the client properties. </p> + +</div> +</div> +<a id="a44650bc0ee5b32b94564edd76b1ea05b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a44650bc0ee5b32b94564edd76b1ea05b">◆ </a></span>pw_client_get_user_data()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void* pw_client_get_user_data </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__client.html">pw_client</a> * </td> + <td class="paramname"><em>client</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the client user data. </p> + +</div> +</div> +<a id="ac628bc52c1d96653c8b74c7de8e1cc63"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac628bc52c1d96653c8b74c7de8e1cc63">◆ </a></span>pw_client_new()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="classpw__client.html">pw_client</a>* pw_client_new </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__core.html">pw_core</a> * </td> + <td class="paramname"><em>core</em>, </td> + </tr> + <tr> + <td class="paramkey"></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">size_t </td> + <td class="paramname"><em>user_data_size</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Create a new client. </p> +<p>This is mainly used by protocols. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">core</td><td>the core object </td></tr> + <tr><td class="paramname">properties</td><td>client properties </td></tr> + <tr><td class="paramname">user_data_size</td><td>extra user data size </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="a5bd5bff7c28d00963a1ed9cab02b7d66"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a5bd5bff7c28d00963a1ed9cab02b7d66">◆ </a></span>pw_client_register()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int pw_client_register </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__client.html">pw_client</a> * </td> + <td class="paramname"><em>client</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">struct <a class="el" href="classpw__client.html">pw_client</a> * </td> + <td class="paramname"><em>owner</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">struct <a class="el" href="classpw__global.html">pw_global</a> * </td> + <td class="paramname"><em>parent</em>, </td> + </tr> + <tr> + <td class="paramkey"></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></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Finish configuration and register a client. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">client</td><td>the client to register </td></tr> + <tr><td class="paramname">owner</td><td>optional owner </td></tr> + <tr><td class="paramname">parent</td><td>the client parent </td></tr> + <tr><td class="paramname">properties</td><td>extra properties </td></tr> + </table> + </dd> +</dl> + +<p class="reference">References <a class="el" href="classpw__global.html#a70cf2ad61f1f9b7c1cb40a1ea6e73ce5">pw_global::pw_global_new()</a>, <a class="el" href="classpw__log.html#a98a49c37f11de525890014e927e34d02">pw_log::pw_log_debug</a>, <a class="el" href="type_8h.html#a06fc87d81c62e9abb8790b6e5713c55babd2fb894d1e22ed65eb969e1ee7a9a27">PW_TYPE_INTERFACE_Client</a>, and <a class="el" href="interfaces_8h.html#af6c00b9fb9ffc28aab79558976ef2989">PW_VERSION_CLIENT_PROXY</a>.</p> + +</div> +</div> +<a id="a097c0de3ead85df5988936a5f7411fa9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a097c0de3ead85df5988936a5f7411fa9">◆ </a></span>pw_client_set_busy()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void pw_client_set_busy </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__client.html">pw_client</a> * </td> + <td class="paramname"><em>client</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>busy</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Mark the client busy. </p> +<p>This can be used when an asynchronous operation is started and no further processing is allowed to happen for the client </p> + +<p class="reference">References <a class="el" href="classpw__log.html#a98a49c37f11de525890014e927e34d02">pw_log::pw_log_debug</a>.</p> + +<p class="reference">Referenced by <a class="el" href="client_8c.html#aa4a8794d28485a52146b71c1fad7a479">pw_client_update_permissions()</a>.</p> +<div class="dynheader"> +Here is the caller graph for this function:</div> +<div class="dyncontent"> +<div class="center"><img src="client_8h_a097c0de3ead85df5988936a5f7411fa9_icgraph.png" border="0" usemap="#client_8h_a097c0de3ead85df5988936a5f7411fa9_icgraph" alt=""/></div> +<map name="client_8h_a097c0de3ead85df5988936a5f7411fa9_icgraph" id="client_8h_a097c0de3ead85df5988936a5f7411fa9_icgraph"> +<area shape="rect" title="Mark the client busy." alt="" coords="276,5,425,32"/> +<area shape="rect" href="client_8c.html#aa4a8794d28485a52146b71c1fad7a479" title="Update the client permissions." alt="" coords="5,5,228,32"/> +</map> +</div> + +</div> +</div> +<a id="aa0e39c39a833e97c54b6ce1e8d5eb3e2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa0e39c39a833e97c54b6ce1e8d5eb3e2">◆ </a></span>pw_client_update_permissions()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int pw_client_update_permissions </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__client.html">pw_client</a> * </td> + <td class="paramname"><em>client</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>n_permissions</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const struct <a class="el" href="structpw__permission.html">pw_permission</a> * </td> + <td class="paramname"><em>permissions</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Update the client permissions. </p> + +<p class="reference">References <a class="el" href="structpw__permission.html#a317a76bba04bd0dcad6e5bca65f9fa92">pw_permission::id</a>, <a class="el" href="structpw__permission.html#ac890cf00fa67d8667c9be52276e8a6f3">pw_permission::permissions</a>, <a class="el" href="client_8c.html#ad20b53531ca73dcf169bed0fcf16ad50">pw_client_set_busy()</a>, <a class="el" href="core_8h.html#a2fb1ec794839834c891c627441502e3e">pw_core_find_global()</a>, <a class="el" href="global_8h.html#ab916775315ec53e0d1fa5dac6d184a41">pw_global_update_permissions()</a>, <a class="el" href="classpw__log.html#a98a49c37f11de525890014e927e34d02">pw_log::pw_log_debug</a>, and <a class="el" href="classpw__log.html#a2d2c2dc7d35b7104f5caef08df416767">pw_log::pw_log_warn</a>.</p> + +</div> +</div> +<a id="ad59b5105cc7e1d595b1a86b4e7b0f3a2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad59b5105cc7e1d595b1a86b4e7b0f3a2">◆ </a></span>pw_client_update_properties()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int pw_client_update_properties </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__client.html">pw_client</a> * </td> + <td class="paramname"><em>client</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 the client properties. </p> + +</div> +</div> +</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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_7129a66c92fe7beef816c2ac906ef0b3.html">pipewire</a></li><li class="navelem"><a class="el" href="client_8h.html">client.h</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> |