<!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>aubio: io/sink.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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></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">aubio
 <span id="projectnumber">0.4.2~alpha</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_bc161955dc3a3d2485839eba21420d01.html">io</a></li> </ul>
</div>
</div><!-- top -->
<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">sink.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Media sink to write blocks of consecutive audio samples to file.
<a href="#details">More...</a></p>
<p><a href="sink_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:ab3fd37f3117e99c10c63cb595821c31d"><td class="memItemLeft" align="right" valign="top"><a id="ab3fd37f3117e99c10c63cb595821c31d"></a>
typedef struct _aubio_sink_t </td><td class="memItemRight" valign="bottom"><a class="el" href="sink_8h.html#ab3fd37f3117e99c10c63cb595821c31d">aubio_sink_t</a></td></tr>
<tr class="memdesc:ab3fd37f3117e99c10c63cb595821c31d"><td class="mdescLeft"> </td><td class="mdescRight">media sink object <br /></td></tr>
<tr class="separator:ab3fd37f3117e99c10c63cb595821c31d"><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:a2de2683d91ada3cf80fcf418606032e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sink_8h.html#ab3fd37f3117e99c10c63cb595821c31d">aubio_sink_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="sink_8h.html#a2de2683d91ada3cf80fcf418606032e3">new_aubio_sink</a> (<a class="el" href="types_8h.html#a40bb5262bf908c328fbcfbe5d29d0201">char_t</a> *uri, <a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> samplerate)</td></tr>
<tr class="memdesc:a2de2683d91ada3cf80fcf418606032e3"><td class="mdescLeft"> </td><td class="mdescRight">create new <a class="el" href="sink_8h.html#ab3fd37f3117e99c10c63cb595821c31d" title="media sink object ">aubio_sink_t</a> <a href="#a2de2683d91ada3cf80fcf418606032e3">More...</a><br /></td></tr>
<tr class="separator:a2de2683d91ada3cf80fcf418606032e3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e043eefb868d6c6e1fbe840bbcd826b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sink_8h.html#a3e043eefb868d6c6e1fbe840bbcd826b">aubio_sink_preset_samplerate</a> (<a class="el" href="sink_8h.html#ab3fd37f3117e99c10c63cb595821c31d">aubio_sink_t</a> *s, <a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> samplerate)</td></tr>
<tr class="memdesc:a3e043eefb868d6c6e1fbe840bbcd826b"><td class="mdescLeft"> </td><td class="mdescRight">preset sink samplerate <a href="#a3e043eefb868d6c6e1fbe840bbcd826b">More...</a><br /></td></tr>
<tr class="separator:a3e043eefb868d6c6e1fbe840bbcd826b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae28d51aee8cdae1d840c9a1047855081"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sink_8h.html#ae28d51aee8cdae1d840c9a1047855081">aubio_sink_preset_channels</a> (<a class="el" href="sink_8h.html#ab3fd37f3117e99c10c63cb595821c31d">aubio_sink_t</a> *s, <a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> channels)</td></tr>
<tr class="memdesc:ae28d51aee8cdae1d840c9a1047855081"><td class="mdescLeft"> </td><td class="mdescRight">preset sink channels <a href="#ae28d51aee8cdae1d840c9a1047855081">More...</a><br /></td></tr>
<tr class="separator:ae28d51aee8cdae1d840c9a1047855081"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a09a043f6c195bec940c088769239f123"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sink_8h.html#a09a043f6c195bec940c088769239f123">aubio_sink_get_samplerate</a> (<a class="el" href="sink_8h.html#ab3fd37f3117e99c10c63cb595821c31d">aubio_sink_t</a> *s)</td></tr>
<tr class="memdesc:a09a043f6c195bec940c088769239f123"><td class="mdescLeft"> </td><td class="mdescRight">get samplerate of sink object <a href="#a09a043f6c195bec940c088769239f123">More...</a><br /></td></tr>
<tr class="separator:a09a043f6c195bec940c088769239f123"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a42e37c908e5a8f00488841502969e263"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sink_8h.html#a42e37c908e5a8f00488841502969e263">aubio_sink_get_channels</a> (<a class="el" href="sink_8h.html#ab3fd37f3117e99c10c63cb595821c31d">aubio_sink_t</a> *s)</td></tr>
<tr class="memdesc:a42e37c908e5a8f00488841502969e263"><td class="mdescLeft"> </td><td class="mdescRight">get channels of sink object <a href="#a42e37c908e5a8f00488841502969e263">More...</a><br /></td></tr>
<tr class="separator:a42e37c908e5a8f00488841502969e263"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a72cd56dca6c57b30c8d62797fc9ff687"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sink_8h.html#a72cd56dca6c57b30c8d62797fc9ff687">aubio_sink_do</a> (<a class="el" href="sink_8h.html#ab3fd37f3117e99c10c63cb595821c31d">aubio_sink_t</a> *s, <a class="el" href="structfvec__t.html">fvec_t</a> *write_data, <a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> write)</td></tr>
<tr class="memdesc:a72cd56dca6c57b30c8d62797fc9ff687"><td class="mdescLeft"> </td><td class="mdescRight">write monophonic vector of length hop_size to sink <a href="#a72cd56dca6c57b30c8d62797fc9ff687">More...</a><br /></td></tr>
<tr class="separator:a72cd56dca6c57b30c8d62797fc9ff687"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6e021aba881a01b4a5d42096be33f7ff"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sink_8h.html#a6e021aba881a01b4a5d42096be33f7ff">aubio_sink_do_multi</a> (<a class="el" href="sink_8h.html#ab3fd37f3117e99c10c63cb595821c31d">aubio_sink_t</a> *s, <a class="el" href="structfmat__t.html">fmat_t</a> *write_data, <a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> write)</td></tr>
<tr class="memdesc:a6e021aba881a01b4a5d42096be33f7ff"><td class="mdescLeft"> </td><td class="mdescRight">write polyphonic vector of length hop_size to sink <a href="#a6e021aba881a01b4a5d42096be33f7ff">More...</a><br /></td></tr>
<tr class="separator:a6e021aba881a01b4a5d42096be33f7ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d8c79bd6f487a770ac697a9829520ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sink_8h.html#a1d8c79bd6f487a770ac697a9829520ee">aubio_sink_close</a> (<a class="el" href="sink_8h.html#ab3fd37f3117e99c10c63cb595821c31d">aubio_sink_t</a> *s)</td></tr>
<tr class="memdesc:a1d8c79bd6f487a770ac697a9829520ee"><td class="mdescLeft"> </td><td class="mdescRight">close sink <a href="#a1d8c79bd6f487a770ac697a9829520ee">More...</a><br /></td></tr>
<tr class="separator:a1d8c79bd6f487a770ac697a9829520ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a75792712904746e13373dd7227a7e846"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sink_8h.html#a75792712904746e13373dd7227a7e846">del_aubio_sink</a> (<a class="el" href="sink_8h.html#ab3fd37f3117e99c10c63cb595821c31d">aubio_sink_t</a> *s)</td></tr>
<tr class="memdesc:a75792712904746e13373dd7227a7e846"><td class="mdescLeft"> </td><td class="mdescRight">close sink and cleanup memory <a href="#a75792712904746e13373dd7227a7e846">More...</a><br /></td></tr>
<tr class="separator:a75792712904746e13373dd7227a7e846"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Media sink to write blocks of consecutive audio samples to file. </p>
<p>To read from file, use <a class="el" href="source_8h.html#a1a29eaffe41a16145b0c77134fea24c7" title="media source object ">aubio_source_t</a>.</p>
<p>Depending on how aubio was compiled, the following sinks will be available.</p>
<p>When creating a new sink using <a class="el" href="sink_8h.html#a2de2683d91ada3cf80fcf418606032e3" title="create new aubio_sink_t ">new_aubio_sink</a>, the new function of each of the compiled-in sinks will be attempted, in the following order, until one of them gets successfully created. If all sinks returned NULL, <a class="el" href="sink_8h.html#a2de2683d91ada3cf80fcf418606032e3" title="create new aubio_sink_t ">new_aubio_sink</a> will return NULL.</p>
<p><b><code>sink_apple_audio</code> </b>: ExtAudioFileRef</p>
<p>This sink uses CoreAudio <a href="https://developer.apple.com/library/mac/documentation/MusicAudio/Reference/ExtendedAudioFileServicesReference/Reference/reference.html">Extended Audio File Services</a> to write 16-bits encoded WAV files.</p>
<p><b><code>sink_sndfile</code> </b>: libsndfile</p>
<p>This sink uses <a href="http://www.mega-nerd.com/libsndfile/">libsndfile</a> to write 16-bits encoded WAV files.</p>
<p><b><code>sink_wavwrite</code> </b>: native WAV write</p>
<p>A simple sink to write 16-bits PCM RIFF encoded WAV files. </p>
<p class="definition">Definition in file <a class="el" href="sink_8h_source.html">sink.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a1d8c79bd6f487a770ac697a9829520ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d8c79bd6f487a770ac697a9829520ee">◆ </a></span>aubio_sink_close()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> aubio_sink_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sink_8h.html#ab3fd37f3117e99c10c63cb595821c31d">aubio_sink_t</a> * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>close sink </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>sink object, created with <a class="el" href="sink_8h.html#a2de2683d91ada3cf80fcf418606032e3" title="create new aubio_sink_t ">new_aubio_sink</a></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, non-zero on failure </dd></dl>
</div>
</div>
<a id="a72cd56dca6c57b30c8d62797fc9ff687"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72cd56dca6c57b30c8d62797fc9ff687">◆ </a></span>aubio_sink_do()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void aubio_sink_do </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sink_8h.html#ab3fd37f3117e99c10c63cb595821c31d">aubio_sink_t</a> * </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structfvec__t.html">fvec_t</a> * </td>
<td class="paramname"><em>write_data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td>
<td class="paramname"><em>write</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>write monophonic vector of length hop_size to sink </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>sink, created with <a class="el" href="sink_8h.html#a2de2683d91ada3cf80fcf418606032e3" title="create new aubio_sink_t ">new_aubio_sink</a> </td></tr>
<tr><td class="paramname">write_data</td><td><a class="el" href="structfvec__t.html" title="Buffer for real data. ">fvec_t</a> samples to write to sink </td></tr>
<tr><td class="paramname">write</td><td>number of frames to write </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="io_2test-sink_8c-example.html#a6">io/test-sink.c</a>, <a class="el" href="synth_2test-sampler_8c-example.html#a11">synth/test-sampler.c</a>, and <a class="el" href="synth_2test-wavetable_8c-example.html#a8">synth/test-wavetable.c</a>.</dd>
</dl>
</div>
</div>
<a id="a6e021aba881a01b4a5d42096be33f7ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e021aba881a01b4a5d42096be33f7ff">◆ </a></span>aubio_sink_do_multi()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void aubio_sink_do_multi </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sink_8h.html#ab3fd37f3117e99c10c63cb595821c31d">aubio_sink_t</a> * </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structfmat__t.html">fmat_t</a> * </td>
<td class="paramname"><em>write_data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td>
<td class="paramname"><em>write</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>write polyphonic vector of length hop_size to sink </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>sink, created with <a class="el" href="sink_8h.html#a2de2683d91ada3cf80fcf418606032e3" title="create new aubio_sink_t ">new_aubio_sink</a> </td></tr>
<tr><td class="paramname">write_data</td><td><a class="el" href="structfmat__t.html" title="Buffer for real data. ">fmat_t</a> samples to write to sink </td></tr>
<tr><td class="paramname">write</td><td>number of frames to write </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a42e37c908e5a8f00488841502969e263"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42e37c908e5a8f00488841502969e263">◆ </a></span>aubio_sink_get_channels()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> aubio_sink_get_channels </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sink_8h.html#ab3fd37f3117e99c10c63cb595821c31d">aubio_sink_t</a> * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get channels of sink object </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>sink object, created with <a class="el" href="sink_8h.html#a2de2683d91ada3cf80fcf418606032e3" title="create new aubio_sink_t ">new_aubio_sink</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of channels </dd></dl>
</div>
</div>
<a id="a09a043f6c195bec940c088769239f123"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09a043f6c195bec940c088769239f123">◆ </a></span>aubio_sink_get_samplerate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> aubio_sink_get_samplerate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sink_8h.html#ab3fd37f3117e99c10c63cb595821c31d">aubio_sink_t</a> * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get samplerate of sink object </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>sink object, created with <a class="el" href="sink_8h.html#a2de2683d91ada3cf80fcf418606032e3" title="create new aubio_sink_t ">new_aubio_sink</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>samplerate, in Hz </dd></dl>
</div>
</div>
<a id="ae28d51aee8cdae1d840c9a1047855081"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae28d51aee8cdae1d840c9a1047855081">◆ </a></span>aubio_sink_preset_channels()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> aubio_sink_preset_channels </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sink_8h.html#ab3fd37f3117e99c10c63cb595821c31d">aubio_sink_t</a> * </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td>
<td class="paramname"><em>channels</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>preset sink channels </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>sink, created with <a class="el" href="sink_8h.html#a2de2683d91ada3cf80fcf418606032e3" title="create new aubio_sink_t ">new_aubio_sink</a> </td></tr>
<tr><td class="paramname">channels</td><td>number of channels to preset the sink to</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, 1 on error</dd></dl>
<p>Preset the samplerate of the sink. The file should have been created using a samplerate of 0.</p>
<p>The file will be opened only when both samplerate and channels have been set. </p>
</div>
</div>
<a id="a3e043eefb868d6c6e1fbe840bbcd826b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e043eefb868d6c6e1fbe840bbcd826b">◆ </a></span>aubio_sink_preset_samplerate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> aubio_sink_preset_samplerate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sink_8h.html#ab3fd37f3117e99c10c63cb595821c31d">aubio_sink_t</a> * </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td>
<td class="paramname"><em>samplerate</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>preset sink samplerate </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>sink, created with <a class="el" href="sink_8h.html#a2de2683d91ada3cf80fcf418606032e3" title="create new aubio_sink_t ">new_aubio_sink</a> </td></tr>
<tr><td class="paramname">samplerate</td><td>samplerate to preset the sink to, in Hz</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, 1 on error</dd></dl>
<p>Preset the samplerate of the sink. The file should have been created using a samplerate of 0.</p>
<p>The file will be opened only when both samplerate and channels have been set. </p>
</div>
</div>
<a id="a75792712904746e13373dd7227a7e846"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75792712904746e13373dd7227a7e846">◆ </a></span>del_aubio_sink()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void del_aubio_sink </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sink_8h.html#ab3fd37f3117e99c10c63cb595821c31d">aubio_sink_t</a> * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>close sink and cleanup memory </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>sink object, created with <a class="el" href="sink_8h.html#a2de2683d91ada3cf80fcf418606032e3" title="create new aubio_sink_t ">new_aubio_sink</a> </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="io_2test-sink_8c-example.html#a7">io/test-sink.c</a>, <a class="el" href="synth_2test-sampler_8c-example.html#a14">synth/test-sampler.c</a>, and <a class="el" href="synth_2test-wavetable_8c-example.html#a10">synth/test-wavetable.c</a>.</dd>
</dl>
</div>
</div>
<a id="a2de2683d91ada3cf80fcf418606032e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2de2683d91ada3cf80fcf418606032e3">◆ </a></span>new_aubio_sink()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sink_8h.html#ab3fd37f3117e99c10c63cb595821c31d">aubio_sink_t</a>* new_aubio_sink </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a40bb5262bf908c328fbcfbe5d29d0201">char_t</a> * </td>
<td class="paramname"><em>uri</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td>
<td class="paramname"><em>samplerate</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>create new <a class="el" href="sink_8h.html#ab3fd37f3117e99c10c63cb595821c31d" title="media sink object ">aubio_sink_t</a> </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uri</td><td>the file path or uri to write to </td></tr>
<tr><td class="paramname">samplerate</td><td>sample rate to write the file at</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>newly created <a class="el" href="sink_8h.html#ab3fd37f3117e99c10c63cb595821c31d" title="media sink object ">aubio_sink_t</a></dd></dl>
<p>Creates a new sink object.</p>
<p>If samplerate is set to 0, the creation of the file will be delayed until both <a class="el" href="sink_8h.html#a3e043eefb868d6c6e1fbe840bbcd826b" title="preset sink samplerate ">aubio_sink_preset_samplerate</a> and <a class="el" href="sink_8h.html#ae28d51aee8cdae1d840c9a1047855081" title="preset sink channels ">aubio_sink_preset_channels</a> have been called. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="io_2test-sink_8c-example.html#a4">io/test-sink.c</a>, <a class="el" href="synth_2test-sampler_8c-example.html#a4">synth/test-sampler.c</a>, and <a class="el" href="synth_2test-wavetable_8c-example.html#a2">synth/test-wavetable.c</a>.</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
