diff options
Diffstat (limited to 'build/doc/html/port_8h.html')
| -rw-r--r-- | build/doc/html/port_8h.html | 383 |
1 files changed, 383 insertions, 0 deletions
diff --git a/build/doc/html/port_8h.html b/build/doc/html/port_8h.html new file mode 100644 index 00000000..1fb8cc8f --- /dev/null +++ b/build/doc/html/port_8h.html @@ -0,0 +1,383 @@ +<!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: port.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('port_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="#enum-members">Enumerations</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">port.h File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><div class="dynheader"> +Include dependency graph for port.h:</div> +<div class="dyncontent"> +<div class="center"><img src="port_8h__incl.png" border="0" usemap="#port_8h" alt=""/></div> +<map name="port_8h" id="port_8h"> +<area shape="rect" title=" " alt="" coords="903,5,963,32"/> +<area shape="rect" title=" " alt="" coords="217,453,343,480"/> +<area shape="rect" href="core_8h.html" title=" " alt="" coords="744,155,867,181"/> +<area shape="rect" href="introspect_8h.html" title=" " alt="" coords="1059,379,1218,405"/> +<area shape="rect" href="node_8h.html" title=" " alt="" coords="870,80,997,107"/> +<area shape="rect" title=" " alt="" coords="939,453,1061,480"/> +<area shape="rect" href="client_8h.html" title=" " alt="" coords="649,304,780,331"/> +<area shape="rect" href="global_8h.html" title=" " alt="" coords="849,379,983,405"/> +<area shape="rect" href="properties_8h.html" title=" " alt="" coords="515,453,675,480"/> +<area shape="rect" href="loop_8h.html" title=" " alt="" coords="216,229,339,256"/> +<area shape="rect" href="factory_8h.html" title=" " alt="" coords="617,229,756,256"/> +<area shape="rect" href="resource_8h.html" title=" " alt="" coords="330,379,481,405"/> +<area shape="rect" href="permission_8h.html" title=" " alt="" coords="658,379,825,405"/> +<area shape="rect" title=" " alt="" coords="536,528,653,555"/> +<area shape="rect" title=" " alt="" coords="1085,453,1235,480"/> +<area shape="rect" title=" " alt="" coords="145,304,287,331"/> +<area shape="rect" title=" " alt="" coords="1095,155,1230,181"/> +</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="port_8h__dep__incl.png" border="0" usemap="#port_8hdep" alt=""/></div> +<map name="port_8hdep" id="port_8hdep"> +<area shape="rect" title=" " alt="" coords="145,5,205,32"/> +<area shape="rect" href="link_8h.html" title=" " alt="" coords="79,155,137,181"/> +<area shape="rect" href="pipewire_8h.html" title=" " alt="" coords="373,304,464,331"/> +<area shape="rect" href="port_8c.html" title=" " alt="" coords="5,379,64,405"/> +<area shape="rect" href="node_8h.html" title=" " alt="" coords="260,80,327,107"/> +<area shape="rect" href="link_8c.html" title=" " alt="" coords="217,229,274,256"/> +<area shape="rect" href="core_8c.html" title=" " alt="" coords="307,379,368,405"/> +<area shape="rect" href="device_8c.html" title=" " alt="" coords="393,379,469,405"/> +<area shape="rect" href="introspect_8c.html" title=" " alt="" coords="683,379,781,405"/> +<area shape="rect" href="loop_8c.html" title=" " alt="" coords="493,379,555,405"/> +<area shape="rect" href="pipewire_8c.html" title=" " alt="" coords="89,379,178,405"/> +<area shape="rect" href="remote_8c.html" title=" " alt="" coords="203,379,283,405"/> +<area shape="rect" href="stream_8c.html" title=" " alt="" coords="579,379,658,405"/> +<area shape="rect" href="control_8h.html" title=" " alt="" coords="302,155,381,181"/> +<area shape="rect" href="remote_8h.html" title=" " alt="" coords="501,155,582,181"/> +<area shape="rect" href="node_8c.html" title=" " alt="" coords="213,155,278,181"/> +<area shape="rect" href="control_8c.html" title=" " alt="" coords="302,229,381,256"/> +<area shape="rect" href="stream_8h.html" title=" " alt="" coords="600,229,680,256"/> +<area shape="rect" href="proxy_8c.html" title=" " alt="" coords="507,229,575,256"/> +</map> +</div> +</div> +<p><a href="port_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__port__events.html">pw_port_events</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Port events, use <a class="el" href="port_8c.html#aa50d4a012d26a1cb01b25f02390abb82">pw_port_add_listener</a>. <a href="structpw__port__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:a2d08d6e2358afc05ca212a0258fb6a26"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="port_8h.html#a2d08d6e2358afc05ca212a0258fb6a26">PW_VERSION_PORT_EVENTS</a>   0</td></tr> +<tr class="separator:a2d08d6e2358afc05ca212a0258fb6a26"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> +Enumerations</h2></td></tr> +<tr class="memitem:adbdfd176064e149c49e7c4bbbdd1e3a6"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="port_8h.html#adbdfd176064e149c49e7c4bbbdd1e3a6">pw_port_state</a> { <br /> +  <a class="el" href="port_8h.html#adbdfd176064e149c49e7c4bbbdd1e3a6a0db5ddd15b188c1f747499c8d75f20c2">PW_PORT_STATE_ERROR</a> = -1, +<br /> +  <a class="el" href="port_8h.html#adbdfd176064e149c49e7c4bbbdd1e3a6a921e399f53a6dd90a1721022d87931ca">PW_PORT_STATE_INIT</a> = 0, +<br /> +  <a class="el" href="port_8h.html#adbdfd176064e149c49e7c4bbbdd1e3a6a4198e858d11461bc8b1ce179b579b537">PW_PORT_STATE_CONFIGURE</a> = 1, +<br /> +  <a class="el" href="port_8h.html#adbdfd176064e149c49e7c4bbbdd1e3a6ae71d3a847559a838fe9bd5bf8c07faa2">PW_PORT_STATE_READY</a> = 2, +<br /> +  <a class="el" href="port_8h.html#adbdfd176064e149c49e7c4bbbdd1e3a6a15f1ec0a36d9e4f9dd3d7304243044a9">PW_PORT_STATE_PAUSED</a> = 3 +<br /> + }</td></tr> +<tr class="separator:adbdfd176064e149c49e7c4bbbdd1e3a6"><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:a53aab0d888eb07c1543dee1c55e5c681"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="introspect_8h.html#a6e9e847059d68cbdb608abc8eb6b631d">pw_direction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="port_8h.html#a53aab0d888eb07c1543dee1c55e5c681">pw_port_get_direction</a> (struct <a class="el" href="classpw__port.html">pw_port</a> *port)</td></tr> +<tr class="memdesc:a53aab0d888eb07c1543dee1c55e5c681"><td class="mdescLeft"> </td><td class="mdescRight">Get the port direction. <a href="#a53aab0d888eb07c1543dee1c55e5c681">More...</a><br /></td></tr> +<tr class="separator:a53aab0d888eb07c1543dee1c55e5c681"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a265fceb6afcbf35100789c8604adb8ef"><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="port_8h.html#a265fceb6afcbf35100789c8604adb8ef">pw_port_get_properties</a> (struct <a class="el" href="classpw__port.html">pw_port</a> *port)</td></tr> +<tr class="memdesc:a265fceb6afcbf35100789c8604adb8ef"><td class="mdescLeft"> </td><td class="mdescRight">Get the port properties. <a href="#a265fceb6afcbf35100789c8604adb8ef">More...</a><br /></td></tr> +<tr class="separator:a265fceb6afcbf35100789c8604adb8ef"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6415901538a39fe66d36263ea9ca79cc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="port_8h.html#a6415901538a39fe66d36263ea9ca79cc">pw_port_update_properties</a> (struct <a class="el" href="classpw__port.html">pw_port</a> *port, const struct spa_dict *dict)</td></tr> +<tr class="memdesc:a6415901538a39fe66d36263ea9ca79cc"><td class="mdescLeft"> </td><td class="mdescRight">Update the port properties. <a href="#a6415901538a39fe66d36263ea9ca79cc">More...</a><br /></td></tr> +<tr class="separator:a6415901538a39fe66d36263ea9ca79cc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2461fe53d57c257892e36e7d37ae3e24"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="port_8h.html#a2461fe53d57c257892e36e7d37ae3e24">pw_port_get_id</a> (struct <a class="el" href="classpw__port.html">pw_port</a> *port)</td></tr> +<tr class="memdesc:a2461fe53d57c257892e36e7d37ae3e24"><td class="mdescLeft"> </td><td class="mdescRight">Get the port id. <a href="#a2461fe53d57c257892e36e7d37ae3e24">More...</a><br /></td></tr> +<tr class="separator:a2461fe53d57c257892e36e7d37ae3e24"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a501ca4956581fbd1a4fe94f3b46d1dec"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="classpw__node.html">pw_node</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="port_8h.html#a501ca4956581fbd1a4fe94f3b46d1dec">pw_port_get_node</a> (struct <a class="el" href="classpw__port.html">pw_port</a> *port)</td></tr> +<tr class="memdesc:a501ca4956581fbd1a4fe94f3b46d1dec"><td class="mdescLeft"> </td><td class="mdescRight">Get the port parent node or NULL when not yet set. <a href="#a501ca4956581fbd1a4fe94f3b46d1dec">More...</a><br /></td></tr> +<tr class="separator:a501ca4956581fbd1a4fe94f3b46d1dec"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6d61253f97045f6452627a0de7e0a0fc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="port_8h.html#a6d61253f97045f6452627a0de7e0a0fc">pw_port_add_listener</a> (struct <a class="el" href="classpw__port.html">pw_port</a> *port, struct spa_hook *listener, const struct <a class="el" href="structpw__port__events.html">pw_port_events</a> *events, void *<a class="el" href="structdata.html">data</a>)</td></tr> +<tr class="memdesc:a6d61253f97045f6452627a0de7e0a0fc"><td class="mdescLeft"> </td><td class="mdescRight">Add an event listener on the port. <a href="#a6d61253f97045f6452627a0de7e0a0fc">More...</a><br /></td></tr> +<tr class="separator:a6d61253f97045f6452627a0de7e0a0fc"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Macro Definition Documentation</h2> +<a id="a2d08d6e2358afc05ca212a0258fb6a26"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2d08d6e2358afc05ca212a0258fb6a26">◆ </a></span>PW_VERSION_PORT_EVENTS</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define PW_VERSION_PORT_EVENTS   0</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Enumeration Type Documentation</h2> +<a id="adbdfd176064e149c49e7c4bbbdd1e3a6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#adbdfd176064e149c49e7c4bbbdd1e3a6">◆ </a></span>pw_port_state</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="port_8h.html#adbdfd176064e149c49e7c4bbbdd1e3a6">pw_port_state</a></td> + </tr> + </table> +</div><div class="memdoc"> +<table class="fieldtable"> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="adbdfd176064e149c49e7c4bbbdd1e3a6a0db5ddd15b188c1f747499c8d75f20c2"></a>PW_PORT_STATE_ERROR </td><td class="fielddoc"><p>the port is in error </p> +</td></tr> +<tr><td class="fieldname"><a id="adbdfd176064e149c49e7c4bbbdd1e3a6a921e399f53a6dd90a1721022d87931ca"></a>PW_PORT_STATE_INIT </td><td class="fielddoc"><p>the port is being created </p> +</td></tr> +<tr><td class="fieldname"><a id="adbdfd176064e149c49e7c4bbbdd1e3a6a4198e858d11461bc8b1ce179b579b537"></a>PW_PORT_STATE_CONFIGURE </td><td class="fielddoc"><p>the port is ready for format negotiation </p> +</td></tr> +<tr><td class="fieldname"><a id="adbdfd176064e149c49e7c4bbbdd1e3a6ae71d3a847559a838fe9bd5bf8c07faa2"></a>PW_PORT_STATE_READY </td><td class="fielddoc"><p>the port is ready for buffer allocation </p> +</td></tr> +<tr><td class="fieldname"><a id="adbdfd176064e149c49e7c4bbbdd1e3a6a15f1ec0a36d9e4f9dd3d7304243044a9"></a>PW_PORT_STATE_PAUSED </td><td class="fielddoc"><p>the port is paused </p> +</td></tr> +</table> + +</div> +</div> +<h2 class="groupheader">Function Documentation</h2> +<a id="a6d61253f97045f6452627a0de7e0a0fc"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6d61253f97045f6452627a0de7e0a0fc">◆ </a></span>pw_port_add_listener()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void pw_port_add_listener </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__port.html">pw_port</a> * </td> + <td class="paramname"><em>port</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__port__events.html">pw_port_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 port. </p> + +</div> +</div> +<a id="a53aab0d888eb07c1543dee1c55e5c681"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a53aab0d888eb07c1543dee1c55e5c681">◆ </a></span>pw_port_get_direction()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="introspect_8h.html#a6e9e847059d68cbdb608abc8eb6b631d">pw_direction</a> pw_port_get_direction </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__port.html">pw_port</a> * </td> + <td class="paramname"><em>port</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the port direction. </p> + +</div> +</div> +<a id="a2461fe53d57c257892e36e7d37ae3e24"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2461fe53d57c257892e36e7d37ae3e24">◆ </a></span>pw_port_get_id()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">uint32_t pw_port_get_id </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__port.html">pw_port</a> * </td> + <td class="paramname"><em>port</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the port id. </p> + +</div> +</div> +<a id="a501ca4956581fbd1a4fe94f3b46d1dec"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a501ca4956581fbd1a4fe94f3b46d1dec">◆ </a></span>pw_port_get_node()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="classpw__node.html">pw_node</a>* pw_port_get_node </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__port.html">pw_port</a> * </td> + <td class="paramname"><em>port</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the port parent node or NULL when not yet set. </p> + +</div> +</div> +<a id="a265fceb6afcbf35100789c8604adb8ef"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a265fceb6afcbf35100789c8604adb8ef">◆ </a></span>pw_port_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_port_get_properties </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__port.html">pw_port</a> * </td> + <td class="paramname"><em>port</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the port properties. </p> + +</div> +</div> +<a id="a6415901538a39fe66d36263ea9ca79cc"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6415901538a39fe66d36263ea9ca79cc">◆ </a></span>pw_port_update_properties()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int pw_port_update_properties </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__port.html">pw_port</a> * </td> + <td class="paramname"><em>port</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 port 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="port_8h.html">port.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> |