<!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: scache.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('scache_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">scache.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>All sample cache related routines.
<a href="#details">More...</a></p>
<p><a href="scache_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:a9843db9018ac9038c6acd3229bca4f0e"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="scache_8h.html#a9843db9018ac9038c6acd3229bca4f0e">pa_context_play_sample_cb_t</a> )(<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, uint32_t idx, void *userdata)</td></tr>
<tr class="memdesc:a9843db9018ac9038c6acd3229bca4f0e"><td class="mdescLeft"> </td><td class="mdescRight">Callback prototype for <a class="el" href="scache_8h.html#a4ac9ef460c5182e521dd90613bd7922c" title="Play a sample from the sample cache to the specified device, allowing specification of a property lis...">pa_context_play_sample_with_proplist()</a>. <a href="#a9843db9018ac9038c6acd3229bca4f0e"></a><br/></td></tr>
<tr class="separator:a9843db9018ac9038c6acd3229bca4f0e"><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:a4725d83c96ddb3a4c67954bf5ec3a8c1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="scache_8h.html#a4725d83c96ddb3a4c67954bf5ec3a8c1">pa_stream_connect_upload</a> (<a class="el" href="stream_8h.html#a960d798980692a2ff01e5a70553d4f29">pa_stream</a> *s, size_t length)</td></tr>
<tr class="memdesc:a4725d83c96ddb3a4c67954bf5ec3a8c1"><td class="mdescLeft"> </td><td class="mdescRight">Make this stream a sample upload stream. <a href="#a4725d83c96ddb3a4c67954bf5ec3a8c1"></a><br/></td></tr>
<tr class="separator:a4725d83c96ddb3a4c67954bf5ec3a8c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a892d5d35de5ec726b8fa151abd87b92b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="scache_8h.html#a892d5d35de5ec726b8fa151abd87b92b">pa_stream_finish_upload</a> (<a class="el" href="stream_8h.html#a960d798980692a2ff01e5a70553d4f29">pa_stream</a> *s)</td></tr>
<tr class="memdesc:a892d5d35de5ec726b8fa151abd87b92b"><td class="mdescLeft"> </td><td class="mdescRight">Finish the sample upload, the stream name will become the sample name. <a href="#a892d5d35de5ec726b8fa151abd87b92b"></a><br/></td></tr>
<tr class="separator:a892d5d35de5ec726b8fa151abd87b92b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8c5e594fd912cd5badab7804eae22ba9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="scache_8h.html#a8c5e594fd912cd5badab7804eae22ba9">pa_context_remove_sample</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, const char *name, <a class="el" href="context_8h.html#a010aff61766ac2d9585d78a164c0fc9a">pa_context_success_cb_t</a> cb, void *userdata)</td></tr>
<tr class="memdesc:a8c5e594fd912cd5badab7804eae22ba9"><td class="mdescLeft"> </td><td class="mdescRight">Remove a sample from the sample cache. <a href="#a8c5e594fd912cd5badab7804eae22ba9"></a><br/></td></tr>
<tr class="separator:a8c5e594fd912cd5badab7804eae22ba9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adb1bf81ecef03f8bae77e5e3ab30464f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="scache_8h.html#adb1bf81ecef03f8bae77e5e3ab30464f">pa_context_play_sample</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, const char *name, const char *dev, <a class="el" href="volume_8h.html#a6d671c65284ff2e94d3773c7368a0352">pa_volume_t</a> volume, <a class="el" href="context_8h.html#a010aff61766ac2d9585d78a164c0fc9a">pa_context_success_cb_t</a> cb, void *userdata)</td></tr>
<tr class="memdesc:adb1bf81ecef03f8bae77e5e3ab30464f"><td class="mdescLeft"> </td><td class="mdescRight">Play a sample from the sample cache to the specified device. <a href="#adb1bf81ecef03f8bae77e5e3ab30464f"></a><br/></td></tr>
<tr class="separator:adb1bf81ecef03f8bae77e5e3ab30464f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4ac9ef460c5182e521dd90613bd7922c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="scache_8h.html#a4ac9ef460c5182e521dd90613bd7922c">pa_context_play_sample_with_proplist</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, const char *name, const char *dev, <a class="el" href="volume_8h.html#a6d671c65284ff2e94d3773c7368a0352">pa_volume_t</a> volume, <a class="el" href="proplist_8h.html#acdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> *proplist, <a class="el" href="scache_8h.html#a9843db9018ac9038c6acd3229bca4f0e">pa_context_play_sample_cb_t</a> cb, void *userdata)</td></tr>
<tr class="memdesc:a4ac9ef460c5182e521dd90613bd7922c"><td class="mdescLeft"> </td><td class="mdescRight">Play a sample from the sample cache to the specified device, allowing specification of a property list for the playback stream. <a href="#a4ac9ef460c5182e521dd90613bd7922c"></a><br/></td></tr>
<tr class="separator:a4ac9ef460c5182e521dd90613bd7922c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>All sample cache related routines. </p>
<p>See also<a class="el" href="scache.html">Sample Cache</a> </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a9843db9018ac9038c6acd3229bca4f0e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* pa_context_play_sample_cb_t)(<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, uint32_t idx, void *userdata)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback prototype for <a class="el" href="scache_8h.html#a4ac9ef460c5182e521dd90613bd7922c" title="Play a sample from the sample cache to the specified device, allowing specification of a property lis...">pa_context_play_sample_with_proplist()</a>. </p>
<p>The idx value is the index of the sink input object, or PA_INVALID_INDEX on failure.</p>
<dl class="section since"><dt>Since</dt><dd>0.9.11 </dd></dl>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="adb1bf81ecef03f8bae77e5e3ab30464f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a>* pa_context_play_sample </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</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">const char * </td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="volume_8h.html#a6d671c65284ff2e94d3773c7368a0352">pa_volume_t</a> </td>
<td class="paramname"><em>volume</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="context_8h.html#a010aff61766ac2d9585d78a164c0fc9a">pa_context_success_cb_t</a> </td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>userdata</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Play a sample from the sample cache to the specified device. </p>
<p>If the latter is NULL use the default sink. Returns an operation object </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>Context </td></tr>
<tr><td class="paramname">name</td><td>Name of the sample to play </td></tr>
<tr><td class="paramname">dev</td><td>Sink to play this sample on </td></tr>
<tr><td class="paramname">volume</td><td>Volume to play this sample with. Starting with 0.9.15 you may pass here PA_VOLUME_INVALID which will leave the decision about the volume to the server side which is a good idea. </td></tr>
<tr><td class="paramname">cb</td><td>Call this function after successfully starting playback, or NULL </td></tr>
<tr><td class="paramname">userdata</td><td>Userdata to pass to the callback </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4ac9ef460c5182e521dd90613bd7922c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a>* pa_context_play_sample_with_proplist </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</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">const char * </td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="volume_8h.html#a6d671c65284ff2e94d3773c7368a0352">pa_volume_t</a> </td>
<td class="paramname"><em>volume</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="proplist_8h.html#acdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td>
<td class="paramname"><em>proplist</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="scache_8h.html#a9843db9018ac9038c6acd3229bca4f0e">pa_context_play_sample_cb_t</a> </td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>userdata</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Play a sample from the sample cache to the specified device, allowing specification of a property list for the playback stream. </p>
<p>If the latter is NULL use the default sink. Returns an operation object.</p>
<dl class="section since"><dt>Since</dt><dd>0.9.11 </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>Context </td></tr>
<tr><td class="paramname">name</td><td>Name of the sample to play </td></tr>
<tr><td class="paramname">dev</td><td>Sink to play this sample on </td></tr>
<tr><td class="paramname">volume</td><td>Volume to play this sample with. Starting with 0.9.15 you may pass here PA_VOLUME_INVALID which will leave the decision about the volume to the server side which is a good idea. </td></tr>
<tr><td class="paramname">proplist</td><td>Property list for this sound. The property list of the cached entry will be merged into this property list </td></tr>
<tr><td class="paramname">cb</td><td>Call this function after successfully starting playback, or NULL </td></tr>
<tr><td class="paramname">userdata</td><td>Userdata to pass to the callback </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8c5e594fd912cd5badab7804eae22ba9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a>* pa_context_remove_sample </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</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="context_8h.html#a010aff61766ac2d9585d78a164c0fc9a">pa_context_success_cb_t</a> </td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>userdata</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove a sample from the sample cache. </p>
<p>Returns an operation object which may be used to cancel the operation while it is running </p>
</div>
</div>
<a class="anchor" id="a4725d83c96ddb3a4c67954bf5ec3a8c1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_stream_connect_upload </td>
<td>(</td>
<td class="paramtype"><a class="el" href="stream_8h.html#a960d798980692a2ff01e5a70553d4f29">pa_stream</a> * </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>length</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Make this stream a sample upload stream. </p>
</div>
</div>
<a class="anchor" id="a892d5d35de5ec726b8fa151abd87b92b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_stream_finish_upload </td>
<td>(</td>
<td class="paramtype"><a class="el" href="stream_8h.html#a960d798980692a2ff01e5a70553d4f29">pa_stream</a> * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Finish the sample upload, the stream name will become the sample name. </p>
<p>You cancel a sample upload by issuing <a class="el" href="stream_8h.html#aa4e0c83264f3935911e6b30e6f8ef2b1" title="Disconnect a stream from a source/sink.">pa_stream_disconnect()</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_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.3 </li>
</ul>
</div>
</body>
</html>
