<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Audaspace: IWriter Interface 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>
<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">Audaspace
 <span id="projectnumber">1.3.0</span>
</div>
<div id="projectbrief">A high level audio library.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classIWriter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">IWriter Interface Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>This class represents a sound sink where audio data can be written to.
<a href="classIWriter.html#details">More...</a></p>
<p><code>#include <<a class="el" href="IWriter_8h_source.html">IWriter.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for IWriter:</div>
<div class="dyncontent">
<div class="center"><img src="classIWriter__inherit__graph.png" border="0" usemap="#IWriter_inherit__map" alt="Inheritance graph"/></div>
<map name="IWriter_inherit__map" id="IWriter_inherit__map">
<area shape="rect" title="This class represents a sound sink where audio data can be written to." alt="" coords="97,5,162,32"/>
<area shape="rect" href="classFFMPEGWriter.html" title="This class writes a sound file via ffmpeg." alt="" coords="5,80,120,107"/>
<area shape="rect" href="classSndFileWriter.html" title="This class writes a sound file via libsndfile." alt="" coords="144,80,251,107"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8425be5ece85b68c0a61d6e05f13e544"><td class="memItemLeft" align="right" valign="top"><a id="a8425be5ece85b68c0a61d6e05f13e544"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classIWriter.html#a8425be5ece85b68c0a61d6e05f13e544">~IWriter</a> ()</td></tr>
<tr class="memdesc:a8425be5ece85b68c0a61d6e05f13e544"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the writer. <br /></td></tr>
<tr class="separator:a8425be5ece85b68c0a61d6e05f13e544"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a58639a6882bcc9204d507f7d0e301df4"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classIWriter.html#a58639a6882bcc9204d507f7d0e301df4">getPosition</a> () const =0</td></tr>
<tr class="memdesc:a58639a6882bcc9204d507f7d0e301df4"><td class="mdescLeft"> </td><td class="mdescRight">Returns how many samples have been written so far. <a href="#a58639a6882bcc9204d507f7d0e301df4">More...</a><br /></td></tr>
<tr class="separator:a58639a6882bcc9204d507f7d0e301df4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad76314294b41de306cc7de82909347b9"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structDeviceSpecs.html">DeviceSpecs</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIWriter.html#ad76314294b41de306cc7de82909347b9">getSpecs</a> () const =0</td></tr>
<tr class="memdesc:ad76314294b41de306cc7de82909347b9"><td class="mdescLeft"> </td><td class="mdescRight">Returns the specification of the audio data being written into the sink. <a href="#ad76314294b41de306cc7de82909347b9">More...</a><br /></td></tr>
<tr class="separator:ad76314294b41de306cc7de82909347b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5cb757ee0654bf29f9ac2419911210f5"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIWriter.html#a5cb757ee0654bf29f9ac2419911210f5">write</a> (unsigned int length, <a class="el" href="Audaspace_8h.html#aa0798f7ea0975b143a1d9deac8c05d43">sample_t</a> *buffer)=0</td></tr>
<tr class="memdesc:a5cb757ee0654bf29f9ac2419911210f5"><td class="mdescLeft"> </td><td class="mdescRight">Request to write the next length samples out into the sink. <a href="#a5cb757ee0654bf29f9ac2419911210f5">More...</a><br /></td></tr>
<tr class="separator:a5cb757ee0654bf29f9ac2419911210f5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class represents a sound sink where audio data can be written to. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a58639a6882bcc9204d507f7d0e301df4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58639a6882bcc9204d507f7d0e301df4">◆ </a></span>getPosition()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int IWriter::getPosition </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns how many samples have been written so far. </p>
<dl class="section return"><dt>Returns</dt><dd>The writing position as sample count. May be negative if unknown. </dd></dl>
<p>Implemented in <a class="el" href="classFFMPEGWriter.html#a8133d1bc1e9119bb015b8111f377ef2d">FFMPEGWriter</a>, and <a class="el" href="classSndFileWriter.html#a7d2846784a3b7e40a21ee3eda70470ef">SndFileWriter</a>.</p>
</div>
</div>
<a id="ad76314294b41de306cc7de82909347b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad76314294b41de306cc7de82909347b9">◆ </a></span>getSpecs()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structDeviceSpecs.html">DeviceSpecs</a> IWriter::getSpecs </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the specification of the audio data being written into the sink. </p>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="structDeviceSpecs.html" title="Specification of a sound device.">DeviceSpecs</a> structure. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>Regardless of the format the input still has to be float! </dd></dl>
<p>Implemented in <a class="el" href="classFFMPEGWriter.html#a22e69fd3b188223f7e87de51eeab053b">FFMPEGWriter</a>, and <a class="el" href="classSndFileWriter.html#a77321e296822ce806bdab5ea80ad0185">SndFileWriter</a>.</p>
</div>
</div>
<a id="a5cb757ee0654bf29f9ac2419911210f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5cb757ee0654bf29f9ac2419911210f5">◆ </a></span>write()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void IWriter::write </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="Audaspace_8h.html#aa0798f7ea0975b143a1d9deac8c05d43">sample_t</a> * </td>
<td class="paramname"><em>buffer</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Request to write the next length samples out into the sink. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">length</td><td>The count of samples to write. </td></tr>
<tr><td class="paramname">buffer</td><td>The pointer to the buffer containing the data. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classFFMPEGWriter.html#ae18ebc0db3e2161a9fdd91c2118cc49f">FFMPEGWriter</a>, and <a class="el" href="classSndFileWriter.html#a464c3b0476914ff85937e29ccec73e4e">SndFileWriter</a>.</p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>file/<a class="el" href="IWriter_8h_source.html">IWriter.h</a></li>
</ul>
</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.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-release
>
by-pkgid
>
4f48f620eaa1d8b8f904a92a0540d40f
>
files
>
1092
