diff options
Diffstat (limited to 'structpw__loop.html')
| -rw-r--r-- | structpw__loop.html | 247 |
1 files changed, 247 insertions, 0 deletions
diff --git a/structpw__loop.html b/structpw__loop.html new file mode 100644 index 00000000..064d0f39 --- /dev/null +++ b/structpw__loop.html @@ -0,0 +1,247 @@ +<!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_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('structpw__loop.html','');}); +/* @license-end */ +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pub-attribs">Data Fields</a> </div> + <div class="headertitle"> +<div class="title">pw_loop Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>PipeWire loop object provides an implementation of the spa loop interfaces. + <a href="structpw__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:a67a638da8a3914b6fa0aa6d9eda6b6e0"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT struct <a class="el" href="structpw__loop.html">pw_loop</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__loop.html#a67a638da8a3914b6fa0aa6d9eda6b6e0">pw_loop_new</a> (struct <a class="el" href="structpw__properties.html">pw_properties</a> *properties)</td></tr> +<tr class="memdesc:a67a638da8a3914b6fa0aa6d9eda6b6e0"><td class="mdescLeft"> </td><td class="mdescRight">Create a new loop. <a href="#a67a638da8a3914b6fa0aa6d9eda6b6e0">More...</a><br /></td></tr> +<tr class="separator:a67a638da8a3914b6fa0aa6d9eda6b6e0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae7e5a8b4500832184aa06705d3569933"><td class="memItemLeft" align="right" valign="top">SPA_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__loop.html#ae7e5a8b4500832184aa06705d3569933">pw_loop_destroy</a> (struct <a class="el" href="structpw__loop.html">pw_loop</a> *<a class="el" href="structpw__loop.html#a4624741580712c167c17bd9242be003f">loop</a>)</td></tr> +<tr class="memdesc:ae7e5a8b4500832184aa06705d3569933"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a loop. <a href="#ae7e5a8b4500832184aa06705d3569933">More...</a><br /></td></tr> +<tr class="separator:ae7e5a8b4500832184aa06705d3569933"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> +Data Fields</h2></td></tr> +<tr class="memitem:abab71679705176a16c9e27b3115701c3"><td class="memItemLeft" align="right" valign="top">struct spa_system * </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__loop.html#abab71679705176a16c9e27b3115701c3">system</a></td></tr> +<tr class="memdesc:abab71679705176a16c9e27b3115701c3"><td class="mdescLeft"> </td><td class="mdescRight">system utils <a href="#abab71679705176a16c9e27b3115701c3">More...</a><br /></td></tr> +<tr class="separator:abab71679705176a16c9e27b3115701c3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4624741580712c167c17bd9242be003f"><td class="memItemLeft" align="right" valign="top">struct spa_loop * </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__loop.html#a4624741580712c167c17bd9242be003f">loop</a></td></tr> +<tr class="memdesc:a4624741580712c167c17bd9242be003f"><td class="mdescLeft"> </td><td class="mdescRight">wrapped loop <a href="#a4624741580712c167c17bd9242be003f">More...</a><br /></td></tr> +<tr class="separator:a4624741580712c167c17bd9242be003f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a639de0bfd74cf9e292932aaed15182c5"><td class="memItemLeft" align="right" valign="top">struct spa_loop_control * </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__loop.html#a639de0bfd74cf9e292932aaed15182c5">control</a></td></tr> +<tr class="memdesc:a639de0bfd74cf9e292932aaed15182c5"><td class="mdescLeft"> </td><td class="mdescRight">loop control <a href="#a639de0bfd74cf9e292932aaed15182c5">More...</a><br /></td></tr> +<tr class="separator:a639de0bfd74cf9e292932aaed15182c5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad34e8c247c5a3e9760b1c0fb33a7cc2f"><td class="memItemLeft" align="right" valign="top">struct spa_loop_utils * </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__loop.html#ad34e8c247c5a3e9760b1c0fb33a7cc2f">utils</a></td></tr> +<tr class="memdesc:ad34e8c247c5a3e9760b1c0fb33a7cc2f"><td class="mdescLeft"> </td><td class="mdescRight">loop utils <a href="#ad34e8c247c5a3e9760b1c0fb33a7cc2f">More...</a><br /></td></tr> +<tr class="separator:ad34e8c247c5a3e9760b1c0fb33a7cc2f"><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 loop object provides an implementation of the spa loop interfaces. </p> +<p>It can be used to implement various event loops. </p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="ae7e5a8b4500832184aa06705d3569933"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae7e5a8b4500832184aa06705d3569933">◆ </a></span>pw_loop_destroy()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT void pw_loop_destroy </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="structpw__loop.html">pw_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> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loop</td><td>a loop to destroy </td></tr> + </table> + </dd> +</dl> + +<p class="reference">References <a class="el" href="structpw__properties.html#a6473c3fdc688733f1db2e8d645ba94f4">pw_properties::pw_properties_free()</a>, and <a class="el" href="pipewire_8h.html#af3d7686492ea5032eb135cddf21d3da2">pw_unload_spa_handle()</a>.</p> + +<p class="reference">Referenced by <a class="el" href="classpw__data__loop.html#a9e8300a978c0a9ecefb54dc6b23f333c">pw_data_loop::pw_data_loop_destroy()</a>, and <a class="el" href="classpw__main__loop.html#adae8ebcf8d461723a8cf53be56c802db">pw_main_loop::pw_main_loop_destroy()</a>.</p> + +</div> +</div> +<a id="a67a638da8a3914b6fa0aa6d9eda6b6e0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a67a638da8a3914b6fa0aa6d9eda6b6e0">◆ </a></span>pw_loop_new()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SPA_EXPORT struct <a class="el" href="structpw__loop.html">pw_loop</a> * pw_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 loop. </p> +<dl class="section return"><dt>Returns</dt><dd>a newly allocated loop </dd></dl> + +<p class="reference">References <a class="el" href="structpw__properties.html#a70aa5816bde60f5511f2308971794881">pw_properties::dict</a>, <a class="el" href="pipewire_8h.html#a0a42d8f153fc58df733f74e5bf9af251">pw_get_support()</a>, <a class="el" href="keys_8h.html#a62381a633016e0f980878eaa018ef429">PW_KEY_LIBRARY_NAME_LOOP</a>, <a class="el" href="keys_8h.html#ada76163a82aae28e7563c6c28eddc5ea">PW_KEY_LIBRARY_NAME_SYSTEM</a>, <a class="el" href="pipewire_8h.html#accacb9b931e5e7d72c02987939f4edfd">pw_load_spa_handle()</a>, <a class="el" href="classpw__log.html#a995a5e0ef414e9246fbf2ad56b0ce281">pw_log::pw_log_error</a>, <a class="el" href="structpw__properties.html#a6473c3fdc688733f1db2e8d645ba94f4">pw_properties::pw_properties_free()</a>, <a class="el" href="structpw__properties.html#aef040055887634f636bb26594091c31c">pw_properties::pw_properties_get()</a>, <a class="el" href="pipewire_8h.html#af3d7686492ea5032eb135cddf21d3da2">pw_unload_spa_handle()</a>, and <a class="el" href="structimpl.html#a6eaec9ea671abe6434946657ac2f1bae">impl::this</a>.</p> + +<p class="reference">Referenced by <a class="el" href="classpw__data__loop.html#aa81641e625a0d12db3ac1e9fa037809c">pw_data_loop::pw_data_loop_new()</a>, and <a class="el" href="classpw__main__loop.html#ac905677385238893cf73a362c960f957">pw_main_loop::pw_main_loop_new()</a>.</p> + +</div> +</div> +<h2 class="groupheader">Field Documentation</h2> +<a id="a639de0bfd74cf9e292932aaed15182c5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a639de0bfd74cf9e292932aaed15182c5">◆ </a></span>control</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct spa_loop_control* pw_loop::control</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>loop control </p> + +</div> +</div> +<a id="a4624741580712c167c17bd9242be003f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4624741580712c167c17bd9242be003f">◆ </a></span>loop</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct spa_loop* pw_loop::loop</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>wrapped loop </p> + +<p class="reference">Referenced by <a class="el" href="classpw__core.html#a149d054319a8cd3fb6206b233d2476cd">pw_core::pw_core_new()</a>, <a class="el" href="data-loop_8c.html#a6761f26b6c77a8f5ada552077f3fbd2c">pw_data_loop_get_loop()</a>, <a class="el" href="classpw__data__loop.html#abfa6227e4d5ff8870e856769871ae0f7">pw_data_loop::pw_data_loop_in_thread()</a>, <a class="el" href="classpw__data__loop.html#a1ca9b85ed7dde1f8f011f2d47dd87dab">pw_data_loop::pw_data_loop_start()</a>, <a class="el" href="classpw__data__loop.html#a305854e5e85ba6d923be6448871de951">pw_data_loop::pw_data_loop_stop()</a>, <a class="el" href="main-loop_8c.html#a3f816398436d773de7e5b8690ea595a0">pw_main_loop_get_loop()</a>, <a class="el" href="classpw__main__loop.html#a4ba80d38ff00953836429a526535e7d2">pw_main_loop::pw_main_loop_quit()</a>, <a class="el" href="classpw__main__loop.html#a30019fb9d75c02846ec56246f78f5356">pw_main_loop::pw_main_loop_run()</a>, and <a class="el" href="thread-loop_8c.html#adaa5c36cb85b928d79c014b6f9117c5e">pw_thread_loop_get_loop()</a>.</p> + +</div> +</div> +<a id="abab71679705176a16c9e27b3115701c3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abab71679705176a16c9e27b3115701c3">◆ </a></span>system</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct spa_system* pw_loop::system</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>system utils </p> + +<p class="reference">Referenced by <a class="el" href="classpw__core.html#a149d054319a8cd3fb6206b233d2476cd">pw_core::pw_core_new()</a>.</p> + +</div> +</div> +<a id="ad34e8c247c5a3e9760b1c0fb33a7cc2f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad34e8c247c5a3e9760b1c0fb33a7cc2f">◆ </a></span>utils</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct spa_loop_utils* pw_loop::utils</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>loop utils </p> + +<p class="reference">Referenced by <a class="el" href="classpw__core.html#a149d054319a8cd3fb6206b233d2476cd">pw_core::pw_core_new()</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="loop_8h_source.html">loop.h</a></li> +<li><a class="el" href="loop_8c.html">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="structpw__loop.html">pw_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> |