diff options
Diffstat (limited to 'build/doc/html/classpw__main__loop.html')
| -rw-r--r-- | build/doc/html/classpw__main__loop.html | 220 |
1 files changed, 220 insertions, 0 deletions
diff --git a/build/doc/html/classpw__main__loop.html b/build/doc/html/classpw__main__loop.html new file mode 100644 index 00000000..fbcc94d1 --- /dev/null +++ b/build/doc/html/classpw__main__loop.html @@ -0,0 +1,220 @@ +<!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_main_loop 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__main__loop.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_main_loop Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>PipeWire main-loop interface. + <a href="classpw__main__loop.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:ac905677385238893cf73a362c960f957"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT struct <a class="el" href="classpw__main__loop.html">pw_main_loop</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__main__loop.html#ac905677385238893cf73a362c960f957">pw_main_loop_new</a> (struct <a class="el" href="structpw__properties.html">pw_properties</a> *properties)</td></tr> +<tr class="memdesc:ac905677385238893cf73a362c960f957"><td class="mdescLeft"> </td><td class="mdescRight">Create a new new main loop. <a href="#ac905677385238893cf73a362c960f957">More...</a><br /></td></tr> +<tr class="separator:ac905677385238893cf73a362c960f957"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:adae8ebcf8d461723a8cf53be56c802db"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__main__loop.html#adae8ebcf8d461723a8cf53be56c802db">pw_main_loop_destroy</a> (struct <a class="el" href="classpw__main__loop.html">pw_main_loop</a> *loop)</td></tr> +<tr class="memdesc:adae8ebcf8d461723a8cf53be56c802db"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a main loop. <a href="#adae8ebcf8d461723a8cf53be56c802db">More...</a><br /></td></tr> +<tr class="separator:adae8ebcf8d461723a8cf53be56c802db"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4ba80d38ff00953836429a526535e7d2"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__main__loop.html#a4ba80d38ff00953836429a526535e7d2">pw_main_loop_quit</a> (struct <a class="el" href="classpw__main__loop.html">pw_main_loop</a> *loop)</td></tr> +<tr class="memdesc:a4ba80d38ff00953836429a526535e7d2"><td class="mdescLeft"> </td><td class="mdescRight">Stop a main loop. <a href="#a4ba80d38ff00953836429a526535e7d2">More...</a><br /></td></tr> +<tr class="separator:a4ba80d38ff00953836429a526535e7d2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a30019fb9d75c02846ec56246f78f5356"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="classpw__main__loop.html#a30019fb9d75c02846ec56246f78f5356">pw_main_loop_run</a> (struct <a class="el" href="classpw__main__loop.html">pw_main_loop</a> *loop)</td></tr> +<tr class="memdesc:a30019fb9d75c02846ec56246f78f5356"><td class="mdescLeft"> </td><td class="mdescRight">Start a main loop. <a href="#a30019fb9d75c02846ec56246f78f5356">More...</a><br /></td></tr> +<tr class="separator:a30019fb9d75c02846ec56246f78f5356"><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 main-loop interface. </p> +<p>A main loop object </p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="adae8ebcf8d461723a8cf53be56c802db"></a> +<h2 class="memtitle"><span class="permalink"><a href="#adae8ebcf8d461723a8cf53be56c802db">◆ </a></span>pw_main_loop_destroy()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT 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 main loop. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loop</td><td>the main loop to destroy </td></tr> + </table> + </dd> +</dl> + +<p class="reference">References <a class="el" href="classpw__log.html#a98a49c37f11de525890014e927e34d02">pw_log::pw_log_debug</a>, and <a class="el" href="structpw__loop.html#ae7e5a8b4500832184aa06705d3569933">pw_loop::pw_loop_destroy()</a>.</p> + +</div> +</div> +<a id="ac905677385238893cf73a362c960f957"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac905677385238893cf73a362c960f957">◆ </a></span>pw_main_loop_new()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT 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 new main loop. </p> +<dl class="section return"><dt>Returns</dt><dd>a newly allocated <a class="el" href="classpw__main__loop.html">pw_main_loop</a> </dd></dl> + +<p class="reference">References <a class="el" href="classpw__log.html#a98a49c37f11de525890014e927e34d02">pw_log::pw_log_debug</a>, <a class="el" href="loop_8h.html#ac62ac71350289ac2b1a312761b2bb82c">pw_loop_add_event</a>, and <a class="el" href="structpw__loop.html#a67a638da8a3914b6fa0aa6d9eda6b6e0">pw_loop::pw_loop_new()</a>.</p> + +</div> +</div> +<a id="a4ba80d38ff00953836429a526535e7d2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4ba80d38ff00953836429a526535e7d2">◆ </a></span>pw_main_loop_quit()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT 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>Stop a main loop. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loop</td><td>a <a class="el" href="classpw__main__loop.html">pw_main_loop</a> to stop</td></tr> + </table> + </dd> +</dl> +<p>The call to <a class="el" href="classpw__main__loop.html#a30019fb9d75c02846ec56246f78f5356">pw_main_loop_run()</a> will return </p> + +<p class="reference">References <a class="el" href="structpw__loop.html#a4624741580712c167c17bd9242be003f">pw_loop::loop</a>, <a class="el" href="classpw__log.html#a98a49c37f11de525890014e927e34d02">pw_log::pw_log_debug</a>, and <a class="el" href="loop_8h.html#aa26ce5ccf840db64b7e1de4b3f57de6e">pw_loop_signal_event</a>.</p> + +</div> +</div> +<a id="a30019fb9d75c02846ec56246f78f5356"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a30019fb9d75c02846ec56246f78f5356">◆ </a></span>pw_main_loop_run()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT 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>Start a main loop. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loop</td><td>the main loop to start</td></tr> + </table> + </dd> +</dl> +<p>Start running <em>loop</em>. This function blocks until <a class="el" href="classpw__main__loop.html#a4ba80d38ff00953836429a526535e7d2">pw_main_loop_quit()</a> has been called </p> + +<p class="reference">References <a class="el" href="structpw__loop.html#a4624741580712c167c17bd9242be003f">pw_loop::loop</a>, <a class="el" href="classpw__log.html#a98a49c37f11de525890014e927e34d02">pw_log::pw_log_debug</a>, <a class="el" href="classpw__log.html#a2d2c2dc7d35b7104f5caef08df416767">pw_log::pw_log_warn</a>, <a class="el" href="loop_8h.html#a12545a7e053006bf3865618edb6cf275">pw_loop_enter</a>, <a class="el" href="loop_8h.html#a509d8e5f87cb79816ac99afd2765b0e6">pw_loop_iterate</a>, and <a class="el" href="loop_8h.html#a8f6b6e07508edcd3413a05deb93b1bc0">pw_loop_leave</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="main-loop_8h_source.html">main-loop.h</a></li> +<li><a class="el" href="main-loop_8c.html">main-loop.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__main__loop.html">pw_main_loop</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> |