diff options
Diffstat (limited to 'main-loop_8h.html')
| -rw-r--r-- | main-loop_8h.html | 313 |
1 files changed, 313 insertions, 0 deletions
diff --git a/main-loop_8h.html b/main-loop_8h.html new file mode 100644 index 00000000..8a04d2da --- /dev/null +++ b/main-loop_8h.html @@ -0,0 +1,313 @@ +<!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: main-loop.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('main-loop_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">main-loop.h File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><div class="dynheader"> +Include dependency graph for main-loop.h:</div> +<div class="dyncontent"> +<div class="center"><img src="main-loop_8h__incl.png" border="0" usemap="#main-loop_8h" alt=""/></div> +<map name="main-loop_8h" id="main-loop_8h"> +<area shape="rect" title=" " alt="" coords="153,5,253,32"/> +<area shape="rect" href="loop_8h.html" title=" " alt="" coords="93,80,215,107"/> +<area shape="rect" href="properties_8h.html" title=" " alt="" coords="173,155,333,181"/> +<area shape="rect" title=" " alt="" coords="5,155,148,181"/> +<area shape="rect" title=" " alt="" coords="194,229,311,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="main-loop_8h__dep__incl.png" border="0" usemap="#main-loop_8hdep" alt=""/></div> +<map name="main-loop_8hdep" id="main-loop_8hdep"> +<area shape="rect" title=" " alt="" coords="463,5,563,32"/> +<area shape="rect" href="pipewire_8h.html" title=" " alt="" coords="349,80,440,107"/> +<area shape="rect" href="main-loop_8c.html" title=" " alt="" coords="464,80,563,107"/> +<area shape="rect" href="node_8c.html" title=" " alt="" coords="587,80,653,107"/> +<area shape="rect" href="core_8c.html" title=" " alt="" coords="5,155,67,181"/> +<area shape="rect" href="device_8c.html" title=" " alt="" coords="91,155,167,181"/> +<area shape="rect" href="introspect_8c.html" title=" " alt="" coords="192,155,291,181"/> +<area shape="rect" href="loop_8c.html" title=" " alt="" coords="315,155,376,181"/> +<area shape="rect" href="pipewire_8c.html" title=" " alt="" coords="401,155,490,181"/> +<area shape="rect" href="port_8c.html" title=" " alt="" coords="515,155,573,181"/> +<area shape="rect" href="remote_8c.html" title=" " alt="" coords="597,155,677,181"/> +<area shape="rect" href="stream_8c.html" title=" " alt="" coords="702,155,781,181"/> +</map> +</div> +</div> +<p><a href="main-loop_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__main__loop__events.html">pw_main_loop_events</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Events of the main loop. <a href="structpw__main__loop__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:a3310e380c0368cb007552027a040ff96"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="main-loop_8h.html#a3310e380c0368cb007552027a040ff96">PW_VERSION_MAIN_LOOP_EVENTS</a>   0</td></tr> +<tr class="separator:a3310e380c0368cb007552027a040ff96"><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:ac020a4bf35819b8d4a83c6b7edd9a78f"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="classpw__main__loop.html">pw_main_loop</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="main-loop_8h.html#ac020a4bf35819b8d4a83c6b7edd9a78f">pw_main_loop_new</a> (struct <a class="el" href="structpw__properties.html">pw_properties</a> *properties)</td></tr> +<tr class="memdesc:ac020a4bf35819b8d4a83c6b7edd9a78f"><td class="mdescLeft"> </td><td class="mdescRight">Create a new main loop. <a href="#ac020a4bf35819b8d4a83c6b7edd9a78f">More...</a><br /></td></tr> +<tr class="separator:ac020a4bf35819b8d4a83c6b7edd9a78f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae2ca7b19516a0245b0da1756a82ca753"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="main-loop_8h.html#ae2ca7b19516a0245b0da1756a82ca753">pw_main_loop_add_listener</a> (struct <a class="el" href="classpw__main__loop.html">pw_main_loop</a> *loop, struct spa_hook *listener, const struct <a class="el" href="structpw__main__loop__events.html">pw_main_loop_events</a> *events, void *<a class="el" href="structdata.html">data</a>)</td></tr> +<tr class="memdesc:ae2ca7b19516a0245b0da1756a82ca753"><td class="mdescLeft"> </td><td class="mdescRight">Add an event listener. <a href="#ae2ca7b19516a0245b0da1756a82ca753">More...</a><br /></td></tr> +<tr class="separator:ae2ca7b19516a0245b0da1756a82ca753"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af0fc490ae11b6409e2bbc0838c8becdd"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structpw__loop.html">pw_loop</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="main-loop_8h.html#af0fc490ae11b6409e2bbc0838c8becdd">pw_main_loop_get_loop</a> (struct <a class="el" href="classpw__main__loop.html">pw_main_loop</a> *loop)</td></tr> +<tr class="memdesc:af0fc490ae11b6409e2bbc0838c8becdd"><td class="mdescLeft"> </td><td class="mdescRight">Get the loop implementation. <a href="#af0fc490ae11b6409e2bbc0838c8becdd">More...</a><br /></td></tr> +<tr class="separator:af0fc490ae11b6409e2bbc0838c8becdd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4248c0e1da7ea6a1f7a4df7cbdc2db72"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="main-loop_8h.html#a4248c0e1da7ea6a1f7a4df7cbdc2db72">pw_main_loop_destroy</a> (struct <a class="el" href="classpw__main__loop.html">pw_main_loop</a> *loop)</td></tr> +<tr class="memdesc:a4248c0e1da7ea6a1f7a4df7cbdc2db72"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a loop. <a href="#a4248c0e1da7ea6a1f7a4df7cbdc2db72">More...</a><br /></td></tr> +<tr class="separator:a4248c0e1da7ea6a1f7a4df7cbdc2db72"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4cc23752fe4d60ae07d98a481e03734b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="main-loop_8h.html#a4cc23752fe4d60ae07d98a481e03734b">pw_main_loop_run</a> (struct <a class="el" href="classpw__main__loop.html">pw_main_loop</a> *loop)</td></tr> +<tr class="memdesc:a4cc23752fe4d60ae07d98a481e03734b"><td class="mdescLeft"> </td><td class="mdescRight">Run a main loop. <a href="#a4cc23752fe4d60ae07d98a481e03734b">More...</a><br /></td></tr> +<tr class="separator:a4cc23752fe4d60ae07d98a481e03734b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a364190789f9f07251fe2c8ee45f5d1c1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="main-loop_8h.html#a364190789f9f07251fe2c8ee45f5d1c1">pw_main_loop_quit</a> (struct <a class="el" href="classpw__main__loop.html">pw_main_loop</a> *loop)</td></tr> +<tr class="memdesc:a364190789f9f07251fe2c8ee45f5d1c1"><td class="mdescLeft"> </td><td class="mdescRight">Quit a main loop. <a href="#a364190789f9f07251fe2c8ee45f5d1c1">More...</a><br /></td></tr> +<tr class="separator:a364190789f9f07251fe2c8ee45f5d1c1"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Macro Definition Documentation</h2> +<a id="a3310e380c0368cb007552027a040ff96"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a3310e380c0368cb007552027a040ff96">◆ </a></span>PW_VERSION_MAIN_LOOP_EVENTS</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define PW_VERSION_MAIN_LOOP_EVENTS   0</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Function Documentation</h2> +<a id="ae2ca7b19516a0245b0da1756a82ca753"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae2ca7b19516a0245b0da1756a82ca753">◆ </a></span>pw_main_loop_add_listener()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void pw_main_loop_add_listener </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__main__loop.html">pw_main_loop</a> * </td> + <td class="paramname"><em>loop</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__main__loop__events.html">pw_main_loop_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. </p> + +</div> +</div> +<a id="a4248c0e1da7ea6a1f7a4df7cbdc2db72"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4248c0e1da7ea6a1f7a4df7cbdc2db72">◆ </a></span>pw_main_loop_destroy()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void pw_main_loop_destroy </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__main__loop.html">pw_main_loop</a> * </td> + <td class="paramname"><em>loop</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Destroy a loop. </p> + +</div> +</div> +<a id="af0fc490ae11b6409e2bbc0838c8becdd"></a> +<h2 class="memtitle"><span class="permalink"><a href="#af0fc490ae11b6409e2bbc0838c8becdd">◆ </a></span>pw_main_loop_get_loop()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="structpw__loop.html">pw_loop</a>* pw_main_loop_get_loop </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__main__loop.html">pw_main_loop</a> * </td> + <td class="paramname"><em>loop</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the loop implementation. </p> + +<p class="reference">References <a class="el" href="structpw__loop.html#a4624741580712c167c17bd9242be003f">pw_loop::loop</a>.</p> + +</div> +</div> +<a id="ac020a4bf35819b8d4a83c6b7edd9a78f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac020a4bf35819b8d4a83c6b7edd9a78f">◆ </a></span>pw_main_loop_new()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="classpw__main__loop.html">pw_main_loop</a>* pw_main_loop_new </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><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Create a new main loop. </p> + +</div> +</div> +<a id="a364190789f9f07251fe2c8ee45f5d1c1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a364190789f9f07251fe2c8ee45f5d1c1">◆ </a></span>pw_main_loop_quit()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int pw_main_loop_quit </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__main__loop.html">pw_main_loop</a> * </td> + <td class="paramname"><em>loop</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Quit a main loop. </p> + +</div> +</div> +<a id="a4cc23752fe4d60ae07d98a481e03734b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4cc23752fe4d60ae07d98a481e03734b">◆ </a></span>pw_main_loop_run()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int pw_main_loop_run </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__main__loop.html">pw_main_loop</a> * </td> + <td class="paramname"><em>loop</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Run a main loop. </p> +<p>This blocks until <a class="el" href="classpw__main__loop.html#a4ba80d38ff00953836429a526535e7d2">pw_main_loop_quit</a> is called </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="main-loop_8h.html">main-loop.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> |