<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PulseAudio: simple.h Source File</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">
$(document).ready(initResizable);
</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">PulseAudio
 <span id="projectnumber">10.0.0-1.1.mga6</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</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">
$(document).ready(function(){initNavTree('simple_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">simple.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="simple_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef foosimplehfoo</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define foosimplehfoo</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/***</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> This file is part of PulseAudio.</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> Copyright 2004-2006 Lennart Poettering</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> PulseAudio is free software; you can redistribute it and/or modify</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> it under the terms of the GNU Lesser General Public License as published</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> by the Free Software Foundation; either version 2.1 of the License,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> or (at your option) any later version.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> PulseAudio is distributed in the hope that it will be useful, but</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> General Public License for more details.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> You should have received a copy of the GNU Lesser General Public License</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">***/</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <sys/types.h></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="sample_8h.html">pulse/sample.h</a>></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="code" href="channelmap_8h.html">pulse/channelmap.h</a>></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <<a class="code" href="def_8h.html">pulse/def.h</a>></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <pulse/cdecl.h></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <<a class="code" href="version_8h.html">pulse/version.h</a>></span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> PA_C_DECL_BEGIN</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="simple_8h.html#ac1b6da5fca8f55cf77b9db8db275ab86"> 115</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structpa__simple.html">pa_simple</a> <a class="code" href="structpa__simple.html">pa_simple</a>;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <a class="code" href="structpa__simple.html">pa_simple</a>* <a class="code" href="simple_8h.html#add9a7dce4e15955d4296726c26206689">pa_simple_new</a>(</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *server, </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *name, </div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <a class="code" href="def_8h.html#a637b1451881b8c0b0f98bafe115d7254">pa_stream_direction_t</a> dir, </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *dev, </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *stream_name, </div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keyword">const</span> <a class="code" href="structpa__sample__spec.html">pa_sample_spec</a> *ss, </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keyword">const</span> <a class="code" href="structpa__channel__map.html">pa_channel_map</a> *map, </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keyword">const</span> <a class="code" href="structpa__buffer__attr.html">pa_buffer_attr</a> *attr, </div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keywordtype">int</span> *error </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  );</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="keywordtype">void</span> <a class="code" href="simple_8h.html#ad66a88bc23d2a54542df441ff472c389">pa_simple_free</a>(<a class="code" href="structpa__simple.html">pa_simple</a> *s);</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="keywordtype">int</span> <a class="code" href="simple_8h.html#af40711a9181c003b71074678c11372af">pa_simple_write</a>(<a class="code" href="structpa__simple.html">pa_simple</a> *s, <span class="keyword">const</span> <span class="keywordtype">void</span> *data, <span class="keywordtype">size_t</span> bytes, <span class="keywordtype">int</span> *error);</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="keywordtype">int</span> <a class="code" href="simple_8h.html#a28d1c33441b1bd6e7486cf299cf98233">pa_simple_drain</a>(<a class="code" href="structpa__simple.html">pa_simple</a> *s, <span class="keywordtype">int</span> *error);</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="keywordtype">int</span> <a class="code" href="simple_8h.html#a7d4d4e332b03f6525969241def7f822f">pa_simple_read</a>(</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <a class="code" href="structpa__simple.html">pa_simple</a> *s, </div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keywordtype">void</span> *data, </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keywordtype">size_t</span> bytes, </div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="keywordtype">int</span> *error</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  );</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <a class="code" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> <a class="code" href="simple_8h.html#a613419d24e0fd8909dd4d01897d2fa49">pa_simple_get_latency</a>(<a class="code" href="structpa__simple.html">pa_simple</a> *s, <span class="keywordtype">int</span> *error);</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> </div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="keywordtype">int</span> <a class="code" href="simple_8h.html#ad236fee060a54fce375dbc444b385f59">pa_simple_flush</a>(<a class="code" href="structpa__simple.html">pa_simple</a> *s, <span class="keywordtype">int</span> *error);</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> PA_C_DECL_END</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="simple_8h_html_a7d4d4e332b03f6525969241def7f822f"><div class="ttname"><a href="simple_8h.html#a7d4d4e332b03f6525969241def7f822f">pa_simple_read</a></div><div class="ttdeci">int pa_simple_read(pa_simple *s, void *data, size_t bytes, int *error)</div><div class="ttdoc">Read some data from the server. </div></div>
<div class="ttc" id="structpa__sample__spec_html"><div class="ttname"><a href="structpa__sample__spec.html">pa_sample_spec</a></div><div class="ttdoc">A sample format and attribute specification. </div><div class="ttdef"><b>Definition:</b> sample.h:248</div></div>
<div class="ttc" id="simple_8h_html_a28d1c33441b1bd6e7486cf299cf98233"><div class="ttname"><a href="simple_8h.html#a28d1c33441b1bd6e7486cf299cf98233">pa_simple_drain</a></div><div class="ttdeci">int pa_simple_drain(pa_simple *s, int *error)</div><div class="ttdoc">Wait until all data already written is played by the daemon. </div></div>
<div class="ttc" id="def_8h_html"><div class="ttname"><a href="def_8h.html">def.h</a></div><div class="ttdoc">Global definitions. </div></div>
<div class="ttc" id="simple_8h_html_ad66a88bc23d2a54542df441ff472c389"><div class="ttname"><a href="simple_8h.html#ad66a88bc23d2a54542df441ff472c389">pa_simple_free</a></div><div class="ttdeci">void pa_simple_free(pa_simple *s)</div><div class="ttdoc">Close and free the connection to the server. </div></div>
<div class="ttc" id="simple_8h_html_af40711a9181c003b71074678c11372af"><div class="ttname"><a href="simple_8h.html#af40711a9181c003b71074678c11372af">pa_simple_write</a></div><div class="ttdeci">int pa_simple_write(pa_simple *s, const void *data, size_t bytes, int *error)</div><div class="ttdoc">Write some data to the server. </div></div>
<div class="ttc" id="sample_8h_html_a885df3b973773f0dccbbec6bc6777f89"><div class="ttname"><a href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a></div><div class="ttdeci">uint64_t pa_usec_t</div><div class="ttdoc">Type for usec specifications (unsigned). </div><div class="ttdef"><b>Definition:</b> sample.h:260</div></div>
<div class="ttc" id="def_8h_html_a637b1451881b8c0b0f98bafe115d7254"><div class="ttname"><a href="def_8h.html#a637b1451881b8c0b0f98bafe115d7254">pa_stream_direction_t</a></div><div class="ttdeci">enum pa_stream_direction pa_stream_direction_t</div><div class="ttdoc">The direction of a pa_stream object. </div></div>
<div class="ttc" id="channelmap_8h_html"><div class="ttname"><a href="channelmap_8h.html">channelmap.h</a></div><div class="ttdoc">Constants and routines for channel mapping handling. </div></div>
<div class="ttc" id="structpa__buffer__attr_html"><div class="ttname"><a href="structpa__buffer__attr.html">pa_buffer_attr</a></div><div class="ttdoc">Playback and record buffer metrics. </div><div class="ttdef"><b>Definition:</b> def.h:387</div></div>
<div class="ttc" id="simple_8h_html_a613419d24e0fd8909dd4d01897d2fa49"><div class="ttname"><a href="simple_8h.html#a613419d24e0fd8909dd4d01897d2fa49">pa_simple_get_latency</a></div><div class="ttdeci">pa_usec_t pa_simple_get_latency(pa_simple *s, int *error)</div><div class="ttdoc">Return the playback or record latency. </div></div>
<div class="ttc" id="simple_8h_html_ad236fee060a54fce375dbc444b385f59"><div class="ttname"><a href="simple_8h.html#ad236fee060a54fce375dbc444b385f59">pa_simple_flush</a></div><div class="ttdeci">int pa_simple_flush(pa_simple *s, int *error)</div><div class="ttdoc">Flush the playback or record buffer. </div></div>
<div class="ttc" id="simple_8h_html_add9a7dce4e15955d4296726c26206689"><div class="ttname"><a href="simple_8h.html#add9a7dce4e15955d4296726c26206689">pa_simple_new</a></div><div class="ttdeci">pa_simple * pa_simple_new(const char *server, const char *name, pa_stream_direction_t dir, const char *dev, const char *stream_name, const pa_sample_spec *ss, const pa_channel_map *map, const pa_buffer_attr *attr, int *error)</div><div class="ttdoc">Create a new connection to the server. </div></div>
<div class="ttc" id="version_8h_html"><div class="ttname"><a href="version_8h.html">version.h</a></div><div class="ttdoc">Define header version. </div></div>
<div class="ttc" id="sample_8h_html"><div class="ttname"><a href="sample_8h.html">sample.h</a></div><div class="ttdoc">Constants and routines for sample type handling. </div></div>
<div class="ttc" id="structpa__simple_html"><div class="ttname"><a href="structpa__simple.html">pa_simple</a></div><div class="ttdoc">An opaque simple connection object. </div></div>
<div class="ttc" id="structpa__channel__map_html"><div class="ttname"><a href="structpa__channel__map.html">pa_channel_map</a></div><div class="ttdoc">A channel map which can be used to attach labels to specific channels of a stream. </div><div class="ttdef"><b>Definition:</b> channelmap.h:262</div></div>
</div><!-- fragment --></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_ec5b0a79aff2db41fe5d1b9326f09c28.html">pulse</a></li><li class="navelem"><a class="el" href="simple_8h.html">simple.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.13 </li>
</ul>
</div>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
a41e5ac5fb332416cb8019ae392f1f99
>
files
>
250
