diff options
Diffstat (limited to 'build/doc/html/stream_8h.html')
| -rw-r--r-- | build/doc/html/stream_8h.html | 702 |
1 files changed, 702 insertions, 0 deletions
diff --git a/build/doc/html/stream_8h.html b/build/doc/html/stream_8h.html new file mode 100644 index 00000000..ce09fed6 --- /dev/null +++ b/build/doc/html/stream_8h.html @@ -0,0 +1,702 @@ +<!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: stream.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('stream_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="#enum-members">Enumerations</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">stream.h File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><div class="dynheader"> +Include dependency graph for stream.h:</div> +<div class="dyncontent"> +<div class="center"><img src="stream_8h__incl.png" border="0" usemap="#stream_8h" alt=""/></div> +<map name="stream_8h" id="stream_8h"> +<area shape="rect" title=" " alt="" coords="144,5,224,32"/> +<area shape="rect" title=" " alt="" coords="5,80,147,107"/> +<area shape="rect" title=" " alt="" coords="193,603,343,629"/> +<area shape="rect" href="remote_8h.html" title=" " alt="" coords="819,80,960,107"/> +<area shape="rect" title=" " alt="" coords="1340,603,1465,629"/> +<area shape="rect" href="core_8h.html" title=" " alt="" coords="827,304,949,331"/> +<area shape="rect" href="properties_8h.html" title=" " alt="" coords="499,603,659,629"/> +<area shape="rect" href="node_8h.html" title=" " alt="" coords="698,155,825,181"/> +<area shape="rect" href="proxy_8h.html" title=" " alt="" coords="1297,155,1426,181"/> +<area shape="rect" title=" " alt="" coords="1043,603,1165,629"/> +<area shape="rect" href="client_8h.html" title=" " alt="" coords="920,453,1051,480"/> +<area shape="rect" href="global_8h.html" title=" " alt="" coords="558,528,693,555"/> +<area shape="rect" href="introspect_8h.html" title=" " alt="" coords="273,528,431,555"/> +<area shape="rect" href="loop_8h.html" title=" " alt="" coords="587,379,709,405"/> +<area shape="rect" href="factory_8h.html" title=" " alt="" coords="819,379,957,405"/> +<area shape="rect" href="resource_8h.html" title=" " alt="" coords="1113,528,1263,555"/> +<area shape="rect" href="permission_8h.html" title=" " alt="" coords="819,528,986,555"/> +<area shape="rect" title=" " alt="" coords="520,677,637,704"/> +<area shape="rect" title=" " alt="" coords="577,453,719,480"/> +<area shape="rect" title=" " alt="" coords="846,229,981,256"/> +<area shape="rect" href="port_8h.html" title=" " alt="" coords="701,229,821,256"/> +<area shape="rect" href="protocol_8h.html" title=" " alt="" coords="1288,229,1435,256"/> +<area shape="rect" title=" " alt="" coords="1441,304,1554,331"/> +<area shape="rect" href="utils_8h.html" title=" " alt="" coords="1293,304,1416,331"/> +<area shape="rect" title=" " alt="" coords="1442,379,1555,405"/> +</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="stream_8h__dep__incl.png" border="0" usemap="#stream_8hdep" alt=""/></div> +<map name="stream_8hdep" id="stream_8hdep"> +<area shape="rect" title=" " alt="" coords="447,5,527,32"/> +<area shape="rect" href="pipewire_8h.html" title=" " alt="" coords="400,80,491,107"/> +<area shape="rect" href="stream_8c.html" title=" " alt="" coords="702,155,781,181"/> +<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"/> +</map> +</div> +</div> +<p><a href="stream_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__buffer.html">pw_buffer</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__stream__control.html">pw_stream_control</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__stream__events.html">pw_stream_events</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Events for a stream. <a href="structpw__stream__events.html#details">More...</a><br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structpw__time.html">pw_time</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A time structure. <a href="structpw__time.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:af21c1b002f78067d2eca97c455970822"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="stream_8h.html#af21c1b002f78067d2eca97c455970822">PW_VERSION_STREAM_EVENTS</a>   0</td></tr> +<tr class="separator:af21c1b002f78067d2eca97c455970822"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> +Enumerations</h2></td></tr> +<tr class="memitem:a9ceaca6fc9acd9a1af080258d763fb82"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="stream_8h.html#a9ceaca6fc9acd9a1af080258d763fb82">pw_stream_state</a> { <br /> +  <a class="el" href="stream_8h.html#a9ceaca6fc9acd9a1af080258d763fb82aae3c1d061da27957fd3a9389b29ff89e">PW_STREAM_STATE_ERROR</a> = -1, +<br /> +  <a class="el" href="stream_8h.html#a9ceaca6fc9acd9a1af080258d763fb82aae02f4af09cb65c931e95e1aa3bdd5f3">PW_STREAM_STATE_UNCONNECTED</a> = 0, +<br /> +  <a class="el" href="stream_8h.html#a9ceaca6fc9acd9a1af080258d763fb82a775f5777259aa54f7ad6d4c7cfa1779f">PW_STREAM_STATE_CONNECTING</a> = 1, +<br /> +  <a class="el" href="stream_8h.html#a9ceaca6fc9acd9a1af080258d763fb82a6d38d0ac9310b1822fcc98add8e4a8d2">PW_STREAM_STATE_CONFIGURE</a> = 2, +<br /> +  <a class="el" href="stream_8h.html#a9ceaca6fc9acd9a1af080258d763fb82acaf3c66b2d1446a3a5933498f52e5efc">PW_STREAM_STATE_READY</a> = 3, +<br /> +  <a class="el" href="stream_8h.html#a9ceaca6fc9acd9a1af080258d763fb82a0537b5f9f722fb2faf7822cd09370825">PW_STREAM_STATE_PAUSED</a> = 4, +<br /> +  <a class="el" href="stream_8h.html#a9ceaca6fc9acd9a1af080258d763fb82af3c3b39039810d40a7c9e1ae3c6c905d">PW_STREAM_STATE_STREAMING</a> = 5 +<br /> + }</td></tr> +<tr class="memdesc:a9ceaca6fc9acd9a1af080258d763fb82"><td class="mdescLeft"> </td><td class="mdescRight">The state of a stream. <a href="stream_8h.html#a9ceaca6fc9acd9a1af080258d763fb82">More...</a><br /></td></tr> +<tr class="separator:a9ceaca6fc9acd9a1af080258d763fb82"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a058907c2dffbb8fb5ede8a53d7604106"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="stream_8h.html#a058907c2dffbb8fb5ede8a53d7604106">pw_stream_flags</a> { <br /> +  <a class="el" href="stream_8h.html#a058907c2dffbb8fb5ede8a53d7604106aefcc7a31a05fa55c8cff7e686dd484ca">PW_STREAM_FLAG_NONE</a> = 0, +<br /> +  <a class="el" href="stream_8h.html#a058907c2dffbb8fb5ede8a53d7604106ab648fa0c0c7adf6aa3139eddc3a9cd7c">PW_STREAM_FLAG_AUTOCONNECT</a> = (1 << 0), +<br /> +  <a class="el" href="stream_8h.html#a058907c2dffbb8fb5ede8a53d7604106a2912e7520b8eb0aa5e4a5ca275f10d3b">PW_STREAM_FLAG_INACTIVE</a> = (1 << 1), +<br /> +  <a class="el" href="stream_8h.html#a058907c2dffbb8fb5ede8a53d7604106a615348212b647ad5d30313536ed6e125">PW_STREAM_FLAG_MAP_BUFFERS</a> = (1 << 2), +<br /> +  <a class="el" href="stream_8h.html#a058907c2dffbb8fb5ede8a53d7604106a73692ffb4a18142df04772cf3783410c">PW_STREAM_FLAG_DRIVER</a> = (1 << 3), +<br /> +  <a class="el" href="stream_8h.html#a058907c2dffbb8fb5ede8a53d7604106ad569b3a7085e21df1236651fd3388a22">PW_STREAM_FLAG_RT_PROCESS</a> = (1 << 4), +<br /> +  <a class="el" href="stream_8h.html#a058907c2dffbb8fb5ede8a53d7604106a87c6bfacd40d4f797505fbc22bd2b9da">PW_STREAM_FLAG_NO_CONVERT</a> = (1 << 5), +<br /> +  <a class="el" href="stream_8h.html#a058907c2dffbb8fb5ede8a53d7604106a79f1bdb249e79c7e71cf46759936768f">PW_STREAM_FLAG_EXCLUSIVE</a> = (1 << 6), +<br /> +  <a class="el" href="stream_8h.html#a058907c2dffbb8fb5ede8a53d7604106ab111b3fc3e1d3c1c439a65dc85a3ce20">PW_STREAM_FLAG_DONT_RECONNECT</a> = (1 << 7), +<br /> +  <a class="el" href="stream_8h.html#a058907c2dffbb8fb5ede8a53d7604106ab95a612ea82e3d928b5d2971bcd96465">PW_STREAM_FLAG_ALLOC_BUFFERS</a> = (1 << 8) +<br /> + }</td></tr> +<tr class="memdesc:a058907c2dffbb8fb5ede8a53d7604106"><td class="mdescLeft"> </td><td class="mdescRight">Extra flags that can be used in <a class="el" href="classpw__stream.html#a0e12176f13e654e64e7f5689e7a6dd54">pw_stream_connect()</a> <a href="stream_8h.html#a058907c2dffbb8fb5ede8a53d7604106">More...</a><br /></td></tr> +<tr class="separator:a058907c2dffbb8fb5ede8a53d7604106"><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:a7a8eafa174549733293f11ec2c646827"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="classpw__stream.html">pw_stream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="stream_8h.html#a7a8eafa174549733293f11ec2c646827">pw_stream_new_simple</a> (struct <a class="el" href="structpw__loop.html">pw_loop</a> *loop, const char *name, struct <a class="el" href="structpw__properties.html">pw_properties</a> *<a class="el" href="structprops.html">props</a>, const struct <a class="el" href="structpw__stream__events.html">pw_stream_events</a> *events, void *<a class="el" href="structdata.html">data</a>)</td></tr> +<tr class="separator:a7a8eafa174549733293f11ec2c646827"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:adfa74620109228a9cfce24b628aa130f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stream_8h.html#adfa74620109228a9cfce24b628aa130f">pw_stream_add_listener</a> (struct <a class="el" href="classpw__stream.html">pw_stream</a> *<a class="el" href="structstream.html">stream</a>, struct spa_hook *listener, const struct <a class="el" href="structpw__stream__events.html">pw_stream_events</a> *events, void *<a class="el" href="structdata.html">data</a>)</td></tr> +<tr class="separator:adfa74620109228a9cfce24b628aa130f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a087a686c66c04e54742cc94c7a5e4e68"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="stream_8h.html#a9ceaca6fc9acd9a1af080258d763fb82">pw_stream_state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="stream_8h.html#a087a686c66c04e54742cc94c7a5e4e68">pw_stream_get_state</a> (struct <a class="el" href="classpw__stream.html">pw_stream</a> *<a class="el" href="structstream.html">stream</a>, const char **error)</td></tr> +<tr class="separator:a087a686c66c04e54742cc94c7a5e4e68"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a751f41a0a5ce1ece31ec126b3cab4fd4"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="stream_8h.html#a751f41a0a5ce1ece31ec126b3cab4fd4">pw_stream_get_name</a> (struct <a class="el" href="classpw__stream.html">pw_stream</a> *<a class="el" href="structstream.html">stream</a>)</td></tr> +<tr class="separator:a751f41a0a5ce1ece31ec126b3cab4fd4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8ed38eb5f4180eec0fcb96b5c249b30a"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="classpw__remote.html">pw_remote</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="stream_8h.html#a8ed38eb5f4180eec0fcb96b5c249b30a">pw_stream_get_remote</a> (struct <a class="el" href="classpw__stream.html">pw_stream</a> *<a class="el" href="structstream.html">stream</a>)</td></tr> +<tr class="separator:a8ed38eb5f4180eec0fcb96b5c249b30a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afc74d20ae2305d82aba860fde41b9e31"><td class="memItemLeft" align="right" valign="top">const struct <a class="el" href="structpw__properties.html">pw_properties</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="stream_8h.html#afc74d20ae2305d82aba860fde41b9e31">pw_stream_get_properties</a> (struct <a class="el" href="classpw__stream.html">pw_stream</a> *<a class="el" href="structstream.html">stream</a>)</td></tr> +<tr class="separator:afc74d20ae2305d82aba860fde41b9e31"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a065b067d55def0d2c2cedf814a5c55d0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="stream_8h.html#a065b067d55def0d2c2cedf814a5c55d0">pw_stream_update_properties</a> (struct <a class="el" href="classpw__stream.html">pw_stream</a> *<a class="el" href="structstream.html">stream</a>, const struct spa_dict *dict)</td></tr> +<tr class="separator:a065b067d55def0d2c2cedf814a5c55d0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae10b900ec27572916b772ada125d0fed"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="stream_8h.html#ae10b900ec27572916b772ada125d0fed">pw_stream_set_control</a> (struct <a class="el" href="classpw__stream.html">pw_stream</a> *<a class="el" href="structstream.html">stream</a>, uint32_t id, float value,...)</td></tr> +<tr class="memdesc:ae10b900ec27572916b772ada125d0fed"><td class="mdescLeft"> </td><td class="mdescRight">Set control values. <a href="#ae10b900ec27572916b772ada125d0fed">More...</a><br /></td></tr> +<tr class="separator:ae10b900ec27572916b772ada125d0fed"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a52d3a718a1171132c69f2a4f2ca6efdc"><td class="memItemLeft" align="right" valign="top">const struct <a class="el" href="structpw__stream__control.html">pw_stream_control</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="stream_8h.html#a52d3a718a1171132c69f2a4f2ca6efdc">pw_stream_get_control</a> (struct <a class="el" href="classpw__stream.html">pw_stream</a> *<a class="el" href="structstream.html">stream</a>, uint32_t id)</td></tr> +<tr class="memdesc:a52d3a718a1171132c69f2a4f2ca6efdc"><td class="mdescLeft"> </td><td class="mdescRight">Get control information. <a href="#a52d3a718a1171132c69f2a4f2ca6efdc">More...</a><br /></td></tr> +<tr class="separator:a52d3a718a1171132c69f2a4f2ca6efdc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab2ef0e28a1e91816f8015ef9814d18f7"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structpw__buffer.html">pw_buffer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="stream_8h.html#ab2ef0e28a1e91816f8015ef9814d18f7">pw_stream_dequeue_buffer</a> (struct <a class="el" href="classpw__stream.html">pw_stream</a> *<a class="el" href="structstream.html">stream</a>)</td></tr> +<tr class="memdesc:ab2ef0e28a1e91816f8015ef9814d18f7"><td class="mdescLeft"> </td><td class="mdescRight">Get a buffer that can be filled for playback streams or consumed for capture streams. <a href="#ab2ef0e28a1e91816f8015ef9814d18f7">More...</a><br /></td></tr> +<tr class="separator:ab2ef0e28a1e91816f8015ef9814d18f7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abe1c593f34080ea9c8c6231abe4e7386"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="stream_8h.html#abe1c593f34080ea9c8c6231abe4e7386">pw_stream_queue_buffer</a> (struct <a class="el" href="classpw__stream.html">pw_stream</a> *<a class="el" href="structstream.html">stream</a>, struct <a class="el" href="structpw__buffer.html">pw_buffer</a> *<a class="el" href="structbuffer.html">buffer</a>)</td></tr> +<tr class="memdesc:abe1c593f34080ea9c8c6231abe4e7386"><td class="mdescLeft"> </td><td class="mdescRight">Submit a buffer for playback or recycle a buffer for capture. <a href="#abe1c593f34080ea9c8c6231abe4e7386">More...</a><br /></td></tr> +<tr class="separator:abe1c593f34080ea9c8c6231abe4e7386"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5ef987fd1903baa7eba9b10a8cbf5e97"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="stream_8h.html#a5ef987fd1903baa7eba9b10a8cbf5e97">pw_stream_flush</a> (struct <a class="el" href="classpw__stream.html">pw_stream</a> *<a class="el" href="structstream.html">stream</a>, bool drain)</td></tr> +<tr class="memdesc:a5ef987fd1903baa7eba9b10a8cbf5e97"><td class="mdescLeft"> </td><td class="mdescRight">Flush a stream. <a href="#a5ef987fd1903baa7eba9b10a8cbf5e97">More...</a><br /></td></tr> +<tr class="separator:a5ef987fd1903baa7eba9b10a8cbf5e97"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Macro Definition Documentation</h2> +<a id="af21c1b002f78067d2eca97c455970822"></a> +<h2 class="memtitle"><span class="permalink"><a href="#af21c1b002f78067d2eca97c455970822">◆ </a></span>PW_VERSION_STREAM_EVENTS</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define PW_VERSION_STREAM_EVENTS   0</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Enumeration Type Documentation</h2> +<a id="a058907c2dffbb8fb5ede8a53d7604106"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a058907c2dffbb8fb5ede8a53d7604106">◆ </a></span>pw_stream_flags</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="stream_8h.html#a058907c2dffbb8fb5ede8a53d7604106">pw_stream_flags</a></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Extra flags that can be used in <a class="el" href="classpw__stream.html#a0e12176f13e654e64e7f5689e7a6dd54">pw_stream_connect()</a> </p> +<table class="fieldtable"> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a058907c2dffbb8fb5ede8a53d7604106aefcc7a31a05fa55c8cff7e686dd484ca"></a>PW_STREAM_FLAG_NONE </td><td class="fielddoc"><p>no flags </p> +</td></tr> +<tr><td class="fieldname"><a id="a058907c2dffbb8fb5ede8a53d7604106ab648fa0c0c7adf6aa3139eddc3a9cd7c"></a>PW_STREAM_FLAG_AUTOCONNECT </td><td class="fielddoc"><p>try to automatically connect this stream </p> +</td></tr> +<tr><td class="fieldname"><a id="a058907c2dffbb8fb5ede8a53d7604106a2912e7520b8eb0aa5e4a5ca275f10d3b"></a>PW_STREAM_FLAG_INACTIVE </td><td class="fielddoc"><p>start the stream inactive, <a class="el" href="classpw__stream.html#aafa1055c167dd99ba94bb49ec30603ba" title="Activate or deactivate the stream.">pw_stream_set_active()</a> needs to be called explicitly </p> +</td></tr> +<tr><td class="fieldname"><a id="a058907c2dffbb8fb5ede8a53d7604106a615348212b647ad5d30313536ed6e125"></a>PW_STREAM_FLAG_MAP_BUFFERS </td><td class="fielddoc"><p>mmap the buffers </p> +</td></tr> +<tr><td class="fieldname"><a id="a058907c2dffbb8fb5ede8a53d7604106a73692ffb4a18142df04772cf3783410c"></a>PW_STREAM_FLAG_DRIVER </td><td class="fielddoc"><p>be a driver </p> +</td></tr> +<tr><td class="fieldname"><a id="a058907c2dffbb8fb5ede8a53d7604106ad569b3a7085e21df1236651fd3388a22"></a>PW_STREAM_FLAG_RT_PROCESS </td><td class="fielddoc"><p>call process from the realtime thread </p> +</td></tr> +<tr><td class="fieldname"><a id="a058907c2dffbb8fb5ede8a53d7604106a87c6bfacd40d4f797505fbc22bd2b9da"></a>PW_STREAM_FLAG_NO_CONVERT </td><td class="fielddoc"><p>don't convert format </p> +</td></tr> +<tr><td class="fieldname"><a id="a058907c2dffbb8fb5ede8a53d7604106a79f1bdb249e79c7e71cf46759936768f"></a>PW_STREAM_FLAG_EXCLUSIVE </td><td class="fielddoc"><p>require exclusive access to the device </p> +</td></tr> +<tr><td class="fieldname"><a id="a058907c2dffbb8fb5ede8a53d7604106ab111b3fc3e1d3c1c439a65dc85a3ce20"></a>PW_STREAM_FLAG_DONT_RECONNECT </td><td class="fielddoc"><p>don't try to reconnect this stream when the sink/source is removed </p> +</td></tr> +<tr><td class="fieldname"><a id="a058907c2dffbb8fb5ede8a53d7604106ab95a612ea82e3d928b5d2971bcd96465"></a>PW_STREAM_FLAG_ALLOC_BUFFERS </td><td class="fielddoc"><p>the application will allocate buffer memory. </p> +<p>In the add_buffer event, the data of the buffer should be set </p> +</td></tr> +</table> + +</div> +</div> +<a id="a9ceaca6fc9acd9a1af080258d763fb82"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a9ceaca6fc9acd9a1af080258d763fb82">◆ </a></span>pw_stream_state</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="stream_8h.html#a9ceaca6fc9acd9a1af080258d763fb82">pw_stream_state</a></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>The state of a stream. </p> +<table class="fieldtable"> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a9ceaca6fc9acd9a1af080258d763fb82aae3c1d061da27957fd3a9389b29ff89e"></a>PW_STREAM_STATE_ERROR </td><td class="fielddoc"><p>the strean is in error </p> +</td></tr> +<tr><td class="fieldname"><a id="a9ceaca6fc9acd9a1af080258d763fb82aae02f4af09cb65c931e95e1aa3bdd5f3"></a>PW_STREAM_STATE_UNCONNECTED </td><td class="fielddoc"><p>unconnected </p> +</td></tr> +<tr><td class="fieldname"><a id="a9ceaca6fc9acd9a1af080258d763fb82a775f5777259aa54f7ad6d4c7cfa1779f"></a>PW_STREAM_STATE_CONNECTING </td><td class="fielddoc"><p>connection is in progress </p> +</td></tr> +<tr><td class="fieldname"><a id="a9ceaca6fc9acd9a1af080258d763fb82a6d38d0ac9310b1822fcc98add8e4a8d2"></a>PW_STREAM_STATE_CONFIGURE </td><td class="fielddoc"><p>stream is being configured </p> +</td></tr> +<tr><td class="fieldname"><a id="a9ceaca6fc9acd9a1af080258d763fb82acaf3c66b2d1446a3a5933498f52e5efc"></a>PW_STREAM_STATE_READY </td><td class="fielddoc"><p>stream is ready </p> +</td></tr> +<tr><td class="fieldname"><a id="a9ceaca6fc9acd9a1af080258d763fb82a0537b5f9f722fb2faf7822cd09370825"></a>PW_STREAM_STATE_PAUSED </td><td class="fielddoc"><p>paused, fully configured but not processing data yet </p> +</td></tr> +<tr><td class="fieldname"><a id="a9ceaca6fc9acd9a1af080258d763fb82af3c3b39039810d40a7c9e1ae3c6c905d"></a>PW_STREAM_STATE_STREAMING </td><td class="fielddoc"><p>streaming </p> +</td></tr> +</table> + +</div> +</div> +<h2 class="groupheader">Function Documentation</h2> +<a id="adfa74620109228a9cfce24b628aa130f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#adfa74620109228a9cfce24b628aa130f">◆ </a></span>pw_stream_add_listener()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void pw_stream_add_listener </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__stream.html">pw_stream</a> * </td> + <td class="paramname"><em>stream</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__stream__events.html">pw_stream_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 class="reference">Referenced by <a class="el" href="stream_8c.html#a0aa398ef7b09697a0e48719b27112614">pw_stream_new_simple()</a>.</p> +<div class="dynheader"> +Here is the caller graph for this function:</div> +<div class="dyncontent"> +<div class="center"><img src="stream_8h_adfa74620109228a9cfce24b628aa130f_icgraph.png" border="0" usemap="#stream_8h_adfa74620109228a9cfce24b628aa130f_icgraph" alt=""/></div> +<map name="stream_8h_adfa74620109228a9cfce24b628aa130f_icgraph" id="stream_8h_adfa74620109228a9cfce24b628aa130f_icgraph"> +<area shape="rect" title=" " alt="" coords="232,5,413,32"/> +<area shape="rect" href="stream_8c.html#a0aa398ef7b09697a0e48719b27112614" title=" " alt="" coords="5,5,184,32"/> +</map> +</div> + +</div> +</div> +<a id="ab2ef0e28a1e91816f8015ef9814d18f7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab2ef0e28a1e91816f8015ef9814d18f7">◆ </a></span>pw_stream_dequeue_buffer()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="structpw__buffer.html">pw_buffer</a>* pw_stream_dequeue_buffer </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__stream.html">pw_stream</a> * </td> + <td class="paramname"><em>stream</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get a buffer that can be filled for playback streams or consumed for capture streams. </p> + +</div> +</div> +<a id="a5ef987fd1903baa7eba9b10a8cbf5e97"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a5ef987fd1903baa7eba9b10a8cbf5e97">◆ </a></span>pw_stream_flush()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int pw_stream_flush </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__stream.html">pw_stream</a> * </td> + <td class="paramname"><em>stream</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>drain</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Flush a stream. </p> +<p>When <em>drain</em> is true, the drained callback will be called when all data is played or recorded </p> + +<p class="reference">References <a class="el" href="loop_8h.html#afff39c7f964a4b011c4fc589c6a6ec92">pw_loop_invoke</a>.</p> + +</div> +</div> +<a id="a52d3a718a1171132c69f2a4f2ca6efdc"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a52d3a718a1171132c69f2a4f2ca6efdc">◆ </a></span>pw_stream_get_control()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const struct <a class="el" href="structpw__stream__control.html">pw_stream_control</a>* pw_stream_get_control </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__stream.html">pw_stream</a> * </td> + <td class="paramname"><em>stream</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get control information. </p> + +</div> +</div> +<a id="a751f41a0a5ce1ece31ec126b3cab4fd4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a751f41a0a5ce1ece31ec126b3cab4fd4">◆ </a></span>pw_stream_get_name()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char* pw_stream_get_name </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__stream.html">pw_stream</a> * </td> + <td class="paramname"><em>stream</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a id="afc74d20ae2305d82aba860fde41b9e31"></a> +<h2 class="memtitle"><span class="permalink"><a href="#afc74d20ae2305d82aba860fde41b9e31">◆ </a></span>pw_stream_get_properties()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const struct <a class="el" href="structpw__properties.html">pw_properties</a>* pw_stream_get_properties </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__stream.html">pw_stream</a> * </td> + <td class="paramname"><em>stream</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a8ed38eb5f4180eec0fcb96b5c249b30a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a8ed38eb5f4180eec0fcb96b5c249b30a">◆ </a></span>pw_stream_get_remote()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="classpw__remote.html">pw_remote</a>* pw_stream_get_remote </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__stream.html">pw_stream</a> * </td> + <td class="paramname"><em>stream</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a087a686c66c04e54742cc94c7a5e4e68"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a087a686c66c04e54742cc94c7a5e4e68">◆ </a></span>pw_stream_get_state()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="stream_8h.html#a9ceaca6fc9acd9a1af080258d763fb82">pw_stream_state</a> pw_stream_get_state </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__stream.html">pw_stream</a> * </td> + <td class="paramname"><em>stream</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char ** </td> + <td class="paramname"><em>error</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a7a8eafa174549733293f11ec2c646827"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7a8eafa174549733293f11ec2c646827">◆ </a></span>pw_stream_new_simple()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="classpw__stream.html">pw_stream</a>* pw_stream_new_simple </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> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">struct <a class="el" href="structpw__properties.html">pw_properties</a> * </td> + <td class="paramname"><em>props</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const struct <a class="el" href="structpw__stream__events.html">pw_stream_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"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">loop</td><td>a <a class="el" href="structpw__loop.html">pw_loop</a> to use </td></tr> + <tr><td class="paramname">name</td><td>a stream name </td></tr> + <tr><td class="paramname">props</td><td>stream properties, ownership is taken </td></tr> + <tr><td class="paramname">events</td><td>stream events </td></tr> + <tr><td class="paramname">data</td><td>data passed to events </td></tr> + </table> + </dd> +</dl> + +<p class="reference">References <a class="el" href="classpw__core.html#a3fe8a902e97223d11c0e8e4640c16379">pw_core::pw_core_destroy()</a>, <a class="el" href="classpw__core.html#a149d054319a8cd3fb6206b233d2476cd">pw_core::pw_core_new()</a>, <a class="el" href="classpw__remote.html#ad5f598eb7abbac2d8538992f3f6c07f7">pw_remote::pw_remote_new()</a>, <a class="el" href="stream_8c.html#afeafcb95f3bc48b81410bf7848473a8f">pw_stream_add_listener()</a>, and <a class="el" href="classpw__stream.html#a6f1606e27cc3bd9c522b92c9469a6f2f">pw_stream::pw_stream_new()</a>.</p> + +</div> +</div> +<a id="abe1c593f34080ea9c8c6231abe4e7386"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abe1c593f34080ea9c8c6231abe4e7386">◆ </a></span>pw_stream_queue_buffer()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int pw_stream_queue_buffer </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__stream.html">pw_stream</a> * </td> + <td class="paramname"><em>stream</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">struct <a class="el" href="structpw__buffer.html">pw_buffer</a> * </td> + <td class="paramname"><em>buffer</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Submit a buffer for playback or recycle a buffer for capture. </p> + +<p class="reference">References <a class="el" href="structbuffer.html#aa44533c5c02fdb7e3a6a871e15cbc6ff">buffer::id</a>, <a class="el" href="stream_8c.html#a47f2e62c0dbebc787052c165afcada0e">NAME</a>, and <a class="el" href="classpw__log.html#a0a957072ba799bbf2bdc77501ccd81d0">pw_log::pw_log_trace</a>.</p> + +</div> +</div> +<a id="ae10b900ec27572916b772ada125d0fed"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae10b900ec27572916b772ada125d0fed">◆ </a></span>pw_stream_set_control()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int pw_stream_set_control </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__stream.html">pw_stream</a> * </td> + <td class="paramname"><em>stream</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"><em>value</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>...</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Set control values. </p> + +<p class="reference">References <a class="el" href="stream_8c.html#a47f2e62c0dbebc787052c165afcada0e">NAME</a>, and <a class="el" href="classpw__log.html#a98a49c37f11de525890014e927e34d02">pw_log::pw_log_debug</a>.</p> + +</div> +</div> +<a id="a065b067d55def0d2c2cedf814a5c55d0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a065b067d55def0d2c2cedf814a5c55d0">◆ </a></span>pw_stream_update_properties()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int pw_stream_update_properties </td> + <td>(</td> + <td class="paramtype">struct <a class="el" href="classpw__stream.html">pw_stream</a> * </td> + <td class="paramname"><em>stream</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const struct spa_dict * </td> + <td class="paramname"><em>dict</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="reference">References <a class="el" href="node_8h.html#a01db9fe936ffca5e133a4f7acb699ca1">pw_node_update_properties()</a>, and <a class="el" href="structpw__properties.html#a15a72cca30ebffc472fb46cfa8b22c43">pw_properties::pw_properties_update()</a>.</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="stream_8h.html">stream.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> |