diff options
Diffstat (limited to 'build/doc/html/index.html')
| -rw-r--r-- | build/doc/html/index.html | 113 |
1 files changed, 113 insertions, 0 deletions
diff --git a/build/doc/html/index.html b/build/doc/html/index.html new file mode 100644 index 00000000..65b9f2aa --- /dev/null +++ b/build/doc/html/index.html @@ -0,0 +1,113 @@ +<!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 Page</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('index.html','');}); +/* @license-end */ +</script> +<div id="doc-content"> +<div class="PageDoc"><div class="header"> + <div class="headertitle"> +<div class="title">PipeWire Documentation</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><h1><a class="anchor" id="sec_intro"></a> +Introduction</h1> +<p>This document describes the API for the PipeWire multimedia framework. The API consists of two parts:</p> +<ul> +<li>The core API and tools to build new modules (See <a class="el" href="page_core_api.html">Core API</a>) </li> +<li>The remote API (See <a class="el" href="page_remote_api.html">Remote API</a>)</li> +</ul> +<h1><a class="anchor" id="sec_errors"></a> +Error reporting</h1> +<p>Functions return either NULL or a negative int error code when an error occurs. Error codes are used from the SPA plugin library on which PipeWire is built.</p> +<p>Some functions might return asynchronously. The error code for such functions is positive and SPA_RESULT_IS_ASYNC() will return true. SPA_RESULT_ASYNC_SEQ() can be used to get the unique sequence number associated with the async operation.</p> +<p>The object returning the async result code will have some way to signal the completion of the async operation (with, for example, a callback). The sequence number can be used to see which operation completed.</p> +<h1><a class="anchor" id="sec_logging"></a> +Logging</h1> +<p>The 'PIPEWIRE_DEBUG' environment variable can be used to enable more debugging. The format is:</p> +<p><level>[:<category>,...]</p> +<ul> +<li><level>: specifies the log level:<ul> +<li><code>0</code>: no logging is enabled</li> +<li><code>1</code>: Error logging is enabled</li> +<li><code>2</code>: Warnings are enabled</li> +<li><code>3</code>: Informational messages are enabled</li> +<li><code>4</code>: Debug messages are enabled</li> +<li><code>5</code>: Trace messages are enabled. These messages can be logged from the realtime threads.</li> +</ul> +</li> +<li><category>: Specifies a string category to enable. Many categories can be separated by commas. Current categories are:<ul> +<li><code>connection</code>: to log connection messages </li> +</ul> +</li> +</ul> +</div></div><!-- PageDoc --> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <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> |