diff options
Diffstat (limited to 'classpw__link.html')
| -rw-r--r-- | classpw__link.html | 248 |
1 files changed, 248 insertions, 0 deletions
diff --git a/classpw__link.html b/classpw__link.html new file mode 100644 index 00000000..b990124a --- /dev/null +++ b/classpw__link.html @@ -0,0 +1,248 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.15"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>PipeWire: pw_link Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ + $(document).ready(initResizable); +/* @license-end */</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">PipeWire +  <span id="projectnumber">0.2.9</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.15 --> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(function() { + initMenu('',false,false,'search.php','Search'); +}); +/* @license-end */</script> +<div id="main-nav"></div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('classpw__link.html','');}); +/* @license-end */ +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> </div> + <div class="headertitle"> +<div class="title">pw_link Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>PipeWire link object. + <a href="classpw__link.html#details">More...</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a364b6ed143112bf432e1795503cc8e6e"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__link.html#a364b6ed143112bf432e1795503cc8e6e">pw_link_state_as_string</a> (enum <a class="el" href="introspect_8h.html#a7859f6eb040fead1673d0214b83b445b">pw_link_state</a> state)</td></tr> +<tr class="memdesc:a364b6ed143112bf432e1795503cc8e6e"><td class="mdescLeft"> </td><td class="mdescRight">Convert a <a class="el" href="introspect_8h.html#a7859f6eb040fead1673d0214b83b445b">pw_link_state</a> to a readable string. <a href="#a364b6ed143112bf432e1795503cc8e6e">More...</a><br /></td></tr> +<tr class="separator:a364b6ed143112bf432e1795503cc8e6e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abe1e6f1106e620207e385a7b30cc010d"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="classpw__link.html">pw_link</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__link.html#abe1e6f1106e620207e385a7b30cc010d">pw_link_new</a> (struct <a class="el" href="classpw__core.html">pw_core</a> *core, struct <a class="el" href="classpw__port.html">pw_port</a> *output, struct <a class="el" href="classpw__port.html">pw_port</a> *input, struct spa_pod *format_filter, struct <a class="el" href="structpw__properties.html">pw_properties</a> *properties, size_t user_data_size)</td></tr> +<tr class="memdesc:abe1e6f1106e620207e385a7b30cc010d"><td class="mdescLeft"> </td><td class="mdescRight">Make a new link between two ports. <a href="#abe1e6f1106e620207e385a7b30cc010d">More...</a><br /></td></tr> +<tr class="separator:abe1e6f1106e620207e385a7b30cc010d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aadeb0d2c1a9f239d6a8538810b69e06a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__link.html#aadeb0d2c1a9f239d6a8538810b69e06a">pw_link_destroy</a> (struct <a class="el" href="classpw__link.html">pw_link</a> *link)</td></tr> +<tr class="memdesc:aadeb0d2c1a9f239d6a8538810b69e06a"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a link. <a href="#aadeb0d2c1a9f239d6a8538810b69e06a">More...</a><br /></td></tr> +<tr class="separator:aadeb0d2c1a9f239d6a8538810b69e06a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac47df3717749e208df9374b42bf77464"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="classpw__link.html">pw_link</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__link.html#ac47df3717749e208df9374b42bf77464">pw_link_find</a> (struct <a class="el" href="classpw__port.html">pw_port</a> *output, struct <a class="el" href="classpw__port.html">pw_port</a> *input)</td></tr> +<tr class="memdesc:ac47df3717749e208df9374b42bf77464"><td class="mdescLeft"> </td><td class="mdescRight">Find the link between 2 ports. <a href="#ac47df3717749e208df9374b42bf77464">More...</a><br /></td></tr> +<tr class="separator:ac47df3717749e208df9374b42bf77464"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>PipeWire link object. </p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="aadeb0d2c1a9f239d6a8538810b69e06a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aadeb0d2c1a9f239d6a8538810b69e06a">◆ </a></span>pw_link_destroy()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void pw_link_destroy </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__link.html">pw_link</a> * </td> + <td class="paramname"><em>link</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Destroy a link. </p> + +</div> +</div> +<a id="ac47df3717749e208df9374b42bf77464"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac47df3717749e208df9374b42bf77464">◆ </a></span>pw_link_find()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="classpw__link.html">pw_link</a> * pw_link_find </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__port.html">pw_port</a> * </td> + <td class="paramname"><em>output</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">struct <a class="el" href="classpw__port.html">pw_port</a> * </td> + <td class="paramname"><em>input</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Find the link between 2 ports. </p> + +<p class="reference">Referenced by <a class="el" href="link_8c.html#aad626afd3c5efcca566444cfa6f7f6f4">pw_link_new()</a>.</p> + +</div> +</div> +<a id="abe1e6f1106e620207e385a7b30cc010d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abe1e6f1106e620207e385a7b30cc010d">◆ </a></span>pw_link_new()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="classpw__link.html">pw_link</a> * pw_link_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="classpw__port.html">pw_port</a> * </td> + <td class="paramname"><em>output</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">struct <a class="el" href="classpw__port.html">pw_port</a> * </td> + <td class="paramname"><em>input</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">struct spa_pod * </td> + <td class="paramname"><em>format_filter</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>Make a new link between two ports. </p> +<dl class="section return"><dt>Returns</dt><dd>a newly allocated link </dd></dl> +<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">output</td><td>an output port </td></tr> + <tr><td class="paramname">input</td><td>an input port </td></tr> + <tr><td class="paramname">format_filter</td><td>an optional format filter </td></tr> + <tr><td class="paramname">properties</td><td>extra 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="a364b6ed143112bf432e1795503cc8e6e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a364b6ed143112bf432e1795503cc8e6e">◆ </a></span>pw_link_state_as_string()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char * pw_link_state_as_string </td> + <td>(</td> + <td class="paramtype">enum <a class="el" href="introspect_8h.html#a7859f6eb040fead1673d0214b83b445b">pw_link_state</a> </td> + <td class="paramname"><em>state</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Convert a <a class="el" href="introspect_8h.html#a7859f6eb040fead1673d0214b83b445b">pw_link_state</a> to a readable string. </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="link_8h_source.html">link.h</a></li> +<li><a class="el" href="introspect_8h_source.html">introspect.h</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="classpw__link.html">pw_link</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> |