<!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.3"/> <title>PulseAudio: simple.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="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </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 style="padding-left: 0.5em;"> <div id="projectname">PulseAudio  <span id="projectnumber">2.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </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.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#typedef-members">Typedefs</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">simple.h File Reference</div> </div> </div><!--header--> <div class="contents"> <p>A simple but limited synchronous playback and recording API. <a href="#details">More...</a></p> <p><a href="simple_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="typedef-members"></a> Typedefs</h2></td></tr> <tr class="memitem:ac1b6da5fca8f55cf77b9db8db275ab86"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structpa__simple.html">pa_simple</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="simple_8h.html#ac1b6da5fca8f55cf77b9db8db275ab86">pa_simple</a></td></tr> <tr class="separator:ac1b6da5fca8f55cf77b9db8db275ab86"><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:add9a7dce4e15955d4296726c26206689"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structpa__simple.html">pa_simple</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="simple_8h.html#add9a7dce4e15955d4296726c26206689">pa_simple_new</a> (const char *server, const char *name, <a class="el" href="def_8h.html#a637b1451881b8c0b0f98bafe115d7254">pa_stream_direction_t</a> dir, const char *dev, const char *stream_name, const <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> *ss, const <a class="el" href="structpa__channel__map.html">pa_channel_map</a> *map, const <a class="el" href="structpa__buffer__attr.html">pa_buffer_attr</a> *attr, int *error)</td></tr> <tr class="memdesc:add9a7dce4e15955d4296726c26206689"><td class="mdescLeft"> </td><td class="mdescRight">Create a new connection to the server. <a href="#add9a7dce4e15955d4296726c26206689"></a><br/></td></tr> <tr class="separator:add9a7dce4e15955d4296726c26206689"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad66a88bc23d2a54542df441ff472c389"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="simple_8h.html#ad66a88bc23d2a54542df441ff472c389">pa_simple_free</a> (<a class="el" href="structpa__simple.html">pa_simple</a> *s)</td></tr> <tr class="memdesc:ad66a88bc23d2a54542df441ff472c389"><td class="mdescLeft"> </td><td class="mdescRight">Close and free the connection to the server. <a href="#ad66a88bc23d2a54542df441ff472c389"></a><br/></td></tr> <tr class="separator:ad66a88bc23d2a54542df441ff472c389"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af40711a9181c003b71074678c11372af"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="simple_8h.html#af40711a9181c003b71074678c11372af">pa_simple_write</a> (<a class="el" href="structpa__simple.html">pa_simple</a> *s, const void *data, size_t bytes, int *error)</td></tr> <tr class="memdesc:af40711a9181c003b71074678c11372af"><td class="mdescLeft"> </td><td class="mdescRight">Write some data to the server. <a href="#af40711a9181c003b71074678c11372af"></a><br/></td></tr> <tr class="separator:af40711a9181c003b71074678c11372af"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a28d1c33441b1bd6e7486cf299cf98233"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="simple_8h.html#a28d1c33441b1bd6e7486cf299cf98233">pa_simple_drain</a> (<a class="el" href="structpa__simple.html">pa_simple</a> *s, int *error)</td></tr> <tr class="memdesc:a28d1c33441b1bd6e7486cf299cf98233"><td class="mdescLeft"> </td><td class="mdescRight">Wait until all data already written is played by the daemon. <a href="#a28d1c33441b1bd6e7486cf299cf98233"></a><br/></td></tr> <tr class="separator:a28d1c33441b1bd6e7486cf299cf98233"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7d4d4e332b03f6525969241def7f822f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="simple_8h.html#a7d4d4e332b03f6525969241def7f822f">pa_simple_read</a> (<a class="el" href="structpa__simple.html">pa_simple</a> *s, void *data, size_t bytes, int *error)</td></tr> <tr class="memdesc:a7d4d4e332b03f6525969241def7f822f"><td class="mdescLeft"> </td><td class="mdescRight">Read some data from the server. <a href="#a7d4d4e332b03f6525969241def7f822f"></a><br/></td></tr> <tr class="separator:a7d4d4e332b03f6525969241def7f822f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a613419d24e0fd8909dd4d01897d2fa49"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="simple_8h.html#a613419d24e0fd8909dd4d01897d2fa49">pa_simple_get_latency</a> (<a class="el" href="structpa__simple.html">pa_simple</a> *s, int *error)</td></tr> <tr class="memdesc:a613419d24e0fd8909dd4d01897d2fa49"><td class="mdescLeft"> </td><td class="mdescRight">Return the playback latency. <a href="#a613419d24e0fd8909dd4d01897d2fa49"></a><br/></td></tr> <tr class="separator:a613419d24e0fd8909dd4d01897d2fa49"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad236fee060a54fce375dbc444b385f59"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="simple_8h.html#ad236fee060a54fce375dbc444b385f59">pa_simple_flush</a> (<a class="el" href="structpa__simple.html">pa_simple</a> *s, int *error)</td></tr> <tr class="memdesc:ad236fee060a54fce375dbc444b385f59"><td class="mdescLeft"> </td><td class="mdescRight">Flush the playback buffer. <a href="#ad236fee060a54fce375dbc444b385f59"></a><br/></td></tr> <tr class="separator:ad236fee060a54fce375dbc444b385f59"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>A simple but limited synchronous playback and recording API. </p> <p>This is a synchronous, simplified wrapper around the standard asynchronous API.</p> <p>See also<a class="el" href="simple.html">Simple API</a> </p> </div><h2 class="groupheader">Typedef Documentation</h2> <a class="anchor" id="ac1b6da5fca8f55cf77b9db8db275ab86"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structpa__simple.html">pa_simple</a> <a class="el" href="structpa__simple.html">pa_simple</a></td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="a28d1c33441b1bd6e7486cf299cf98233"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int pa_simple_drain </td> <td>(</td> <td class="paramtype"><a class="el" href="structpa__simple.html">pa_simple</a> * </td> <td class="paramname"><em>s</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int * </td> <td class="paramname"><em>error</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Wait until all data already written is played by the daemon. </p> <dl><dt><b>Examples: </b></dt><dd><a class="el" href="pacat-simple_8c-example.html#a9">pacat-simple.c</a>.</dd> </dl> </div> </div> <a class="anchor" id="ad236fee060a54fce375dbc444b385f59"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int pa_simple_flush </td> <td>(</td> <td class="paramtype"><a class="el" href="structpa__simple.html">pa_simple</a> * </td> <td class="paramname"><em>s</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int * </td> <td class="paramname"><em>error</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Flush the playback buffer. </p> <p>This discards any audio in the buffer. </p> </div> </div> <a class="anchor" id="ad66a88bc23d2a54542df441ff472c389"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void pa_simple_free </td> <td>(</td> <td class="paramtype"><a class="el" href="structpa__simple.html">pa_simple</a> * </td> <td class="paramname"><em>s</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Close and free the connection to the server. </p> <p>The connection object becomes invalid when this is called. </p> <dl><dt><b>Examples: </b></dt><dd><a class="el" href="pacat-simple_8c-example.html#a10">pacat-simple.c</a>, and <a class="el" href="parec-simple_8c-example.html#a8">parec-simple.c</a>.</dd> </dl> </div> </div> <a class="anchor" id="a613419d24e0fd8909dd4d01897d2fa49"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> pa_simple_get_latency </td> <td>(</td> <td class="paramtype"><a class="el" href="structpa__simple.html">pa_simple</a> * </td> <td class="paramname"><em>s</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int * </td> <td class="paramname"><em>error</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Return the playback latency. </p> <dl><dt><b>Examples: </b></dt><dd><a class="el" href="pacat-simple_8c-example.html#a7">pacat-simple.c</a>.</dd> </dl> </div> </div> <a class="anchor" id="add9a7dce4e15955d4296726c26206689"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structpa__simple.html">pa_simple</a>* pa_simple_new </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>server</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"><a class="el" href="def_8h.html#a637b1451881b8c0b0f98bafe115d7254">pa_stream_direction_t</a> </td> <td class="paramname"><em>dir</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>dev</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>stream_name</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> * </td> <td class="paramname"><em>ss</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="structpa__channel__map.html">pa_channel_map</a> * </td> <td class="paramname"><em>map</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="structpa__buffer__attr.html">pa_buffer_attr</a> * </td> <td class="paramname"><em>attr</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int * </td> <td class="paramname"><em>error</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Create a new connection to the server. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">server</td><td>Server name, or NULL for default </td></tr> <tr><td class="paramname">name</td><td>A descriptive name for this client (application name, ...) </td></tr> <tr><td class="paramname">dir</td><td>Open this stream for recording or playback? </td></tr> <tr><td class="paramname">dev</td><td>Sink (resp. source) name, or NULL for default </td></tr> <tr><td class="paramname">stream_name</td><td>A descriptive name for this stream (application name, song title, ...) </td></tr> <tr><td class="paramname">ss</td><td>The sample type to use </td></tr> <tr><td class="paramname">map</td><td>The channel map to use, or NULL for default </td></tr> <tr><td class="paramname">attr</td><td>Buffering attributes, or NULL for default </td></tr> <tr><td class="paramname">error</td><td>A pointer where the error code is stored when the routine returns NULL. It is OK to pass NULL here. </td></tr> </table> </dd> </dl> <dl><dt><b>Examples: </b></dt><dd><a class="el" href="pacat-simple_8c-example.html#a4">pacat-simple.c</a>, and <a class="el" href="parec-simple_8c-example.html#a4">parec-simple.c</a>.</dd> </dl> </div> </div> <a class="anchor" id="a7d4d4e332b03f6525969241def7f822f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int pa_simple_read </td> <td>(</td> <td class="paramtype"><a class="el" href="structpa__simple.html">pa_simple</a> * </td> <td class="paramname"><em>s</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 class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>bytes</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int * </td> <td class="paramname"><em>error</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Read some data from the server. </p> <dl><dt><b>Examples: </b></dt><dd><a class="el" href="parec-simple_8c-example.html#a7">parec-simple.c</a>.</dd> </dl> </div> </div> <a class="anchor" id="af40711a9181c003b71074678c11372af"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int pa_simple_write </td> <td>(</td> <td class="paramtype"><a class="el" href="structpa__simple.html">pa_simple</a> * </td> <td class="paramname"><em>s</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const void * </td> <td class="paramname"><em>data</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>bytes</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int * </td> <td class="paramname"><em>error</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Write some data to the server. </p> <dl><dt><b>Examples: </b></dt><dd><a class="el" href="pacat-simple_8c-example.html#a8">pacat-simple.c</a>.</dd> </dl> </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_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.3 </li> </ul> </div> </body> </html>