diff options
Diffstat (limited to 'classpw__node.html')
| -rw-r--r-- | classpw__node.html | 258 |
1 files changed, 258 insertions, 0 deletions
diff --git a/classpw__node.html b/classpw__node.html new file mode 100644 index 00000000..4a5e3a4a --- /dev/null +++ b/classpw__node.html @@ -0,0 +1,258 @@ +<!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_node 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__node.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_node Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>PipeWire node class. + <a href="classpw__node.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:abdc61213ac88ea6daf6141e0130d0430"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__node.html#abdc61213ac88ea6daf6141e0130d0430">pw_node_state_as_string</a> (enum <a class="el" href="introspect_8h.html#ac493839c0b0a1d0b935969f2e990a2df">pw_node_state</a> state)</td></tr> +<tr class="memdesc:abdc61213ac88ea6daf6141e0130d0430"><td class="mdescLeft"> </td><td class="mdescRight">Convert a <a class="el" href="introspect_8h.html#ac493839c0b0a1d0b935969f2e990a2df">pw_node_state</a> to a readable string. <a href="#abdc61213ac88ea6daf6141e0130d0430">More...</a><br /></td></tr> +<tr class="separator:abdc61213ac88ea6daf6141e0130d0430"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae65ce8c47bb46b01f3f8f62691e840ef"><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="classpw__node.html#ae65ce8c47bb46b01f3f8f62691e840ef">pw_node_new</a> (struct <a class="el" href="classpw__core.html">pw_core</a> *core, const char *name, struct <a class="el" href="structpw__properties.html">pw_properties</a> *properties, size_t user_data_size)</td></tr> +<tr class="memdesc:ae65ce8c47bb46b01f3f8f62691e840ef"><td class="mdescLeft"> </td><td class="mdescRight">Create a new node. <a href="#ae65ce8c47bb46b01f3f8f62691e840ef">More...</a><br /></td></tr> +<tr class="separator:ae65ce8c47bb46b01f3f8f62691e840ef"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a797514cde71af23b5a27744d951ca83a"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__node.html#a797514cde71af23b5a27744d951ca83a">pw_node_destroy</a> (struct <a class="el" href="classpw__node.html">pw_node</a> *node)</td></tr> +<tr class="memdesc:a797514cde71af23b5a27744d951ca83a"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a node. <a href="#a797514cde71af23b5a27744d951ca83a">More...</a><br /></td></tr> +<tr class="separator:a797514cde71af23b5a27744d951ca83a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a917a928da33a9142b505fbdc42a69c8c"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__node.html#a917a928da33a9142b505fbdc42a69c8c">pw_node_set_state</a> (struct <a class="el" href="classpw__node.html">pw_node</a> *node, enum <a class="el" href="introspect_8h.html#ac493839c0b0a1d0b935969f2e990a2df">pw_node_state</a> state)</td></tr> +<tr class="memdesc:a917a928da33a9142b505fbdc42a69c8c"><td class="mdescLeft"> </td><td class="mdescRight">Set the node state. <a href="#a917a928da33a9142b505fbdc42a69c8c">More...</a><br /></td></tr> +<tr class="separator:a917a928da33a9142b505fbdc42a69c8c"><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 node class. </p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="a797514cde71af23b5a27744d951ca83a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a797514cde71af23b5a27744d951ca83a">◆ </a></span>pw_node_destroy()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT void pw_node_destroy </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__node.html">pw_node</a> * </td> + <td class="paramname"><em>node</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Destroy a node. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">node</td><td>a node to destroy</td></tr> + </table> + </dd> +</dl> +<p>Remove <em>node</em>. This will stop the transfer on the node and free the resources allocated by <em>node</em>. </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="classpw__core.html#a3fe8a902e97223d11c0e8e4640c16379">pw_core::pw_core_destroy()</a>, <a class="el" href="device_8c.html#a413c1f742b769410a3400e4859d92588">pw_device_destroy()</a>, and <a class="el" href="stream_8c.html#a430884fd1ac91c74cb5574400a619216">pw_stream_disconnect()</a>.</p> + +</div> +</div> +<a id="ae65ce8c47bb46b01f3f8f62691e840ef"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae65ce8c47bb46b01f3f8f62691e840ef">◆ </a></span>pw_node_new()</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_node_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">const char * </td> + <td class="paramname"><em>name</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 node. </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">name</td><td>node name </td></tr> + <tr><td class="paramname">properties</td><td>extra properties </td></tr> + <tr><td class="paramname">user_data_size</td><td>user data size </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="a917a928da33a9142b505fbdc42a69c8c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a917a928da33a9142b505fbdc42a69c8c">◆ </a></span>pw_node_set_state()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT int pw_node_set_state </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__node.html">pw_node</a> * </td> + <td class="paramname"><em>node</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">enum <a class="el" href="introspect_8h.html#ac493839c0b0a1d0b935969f2e990a2df">pw_node_state</a> </td> + <td class="paramname"><em>state</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Set the node state. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">node</td><td>a <a class="el" href="classpw__node.html">pw_node</a> </td></tr> + <tr><td class="paramname">state</td><td>a <a class="el" href="introspect_8h.html#ac493839c0b0a1d0b935969f2e990a2df">pw_node_state</a> </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>0 on success < 0 on error</dd></dl> +<p>Set the state of <em>node</em> to <em>state</em>. </p> + +<p class="reference">References <a class="el" href="classpw__log.html#a98a49c37f11de525890014e927e34d02">pw_log::pw_log_debug</a>, <a class="el" href="classpw__node.html#abdc61213ac88ea6daf6141e0130d0430">pw_node_state_as_string()</a>, <a class="el" href="introspect_8h.html#ac493839c0b0a1d0b935969f2e990a2dfaa73a63afebf017a0c0afdea192b1691c">PW_NODE_STATE_CREATING</a>, and <a class="el" href="introspect_8h.html#ac493839c0b0a1d0b935969f2e990a2dfa715c586abce5cbbc09db32145a51e82f">PW_NODE_STATE_SUSPENDED</a>.</p> + +<p class="reference">Referenced by <a class="el" href="node_8c.html#a6e46d05a86640c2b6ad70bc161db419d">pw_node_set_active()</a>.</p> + +</div> +</div> +<a id="abdc61213ac88ea6daf6141e0130d0430"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abdc61213ac88ea6daf6141e0130d0430">◆ </a></span>pw_node_state_as_string()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char * pw_node_state_as_string </td> + <td>(</td> + <td class="paramtype">enum <a class="el" href="introspect_8h.html#ac493839c0b0a1d0b935969f2e990a2df">pw_node_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#ac493839c0b0a1d0b935969f2e990a2df">pw_node_state</a> to a readable string. </p> + +<p class="reference">Referenced by <a class="el" href="classpw__node.html#a917a928da33a9142b505fbdc42a69c8c">pw_node_set_state()</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="node_8h_source.html">node.h</a></li> +<li><a class="el" href="introspect_8h_source.html">introspect.h</a></li> +<li><a class="el" href="node_8c.html">node.c</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__node.html">pw_node</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> |