<!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: scache.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('scache_8h_source.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <div class="title">scache.h</div> </div> </div><!--header--> <div class="contents"> <a href="scache_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 fooscachehfoo</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define fooscachehfoo</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="context_8h.html">pulse/context.h</a>></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="code" href="stream_8h.html">pulse/stream.h</a>></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <pulse/cdecl.h></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <<a class="code" href="version_8h.html">pulse/version.h</a>></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> PA_C_DECL_BEGIN</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="scache_8h.html#abceffc4d9c6969fd3b17ea44eba9d865"> 85</a></span> <span class="keyword">typedef</span> void (*<a class="code" href="scache_8h.html#abceffc4d9c6969fd3b17ea44eba9d865">pa_context_play_sample_cb_t</a>)(<a class="code" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, uint32_t idx, <span class="keywordtype">void</span> *userdata);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="keywordtype">int</span> <a class="code" href="scache_8h.html#a4725d83c96ddb3a4c67954bf5ec3a8c1">pa_stream_connect_upload</a>(<a class="code" href="stream_8h.html#a960d798980692a2ff01e5a70553d4f29">pa_stream</a> *s, <span class="keywordtype">size_t</span> length);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="keywordtype">int</span> <a class="code" href="scache_8h.html#a892d5d35de5ec726b8fa151abd87b92b">pa_stream_finish_upload</a>(<a class="code" href="stream_8h.html#a960d798980692a2ff01e5a70553d4f29">pa_stream</a> *s);</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <a class="code" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a>* <a class="code" href="scache_8h.html#a8c5e594fd912cd5badab7804eae22ba9">pa_context_remove_sample</a>(<a class="code" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code" href="context_8h.html#a086b985c499c50efc628c267e8923fb1">pa_context_success_cb_t</a> cb, <span class="keywordtype">void</span> *userdata);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <a class="code" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a>* <a class="code" href="scache_8h.html#adb1bf81ecef03f8bae77e5e3ab30464f">pa_context_play_sample</a>(</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <a class="code" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c ,</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *name ,</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *dev ,</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <a class="code" href="volume_8h.html#a6d671c65284ff2e94d3773c7368a0352">pa_volume_t</a> volume ,</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <a class="code" href="context_8h.html#a086b985c499c50efc628c267e8923fb1">pa_context_success_cb_t</a> cb ,</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordtype">void</span> *userdata );</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <a class="code" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a>* <a class="code" href="scache_8h.html#a4ac9ef460c5182e521dd90613bd7922c">pa_context_play_sample_with_proplist</a>(</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <a class="code" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c ,</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *name ,</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *dev ,</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <a class="code" href="volume_8h.html#a6d671c65284ff2e94d3773c7368a0352">pa_volume_t</a> volume ,</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <a class="code" href="proplist_8h.html#acdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> *proplist ,</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <a class="code" href="scache_8h.html#abceffc4d9c6969fd3b17ea44eba9d865">pa_context_play_sample_cb_t</a> cb ,</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keywordtype">void</span> *userdata );</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> PA_C_DECL_END</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="context_8h_html_aff56e9b3dd442a88227da084bb5c380a"><div class="ttname"><a href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a></div><div class="ttdeci">struct pa_context pa_context</div><div class="ttdoc">An opaque connection context to a daemon. </div><div class="ttdef"><b>Definition:</b> context.h:154</div></div> <div class="ttc" id="scache_8h_html_abceffc4d9c6969fd3b17ea44eba9d865"><div class="ttname"><a href="scache_8h.html#abceffc4d9c6969fd3b17ea44eba9d865">pa_context_play_sample_cb_t</a></div><div class="ttdeci">void(* pa_context_play_sample_cb_t)(pa_context *c, uint32_t idx, void *userdata)</div><div class="ttdoc">Callback prototype for pa_context_play_sample_with_proplist(). </div><div class="ttdef"><b>Definition:</b> scache.h:85</div></div> <div class="ttc" id="scache_8h_html_a4ac9ef460c5182e521dd90613bd7922c"><div class="ttname"><a href="scache_8h.html#a4ac9ef460c5182e521dd90613bd7922c">pa_context_play_sample_with_proplist</a></div><div class="ttdeci">pa_operation * pa_context_play_sample_with_proplist(pa_context *c, const char *name, const char *dev, pa_volume_t volume, pa_proplist *proplist, pa_context_play_sample_cb_t cb, void *userdata)</div><div class="ttdoc">Play a sample from the sample cache to the specified device, allowing specification of a property lis...</div></div> <div class="ttc" id="scache_8h_html_a892d5d35de5ec726b8fa151abd87b92b"><div class="ttname"><a href="scache_8h.html#a892d5d35de5ec726b8fa151abd87b92b">pa_stream_finish_upload</a></div><div class="ttdeci">int pa_stream_finish_upload(pa_stream *s)</div><div class="ttdoc">Finish the sample upload, the stream name will become the sample name. </div></div> <div class="ttc" id="context_8h_html"><div class="ttname"><a href="context_8h.html">context.h</a></div><div class="ttdoc">Connection contexts for asynchronous communication with a server. </div></div> <div class="ttc" id="operation_8h_html_a5614a07f2e7a129e4cb16596ed452a0c"><div class="ttname"><a href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a></div><div class="ttdeci">struct pa_operation pa_operation</div><div class="ttdoc">An asynchronous operation object. </div><div class="ttdef"><b>Definition:</b> operation.h:33</div></div> <div class="ttc" id="context_8h_html_a086b985c499c50efc628c267e8923fb1"><div class="ttname"><a href="context_8h.html#a086b985c499c50efc628c267e8923fb1">pa_context_success_cb_t</a></div><div class="ttdeci">void(* pa_context_success_cb_t)(pa_context *c, int success, void *userdata)</div><div class="ttdoc">A generic callback for operation completion. </div><div class="ttdef"><b>Definition:</b> context.h:160</div></div> <div class="ttc" id="stream_8h_html"><div class="ttname"><a href="stream_8h.html">stream.h</a></div><div class="ttdoc">Audio streams for input, output and sample upload. </div></div> <div class="ttc" id="scache_8h_html_a8c5e594fd912cd5badab7804eae22ba9"><div class="ttname"><a href="scache_8h.html#a8c5e594fd912cd5badab7804eae22ba9">pa_context_remove_sample</a></div><div class="ttdeci">pa_operation * pa_context_remove_sample(pa_context *c, const char *name, pa_context_success_cb_t cb, void *userdata)</div><div class="ttdoc">Remove a sample from the sample cache. </div></div> <div class="ttc" id="scache_8h_html_a4725d83c96ddb3a4c67954bf5ec3a8c1"><div class="ttname"><a href="scache_8h.html#a4725d83c96ddb3a4c67954bf5ec3a8c1">pa_stream_connect_upload</a></div><div class="ttdeci">int pa_stream_connect_upload(pa_stream *s, size_t length)</div><div class="ttdoc">Make this stream a sample upload stream. </div></div> <div class="ttc" id="stream_8h_html_a960d798980692a2ff01e5a70553d4f29"><div class="ttname"><a href="stream_8h.html#a960d798980692a2ff01e5a70553d4f29">pa_stream</a></div><div class="ttdeci">struct pa_stream pa_stream</div><div class="ttdoc">An opaque stream for playback or recording. </div><div class="ttdef"><b>Definition:</b> stream.h:335</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="volume_8h_html_a6d671c65284ff2e94d3773c7368a0352"><div class="ttname"><a href="volume_8h.html#a6d671c65284ff2e94d3773c7368a0352">pa_volume_t</a></div><div class="ttdeci">uint32_t pa_volume_t</div><div class="ttdoc">Volume specification: PA_VOLUME_MUTED: silence; < PA_VOLUME_NORM: decreased volume; PA_VOLUME_NORM: n...</div><div class="ttdef"><b>Definition:</b> volume.h:120</div></div> <div class="ttc" id="proplist_8h_html_acdf756a6014b6fae3b358b2c934c3426"><div class="ttname"><a href="proplist_8h.html#acdf756a6014b6fae3b358b2c934c3426">pa_proplist</a></div><div class="ttdeci">struct pa_proplist pa_proplist</div><div class="ttdoc">A property list object. </div><div class="ttdef"><b>Definition:</b> proplist.h:272</div></div> <div class="ttc" id="scache_8h_html_adb1bf81ecef03f8bae77e5e3ab30464f"><div class="ttname"><a href="scache_8h.html#adb1bf81ecef03f8bae77e5e3ab30464f">pa_context_play_sample</a></div><div class="ttdeci">pa_operation * pa_context_play_sample(pa_context *c, const char *name, const char *dev, pa_volume_t volume, pa_context_success_cb_t cb, void *userdata)</div><div class="ttdoc">Play a sample from the sample cache to the specified device. </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="scache_8h.html">scache.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>