diff options
Diffstat (limited to 'build/doc/html/global_8h.html')
| -rw-r--r-- | build/doc/html/global_8h.html | 720 |
1 files changed, 720 insertions, 0 deletions
diff --git a/build/doc/html/global_8h.html b/build/doc/html/global_8h.html new file mode 100644 index 00000000..0a3192cc --- /dev/null +++ b/build/doc/html/global_8h.html @@ -0,0 +1,720 @@ +<!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: global.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('global_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="#typedef-members">Typedefs</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">global.h File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><div class="dynheader"> +Include dependency graph for global.h:</div> +<div class="dyncontent"> +<div class="center"><img src="global_8h__incl.png" border="0" usemap="#global_8h" alt=""/></div> +<map name="global_8h" id="global_8h"> +<area shape="rect" title=" " alt="" coords="285,5,360,32"/> +<area shape="rect" href="core_8h.html" title=" " alt="" coords="261,80,384,107"/> +<area shape="rect" href="client_8h.html" title=" " alt="" coords="251,304,381,331"/> +<area shape="rect" href="properties_8h.html" title=" " alt="" coords="621,453,781,480"/> +<area shape="rect" title=" " alt="" coords="69,453,190,480"/> +<area shape="rect" title=" " alt="" coords="475,379,600,405"/> +<area shape="rect" href="introspect_8h.html" title=" " alt="" coords="237,379,395,405"/> +<area shape="rect" href="loop_8h.html" title=" " alt="" coords="261,155,384,181"/> +<area shape="rect" href="factory_8h.html" title=" " alt="" coords="468,155,607,181"/> +<area shape="rect" href="resource_8h.html" title=" " alt="" coords="462,229,613,256"/> +<area shape="rect" href="permission_8h.html" title=" " alt="" coords="46,379,213,405"/> +<area shape="rect" title=" " alt="" coords="241,453,391,480"/> +<area shape="rect" title=" " alt="" coords="643,528,760,555"/> +<area shape="rect" title=" " alt="" coords="243,229,386,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="global_8h__dep__incl.png" border="0" usemap="#global_8hdep" alt=""/></div> +<map name="global_8hdep" id="global_8hdep"> +<area shape="rect" title=" " alt="" coords="864,5,939,32"/> +<area shape="rect" href="client_8h.html" title=" " alt="" coords="683,80,754,107"/> +<area shape="rect" href="core_8h.html" title=" " alt="" coords="902,304,965,331"/> +<area shape="rect" href="device_8h.html" title=" " alt="" coords="183,379,260,405"/> +<area shape="rect" href="node_8h.html" title=" " alt="" coords="1471,379,1537,405"/> +<area shape="rect" href="factory_8h.html" title=" " alt="" coords="679,229,758,256"/> +<area shape="rect" href="global_8c.html" title=" " alt="" coords="1750,603,1823,629"/> +<area shape="rect" href="pipewire_8h.html" title=" " alt="" coords="787,677,877,704"/> +<area shape="rect" href="client_8c.html" title=" " alt="" coords="51,603,120,629"/> +<area shape="rect" href="resource_8h.html" title=" " alt="" coords="477,155,568,181"/> +<area shape="rect" href="control_8h.html" title=" " alt="" coords="1443,453,1522,480"/> +<area shape="rect" href="core_8c.html" title=" " alt="" coords="1204,752,1265,779"/> +<area shape="rect" href="link_8h.html" title=" " alt="" coords="1759,528,1817,555"/> +<area shape="rect" href="module_8h.html" title=" " alt="" coords="1285,528,1368,555"/> +<area shape="rect" href="port_8h.html" title=" " alt="" coords="1690,453,1750,480"/> +<area shape="rect" href="remote_8h.html" title=" " alt="" coords="651,528,733,555"/> +<area shape="rect" href="proxy_8c.html" title=" " alt="" coords="870,603,938,629"/> +<area shape="rect" href="protocol_8h.html" title=" " alt="" coords="823,379,910,405"/> +<area shape="rect" href="control_8c.html" title=" " alt="" coords="1443,528,1522,555"/> +<area shape="rect" href="link_8c.html" title=" " alt="" coords="1566,603,1623,629"/> +<area shape="rect" href="device_8c.html" title=" " alt="" coords="421,752,497,779"/> +<area shape="rect" href="introspect_8c.html" title=" " alt="" coords="521,752,620,779"/> +<area shape="rect" href="loop_8c.html" title=" " alt="" coords="852,752,913,779"/> +<area shape="rect" href="pipewire_8c.html" title=" " alt="" coords="938,752,1027,779"/> +<area shape="rect" href="port_8c.html" title=" " alt="" coords="1800,752,1859,779"/> +<area shape="rect" href="remote_8c.html" title=" " alt="" coords="748,752,828,779"/> +<area shape="rect" href="stream_8c.html" title=" " alt="" coords="645,752,723,779"/> +<area shape="rect" href="module_8c.html" title=" " alt="" coords="1165,603,1248,629"/> +<area shape="rect" href="node_8c.html" title=" " alt="" coords="1425,603,1490,629"/> +<area shape="rect" href="stream_8h.html" title=" " alt="" coords="563,603,643,629"/> +<area shape="rect" href="factory_8c.html" title=" " alt="" coords="717,603,795,629"/> +<area shape="rect" href="proxy_8h.html" title=" " alt="" coords="841,453,911,480"/> +<area shape="rect" href="resource_8c.html" title=" " alt="" coords="398,603,487,629"/> +<area shape="rect" href="protocol_8c.html" title=" " alt="" coords="730,453,817,480"/> +<area shape="rect" href="interfaces_8h.html" title=" " alt="" coords="985,528,1084,555"/> +</map> +</div> +</div> +<p><a href="global_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__global__events.html">pw_global_events</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Global events, use <a class="el" href="global_8c.html#a26b8745d75bdc135ac052c3559a65121">pw_global_add_listener</a>. <a href="structpw__global__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:add2cfdc756b647e5f68c159a38473f40"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="global_8h.html#add2cfdc756b647e5f68c159a38473f40">PW_VERSION_GLOBAL_EVENTS</a>   0</td></tr> +<tr class="separator:add2cfdc756b647e5f68c159a38473f40"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> +Typedefs</h2></td></tr> +<tr class="memitem:a8f4782e0bbd14678ee3011c7af0686d5"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="global_8h.html#a8f4782e0bbd14678ee3011c7af0686d5">pw_global_bind_func_t</a>) (void *object, struct <a class="el" href="classpw__client.html">pw_client</a> *client, uint32_t permissions, uint32_t version, uint32_t id)</td></tr> +<tr class="separator:a8f4782e0bbd14678ee3011c7af0686d5"><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:aa0f72c722b24736151bda5c47324ad66"><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="global_8h.html#aa0f72c722b24736151bda5c47324ad66">pw_global_new</a> (struct <a class="el" href="classpw__core.html">pw_core</a> *core, uint32_t type, uint32_t version, struct <a class="el" href="structpw__properties.html">pw_properties</a> *properties, <a class="el" href="global_8h.html#a8f4782e0bbd14678ee3011c7af0686d5">pw_global_bind_func_t</a> func, void *object)</td></tr> +<tr class="memdesc:aa0f72c722b24736151bda5c47324ad66"><td class="mdescLeft"> </td><td class="mdescRight">Create a new global object. <a href="#aa0f72c722b24736151bda5c47324ad66">More...</a><br /></td></tr> +<tr class="separator:aa0f72c722b24736151bda5c47324ad66"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af0b886597338fe3e2e6d19717ac8b3fa"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="global_8h.html#af0b886597338fe3e2e6d19717ac8b3fa">pw_global_register</a> (struct <a class="el" href="classpw__global.html">pw_global</a> *global, struct <a class="el" href="classpw__client.html">pw_client</a> *owner, struct <a class="el" href="classpw__global.html">pw_global</a> *parent)</td></tr> +<tr class="memdesc:af0b886597338fe3e2e6d19717ac8b3fa"><td class="mdescLeft"> </td><td class="mdescRight">Register a global object to the core registry. <a href="#af0b886597338fe3e2e6d19717ac8b3fa">More...</a><br /></td></tr> +<tr class="separator:af0b886597338fe3e2e6d19717ac8b3fa"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a48ade1ac8c560225b6d54dedbc48836a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="global_8h.html#a48ade1ac8c560225b6d54dedbc48836a">pw_global_add_listener</a> (struct <a class="el" href="classpw__global.html">pw_global</a> *global, struct spa_hook *listener, const struct <a class="el" href="structpw__global__events.html">pw_global_events</a> *events, void *<a class="el" href="structdata.html">data</a>)</td></tr> +<tr class="memdesc:a48ade1ac8c560225b6d54dedbc48836a"><td class="mdescLeft"> </td><td class="mdescRight">Add an event listener on the global. <a href="#a48ade1ac8c560225b6d54dedbc48836a">More...</a><br /></td></tr> +<tr class="separator:a48ade1ac8c560225b6d54dedbc48836a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab983a411d18d68fa3025180fb49f321d"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="global_8h.html#ab983a411d18d68fa3025180fb49f321d">pw_global_get_permissions</a> (struct <a class="el" href="classpw__global.html">pw_global</a> *global, struct <a class="el" href="classpw__client.html">pw_client</a> *client)</td></tr> +<tr class="memdesc:ab983a411d18d68fa3025180fb49f321d"><td class="mdescLeft"> </td><td class="mdescRight">Get the permissions of the global for a given client. <a href="#ab983a411d18d68fa3025180fb49f321d">More...</a><br /></td></tr> +<tr class="separator:ab983a411d18d68fa3025180fb49f321d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad4762f982a141fbed7a84f010c276bdf"><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="global_8h.html#ad4762f982a141fbed7a84f010c276bdf">pw_global_get_core</a> (struct <a class="el" href="classpw__global.html">pw_global</a> *global)</td></tr> +<tr class="memdesc:ad4762f982a141fbed7a84f010c276bdf"><td class="mdescLeft"> </td><td class="mdescRight">Get the core object of this global. <a href="#ad4762f982a141fbed7a84f010c276bdf">More...</a><br /></td></tr> +<tr class="separator:ad4762f982a141fbed7a84f010c276bdf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a05278ae75cc03d08619a67af8ef5025a"><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="global_8h.html#a05278ae75cc03d08619a67af8ef5025a">pw_global_get_owner</a> (struct <a class="el" href="classpw__global.html">pw_global</a> *global)</td></tr> +<tr class="memdesc:a05278ae75cc03d08619a67af8ef5025a"><td class="mdescLeft"> </td><td class="mdescRight">Get the owner of the global. <a href="#a05278ae75cc03d08619a67af8ef5025a">More...</a><br /></td></tr> +<tr class="separator:a05278ae75cc03d08619a67af8ef5025a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acfb6023fde4e0d8f3264824f2415c131"><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="global_8h.html#acfb6023fde4e0d8f3264824f2415c131">pw_global_get_parent</a> (struct <a class="el" href="classpw__global.html">pw_global</a> *global)</td></tr> +<tr class="memdesc:acfb6023fde4e0d8f3264824f2415c131"><td class="mdescLeft"> </td><td class="mdescRight">Get the parent of a global. <a href="#acfb6023fde4e0d8f3264824f2415c131">More...</a><br /></td></tr> +<tr class="separator:acfb6023fde4e0d8f3264824f2415c131"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a11272070f9f30cc8db783fbab453f9b3"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="global_8h.html#a11272070f9f30cc8db783fbab453f9b3">pw_global_get_type</a> (struct <a class="el" href="classpw__global.html">pw_global</a> *global)</td></tr> +<tr class="memdesc:a11272070f9f30cc8db783fbab453f9b3"><td class="mdescLeft"> </td><td class="mdescRight">Get the global type. <a href="#a11272070f9f30cc8db783fbab453f9b3">More...</a><br /></td></tr> +<tr class="separator:a11272070f9f30cc8db783fbab453f9b3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3e5b2dd59d6cf7c614c3ed24b041a8b7"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="global_8h.html#a3e5b2dd59d6cf7c614c3ed24b041a8b7">pw_global_get_version</a> (struct <a class="el" href="classpw__global.html">pw_global</a> *global)</td></tr> +<tr class="memdesc:a3e5b2dd59d6cf7c614c3ed24b041a8b7"><td class="mdescLeft"> </td><td class="mdescRight">Get the global version. <a href="#a3e5b2dd59d6cf7c614c3ed24b041a8b7">More...</a><br /></td></tr> +<tr class="separator:a3e5b2dd59d6cf7c614c3ed24b041a8b7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac8b5326a91752657ed445c5d87010684"><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="global_8h.html#ac8b5326a91752657ed445c5d87010684">pw_global_get_properties</a> (struct <a class="el" href="classpw__global.html">pw_global</a> *global)</td></tr> +<tr class="memdesc:ac8b5326a91752657ed445c5d87010684"><td class="mdescLeft"> </td><td class="mdescRight">Get the global properties. <a href="#ac8b5326a91752657ed445c5d87010684">More...</a><br /></td></tr> +<tr class="separator:ac8b5326a91752657ed445c5d87010684"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae029163e030a00b9ef6148b128f26b60"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="global_8h.html#ae029163e030a00b9ef6148b128f26b60">pw_global_get_object</a> (struct <a class="el" href="classpw__global.html">pw_global</a> *global)</td></tr> +<tr class="memdesc:ae029163e030a00b9ef6148b128f26b60"><td class="mdescLeft"> </td><td class="mdescRight">Get the object associated with the global. <a href="#ae029163e030a00b9ef6148b128f26b60">More...</a><br /></td></tr> +<tr class="separator:ae029163e030a00b9ef6148b128f26b60"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5a70a0e4be433825f0e5baf7277c0e7e"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="global_8h.html#a5a70a0e4be433825f0e5baf7277c0e7e">pw_global_get_id</a> (struct <a class="el" href="classpw__global.html">pw_global</a> *global)</td></tr> +<tr class="memdesc:a5a70a0e4be433825f0e5baf7277c0e7e"><td class="mdescLeft"> </td><td class="mdescRight">Get the unique id of the global. <a href="#a5a70a0e4be433825f0e5baf7277c0e7e">More...</a><br /></td></tr> +<tr class="separator:a5a70a0e4be433825f0e5baf7277c0e7e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab3733783add50f8087bc6f551976798f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="global_8h.html#ab3733783add50f8087bc6f551976798f">pw_global_bind</a> (struct <a class="el" href="classpw__global.html">pw_global</a> *global, struct <a class="el" href="classpw__client.html">pw_client</a> *client, uint32_t permissions, uint32_t version, uint32_t id)</td></tr> +<tr class="memdesc:ab3733783add50f8087bc6f551976798f"><td class="mdescLeft"> </td><td class="mdescRight">Let a client bind to a global. <a href="#ab3733783add50f8087bc6f551976798f">More...</a><br /></td></tr> +<tr class="separator:ab3733783add50f8087bc6f551976798f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab916775315ec53e0d1fa5dac6d184a41"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="global_8h.html#ab916775315ec53e0d1fa5dac6d184a41">pw_global_update_permissions</a> (struct <a class="el" href="classpw__global.html">pw_global</a> *global, struct <a class="el" href="classpw__client.html">pw_client</a> *client, uint32_t old_permissions, uint32_t new_permissions)</td></tr> +<tr class="separator:ab916775315ec53e0d1fa5dac6d184a41"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a64e7b1922846aee0f5c9c6b16606506b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="global_8h.html#a64e7b1922846aee0f5c9c6b16606506b">pw_global_destroy</a> (struct <a class="el" href="classpw__global.html">pw_global</a> *global)</td></tr> +<tr class="memdesc:a64e7b1922846aee0f5c9c6b16606506b"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a global. <a href="#a64e7b1922846aee0f5c9c6b16606506b">More...</a><br /></td></tr> +<tr class="separator:a64e7b1922846aee0f5c9c6b16606506b"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Macro Definition Documentation</h2> +<a id="add2cfdc756b647e5f68c159a38473f40"></a> +<h2 class="memtitle"><span class="permalink"><a href="#add2cfdc756b647e5f68c159a38473f40">◆ </a></span>PW_VERSION_GLOBAL_EVENTS</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define PW_VERSION_GLOBAL_EVENTS   0</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Typedef Documentation</h2> +<a id="a8f4782e0bbd14678ee3011c7af0686d5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a8f4782e0bbd14678ee3011c7af0686d5">◆ </a></span>pw_global_bind_func_t</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef int(* pw_global_bind_func_t) (void *object, struct <a class="el" href="classpw__client.html">pw_client</a> *client, uint32_t permissions, uint32_t version, uint32_t id)</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Function Documentation</h2> +<a id="a48ade1ac8c560225b6d54dedbc48836a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a48ade1ac8c560225b6d54dedbc48836a">◆ </a></span>pw_global_add_listener()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void pw_global_add_listener </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__global.html">pw_global</a> * </td> + <td class="paramname"><em>global</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__global__events.html">pw_global_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>Add an event listener on the global. </p> + +</div> +</div> +<a id="ab3733783add50f8087bc6f551976798f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab3733783add50f8087bc6f551976798f">◆ </a></span>pw_global_bind()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int pw_global_bind </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__global.html">pw_global</a> * </td> + <td class="paramname"><em>global</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>client</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>permissions</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>version</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>Let a client bind to a global. </p> + +</div> +</div> +<a id="a64e7b1922846aee0f5c9c6b16606506b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a64e7b1922846aee0f5c9c6b16606506b">◆ </a></span>pw_global_destroy()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void pw_global_destroy </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__global.html">pw_global</a> * </td> + <td class="paramname"><em>global</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Destroy a global. </p> + +</div> +</div> +<a id="ad4762f982a141fbed7a84f010c276bdf"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad4762f982a141fbed7a84f010c276bdf">◆ </a></span>pw_global_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_global_get_core </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__global.html">pw_global</a> * </td> + <td class="paramname"><em>global</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the core object of this global. </p> + +</div> +</div> +<a id="a5a70a0e4be433825f0e5baf7277c0e7e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a5a70a0e4be433825f0e5baf7277c0e7e">◆ </a></span>pw_global_get_id()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">uint32_t pw_global_get_id </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__global.html">pw_global</a> * </td> + <td class="paramname"><em>global</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the unique id of the global. </p> + +</div> +</div> +<a id="ae029163e030a00b9ef6148b128f26b60"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae029163e030a00b9ef6148b128f26b60">◆ </a></span>pw_global_get_object()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void* pw_global_get_object </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__global.html">pw_global</a> * </td> + <td class="paramname"><em>global</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the object associated with the global. </p> +<p>This depends on the type of the global </p> + +</div> +</div> +<a id="a05278ae75cc03d08619a67af8ef5025a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a05278ae75cc03d08619a67af8ef5025a">◆ </a></span>pw_global_get_owner()</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_global_get_owner </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__global.html">pw_global</a> * </td> + <td class="paramname"><em>global</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the owner of the global. </p> +<p>This can be NULL when the core is owner </p> + +</div> +</div> +<a id="acfb6023fde4e0d8f3264824f2415c131"></a> +<h2 class="memtitle"><span class="permalink"><a href="#acfb6023fde4e0d8f3264824f2415c131">◆ </a></span>pw_global_get_parent()</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_global_get_parent </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__global.html">pw_global</a> * </td> + <td class="paramname"><em>global</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the parent of a global. </p> + +</div> +</div> +<a id="ab983a411d18d68fa3025180fb49f321d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab983a411d18d68fa3025180fb49f321d">◆ </a></span>pw_global_get_permissions()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">uint32_t pw_global_get_permissions </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__global.html">pw_global</a> * </td> + <td class="paramname"><em>global</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>client</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the permissions of the global for a given client. </p> + +<p class="reference">References <a class="el" href="permission_8h.html#a77df16320c3bb338666f55b2b21e6e47">PW_PERM_RWX</a>.</p> + +<p class="reference">Referenced by <a class="el" href="core_8c.html#a10a751bf1c704728191d9a7c31a63172">pw_core_find_global()</a>, <a class="el" href="classpw__core.html#a5d492e950bb2c4bbb47c3aa2ad348e66">pw_core::pw_core_find_port()</a>, <a class="el" href="core_8c.html#aab8cf5a0043f6702ac88f6718b5aac39">pw_core_for_each_global()</a>, and <a class="el" href="classpw__global.html#a9650909253626e9d1252b663591fc361">pw_global::pw_global_register()</a>.</p> +<div class="dynheader"> +Here is the caller graph for this function:</div> +<div class="dyncontent"> +<div class="center"><img src="global_8h_ab983a411d18d68fa3025180fb49f321d_icgraph.png" border="0" usemap="#global_8h_ab983a411d18d68fa3025180fb49f321d_icgraph" alt=""/></div> +<map name="global_8h_ab983a411d18d68fa3025180fb49f321d_icgraph" id="global_8h_ab983a411d18d68fa3025180fb49f321d_icgraph"> +<area shape="rect" title="Get the permissions of the global for a given client." alt="" coords="527,81,729,108"/> +<area shape="rect" href="core_8c.html#a10a751bf1c704728191d9a7c31a63172" title="Find a core global by id." alt="" coords="300,5,455,32"/> +<area shape="rect" href="classpw__core.html#a5d492e950bb2c4bbb47c3aa2ad348e66" title="Find a port to link with." alt="" coords="276,56,479,83"/> +<area shape="rect" href="core_8c.html#aab8cf5a0043f6702ac88f6718b5aac39" title="Iterate the globals of the core." alt="" coords="284,107,471,133"/> +<area shape="rect" href="classpw__global.html#a9650909253626e9d1252b663591fc361" title="register a global to the core registry" alt="" coords="296,158,459,199"/> +<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="ac8b5326a91752657ed445c5d87010684"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac8b5326a91752657ed445c5d87010684">◆ </a></span>pw_global_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_global_get_properties </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__global.html">pw_global</a> * </td> + <td class="paramname"><em>global</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the global properties. </p> + +</div> +</div> +<a id="a11272070f9f30cc8db783fbab453f9b3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a11272070f9f30cc8db783fbab453f9b3">◆ </a></span>pw_global_get_type()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">uint32_t pw_global_get_type </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__global.html">pw_global</a> * </td> + <td class="paramname"><em>global</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the global type. </p> + +</div> +</div> +<a id="a3e5b2dd59d6cf7c614c3ed24b041a8b7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a3e5b2dd59d6cf7c614c3ed24b041a8b7">◆ </a></span>pw_global_get_version()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">uint32_t pw_global_get_version </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__global.html">pw_global</a> * </td> + <td class="paramname"><em>global</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the global version. </p> + +</div> +</div> +<a id="aa0f72c722b24736151bda5c47324ad66"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa0f72c722b24736151bda5c47324ad66">◆ </a></span>pw_global_new()</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_global_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">uint32_t </td> + <td class="paramname"><em>type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>version</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"><a class="el" href="global_8h.html#a8f4782e0bbd14678ee3011c7af0686d5">pw_global_bind_func_t</a> </td> + <td class="paramname"><em>func</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>object</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Create a new global object. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">core</td><td>the core </td></tr> + <tr><td class="paramname">type</td><td>the interface type of the global </td></tr> + <tr><td class="paramname">version</td><td>the interface version of the global </td></tr> + <tr><td class="paramname">properties</td><td>extra properties </td></tr> + <tr><td class="paramname">func</td><td>function to bind </td></tr> + <tr><td class="paramname">object</td><td>global object </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="af0b886597338fe3e2e6d19717ac8b3fa"></a> +<h2 class="memtitle"><span class="permalink"><a href="#af0b886597338fe3e2e6d19717ac8b3fa">◆ </a></span>pw_global_register()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int pw_global_register </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__global.html">pw_global</a> * </td> + <td class="paramname"><em>global</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></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Register a global object to the core registry. </p> + +</div> +</div> +<a id="ab916775315ec53e0d1fa5dac6d184a41"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab916775315ec53e0d1fa5dac6d184a41">◆ </a></span>pw_global_update_permissions()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int pw_global_update_permissions </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__global.html">pw_global</a> * </td> + <td class="paramname"><em>global</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>client</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>old_permissions</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>new_permissions</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="reference">References <a class="el" href="classpw__log.html#a98a49c37f11de525890014e927e34d02">pw_log::pw_log_debug</a>, <a class="el" href="permission_8h.html#a2668b1c9a4b1e4b68fefe81e55d1ee59">PW_PERM_IS_R</a>, and <a class="el" href="resource_8h.html#ab9e159d75b7efe39bd53b64055244092">pw_resource_destroy()</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="global_8h_ab916775315ec53e0d1fa5dac6d184a41_icgraph.png" border="0" usemap="#global_8h_ab916775315ec53e0d1fa5dac6d184a41_icgraph" alt=""/></div> +<map name="global_8h_ab916775315ec53e0d1fa5dac6d184a41_icgraph" id="global_8h_ab916775315ec53e0d1fa5dac6d184a41_icgraph"> +<area shape="rect" title=" " alt="" coords="276,5,503,32"/> +<area shape="rect" href="client_8c.html#aa4a8794d28485a52146b71c1fad7a479" title="Update the client permissions." alt="" coords="5,5,228,32"/> +</map> +</div> + +</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="global_8h.html">global.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> |