diff options
Diffstat (limited to 'build/doc/html/structpw__client__events.html')
| -rw-r--r-- | build/doc/html/structpw__client__events.html | 228 |
1 files changed, 228 insertions, 0 deletions
diff --git a/build/doc/html/structpw__client__events.html b/build/doc/html/structpw__client__events.html new file mode 100644 index 00000000..e93b38f7 --- /dev/null +++ b/build/doc/html/structpw__client__events.html @@ -0,0 +1,228 @@ +<!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_client_events Struct 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__client__events.html','');}); +/* @license-end */ +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#pub-attribs">Data Fields</a> </div> + <div class="headertitle"> +<div class="title">pw_client_events Struct Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>The events that a client can emit. + <a href="structpw__client__events.html#details">More...</a></p> +<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:a0ceb2ae8884ca4a30bae720198410075"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__client__events.html#a0ceb2ae8884ca4a30bae720198410075">version</a></td></tr> +<tr class="separator:a0ceb2ae8884ca4a30bae720198410075"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6068da05dba35d7e60dffa29c38cfb44"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__client__events.html#a6068da05dba35d7e60dffa29c38cfb44">destroy</a> )(void *<a class="el" href="structdata.html">data</a>)</td></tr> +<tr class="memdesc:a6068da05dba35d7e60dffa29c38cfb44"><td class="mdescLeft"> </td><td class="mdescRight">emited when the client is destroyed <a href="#a6068da05dba35d7e60dffa29c38cfb44">More...</a><br /></td></tr> +<tr class="separator:a6068da05dba35d7e60dffa29c38cfb44"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a91d1547c2d7ba1ecd28160a559768bd4"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__client__events.html#a91d1547c2d7ba1ecd28160a559768bd4">free</a> )(void *<a class="el" href="structdata.html">data</a>)</td></tr> +<tr class="memdesc:a91d1547c2d7ba1ecd28160a559768bd4"><td class="mdescLeft"> </td><td class="mdescRight">emited right before the client is freed <a href="#a91d1547c2d7ba1ecd28160a559768bd4">More...</a><br /></td></tr> +<tr class="separator:a91d1547c2d7ba1ecd28160a559768bd4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6aa842676906f55c58c6f7481fa80a94"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__client__events.html#a6aa842676906f55c58c6f7481fa80a94">info_changed</a> )(void *<a class="el" href="structdata.html">data</a>, const struct <a class="el" href="structpw__client__info.html">pw_client_info</a> *info)</td></tr> +<tr class="memdesc:a6aa842676906f55c58c6f7481fa80a94"><td class="mdescLeft"> </td><td class="mdescRight">emited when the client info changed <a href="#a6aa842676906f55c58c6f7481fa80a94">More...</a><br /></td></tr> +<tr class="separator:a6aa842676906f55c58c6f7481fa80a94"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a064bb63607c0242437f6feb9bf819106"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__client__events.html#a064bb63607c0242437f6feb9bf819106">resource_added</a> )(void *<a class="el" href="structdata.html">data</a>, struct <a class="el" href="classpw__resource.html">pw_resource</a> *resource)</td></tr> +<tr class="memdesc:a064bb63607c0242437f6feb9bf819106"><td class="mdescLeft"> </td><td class="mdescRight">emited when a new resource is added for client <a href="#a064bb63607c0242437f6feb9bf819106">More...</a><br /></td></tr> +<tr class="separator:a064bb63607c0242437f6feb9bf819106"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0b332f68b57b4554abb19b8ccb3674cf"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__client__events.html#a0b332f68b57b4554abb19b8ccb3674cf">resource_removed</a> )(void *<a class="el" href="structdata.html">data</a>, struct <a class="el" href="classpw__resource.html">pw_resource</a> *resource)</td></tr> +<tr class="memdesc:a0b332f68b57b4554abb19b8ccb3674cf"><td class="mdescLeft"> </td><td class="mdescRight">emited when a resource is removed <a href="#a0b332f68b57b4554abb19b8ccb3674cf">More...</a><br /></td></tr> +<tr class="separator:a0b332f68b57b4554abb19b8ccb3674cf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af7d6081c5a54303d4ff74b6176cbccee"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__client__events.html#af7d6081c5a54303d4ff74b6176cbccee">busy_changed</a> )(void *<a class="el" href="structdata.html">data</a>, bool busy)</td></tr> +<tr class="memdesc:af7d6081c5a54303d4ff74b6176cbccee"><td class="mdescLeft"> </td><td class="mdescRight">emited when the client becomes busy processing an asynchronous message. <a href="#af7d6081c5a54303d4ff74b6176cbccee">More...</a><br /></td></tr> +<tr class="separator:af7d6081c5a54303d4ff74b6176cbccee"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>The events that a client can emit. </p> +</div><h2 class="groupheader">Field Documentation</h2> +<a id="af7d6081c5a54303d4ff74b6176cbccee"></a> +<h2 class="memtitle"><span class="permalink"><a href="#af7d6081c5a54303d4ff74b6176cbccee">◆ </a></span>busy_changed</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void(* pw_client_events::busy_changed) (void *<a class="el" href="structdata.html">data</a>, bool busy)</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>emited when the client becomes busy processing an asynchronous message. </p> +<p>In the busy state no messages should be processed. Processing should resume when the client becomes not busy </p> + +</div> +</div> +<a id="a6068da05dba35d7e60dffa29c38cfb44"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6068da05dba35d7e60dffa29c38cfb44">◆ </a></span>destroy</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void(* pw_client_events::destroy) (void *<a class="el" href="structdata.html">data</a>)</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>emited when the client is destroyed </p> + +</div> +</div> +<a id="a91d1547c2d7ba1ecd28160a559768bd4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a91d1547c2d7ba1ecd28160a559768bd4">◆ </a></span>free</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void(* pw_client_events::free) (void *<a class="el" href="structdata.html">data</a>)</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>emited right before the client is freed </p> + +</div> +</div> +<a id="a6aa842676906f55c58c6f7481fa80a94"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6aa842676906f55c58c6f7481fa80a94">◆ </a></span>info_changed</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void(* pw_client_events::info_changed) (void *<a class="el" href="structdata.html">data</a>, const struct <a class="el" href="structpw__client__info.html">pw_client_info</a> *info)</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>emited when the client info changed </p> + +</div> +</div> +<a id="a064bb63607c0242437f6feb9bf819106"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a064bb63607c0242437f6feb9bf819106">◆ </a></span>resource_added</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void(* pw_client_events::resource_added) (void *<a class="el" href="structdata.html">data</a>, struct <a class="el" href="classpw__resource.html">pw_resource</a> *resource)</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>emited when a new resource is added for client </p> + +</div> +</div> +<a id="a0b332f68b57b4554abb19b8ccb3674cf"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a0b332f68b57b4554abb19b8ccb3674cf">◆ </a></span>resource_removed</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void(* pw_client_events::resource_removed) (void *<a class="el" href="structdata.html">data</a>, struct <a class="el" href="classpw__resource.html">pw_resource</a> *resource)</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>emited when a resource is removed </p> + +</div> +</div> +<a id="a0ceb2ae8884ca4a30bae720198410075"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a0ceb2ae8884ca4a30bae720198410075">◆ </a></span>version</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">uint32_t pw_client_events::version</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<hr/>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="client_8h_source.html">client.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="structpw__client__events.html">pw_client_events</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> |