mirror of
https://github.com/thestk/stk
synced 2026-01-13 04:51:53 +00:00
297 lines
11 KiB
HTML
297 lines
11 KiB
HTML
<HTML>
|
|
<HEAD>
|
|
<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
|
|
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
|
|
</HEAD>
|
|
<BODY BGCOLOR="#FFFFFF">
|
|
<CENTER>
|
|
<img src="princeton.gif"> <img src="ccrma.gif"><P>
|
|
<a class="qindex" href="index.html">Home</a> <a class="qindex" href="information.html">Information</a> <a class="qindex" href="classes.html">Classes</a> <a class="qindex" href="download.html">Download</a> <a class="qindex" href="usage.html">Usage</a> <a class="qindex" href="maillist.html">Mail List</a> <a class="qindex" href="system.html">Requirements</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.2.8.1 -->
|
|
<h1>RtWvOut Class Reference</h1>STK realtime audio output class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="RtWvOut_8h-source.html">RtWvOut.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for RtWvOut::
|
|
<p><center><img src="classRtWvOut.gif" usemap="#RtWvOut_map" border="0"></center>
|
|
<map name="RtWvOut_map">
|
|
<area href="classWvOut.html" alt="WvOut" shape="rect" coords="0,56,61,80">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,61,24">
|
|
</map>
|
|
<a href="classRtWvOut-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
|
|
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classRtWvOut.html#a0">RtWvOut</a> (unsigned int nChannels=1, MY_FLOAT sampleRate=Stk::sampleRate(), int device=0, int bufferFrames=RT_BUFFER_SIZE, int nBuffers=4)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Default constructor.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a1" doxytag="RtWvOut::~RtWvOut"></a>
|
|
</td><td valign=bottom><a class="el" href="classRtWvOut.html#a1">~RtWvOut</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Class destructor.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtWvOut.html#a2">start</a> (void)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Start the audio output stream.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtWvOut.html#a3">stop</a> (void)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Stop the audio output stream.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a4" doxytag="RtWvOut::getFrames"></a>
|
|
unsigned long </td><td valign=bottom><a class="el" href="classRtWvOut.html#a4">getFrames</a> (void) const</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Return the number of sample frames output.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a5" doxytag="RtWvOut::getTime"></a>
|
|
MY_FLOAT </td><td valign=bottom><a class="el" href="classRtWvOut.html#a5">getTime</a> (void) const</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Return the number of seconds of data output.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtWvOut.html#a6">tick</a> (const MY_FLOAT sample)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Output a single sample to all channels in a sample frame.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtWvOut.html#a7">tick</a> (const MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Output each sample in <em>vector</em> to all channels in <em>vectorSize</em> sample frames.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtWvOut.html#a8">tickFrame</a> (const MY_FLOAT *frameVector, unsigned int frames=1)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Output the <em>frameVector</em> of sample frames of the given length.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK realtime audio output class.
|
|
<p>
|
|
This class provides a simplified interface to RtAudio for realtime audio output. It is a protected subclass of <a class="el" href="classWvOut.html">WvOut</a>.
|
|
<p>
|
|
RtWvOut supports multi-channel data in interleaved format. It is important to distinguish the <a class="el" href="classRtWvOut.html#a6">tick</a>() methods, which output single samples to all channels in a sample frame, from the <a class="el" href="classRtWvOut.html#a8">tickFrame</a>() method, which takes a pointer to multi-channel sample frame data.
|
|
<p>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
|
|
<p>
|
|
<hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a name="a0" doxytag="RtWvOut::RtWvOut"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td nowrap valign="top"><b>
|
|
RtWvOut::RtWvOut (
|
|
</b></td>
|
|
<td valign="bottom"><b>
|
|
unsigned int <em>nChannels</em> = 1,
|
|
</b></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><b>
|
|
MY_FLOAT <em>sampleRate</em> = Stk::sampleRate(),
|
|
</b></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><b>
|
|
int <em>device</em> = 0,
|
|
</b></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><b>
|
|
int <em>bufferFrames</em> = RT_BUFFER_SIZE,
|
|
</b></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><b>
|
|
int <em>nBuffers</em> = 4 )
|
|
</b></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Default constructor.
|
|
<p>
|
|
The <em>device</em> argument is passed to RtAudio during instantiation. The default value (zero) will select the default device on your system or the first device found meeting the specified parameters. On systems with multiple soundcards/devices, values greater than zero can be specified in accordance with the order that the devices are enumerated by the underlying audio API. The default buffer size of RT_BUFFER_SIZE is defined in Stk.h. An <a class="el" href="classStkError.html">StkError</a> will be thrown if an error occurs duing instantiation. </td>
|
|
</tr>
|
|
</table>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a name="a2" doxytag="RtWvOut::start"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td nowrap valign="top"><b>
|
|
void RtWvOut::start (
|
|
</b></td>
|
|
<td valign="bottom"><b>
|
|
void )
|
|
</b></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Start the audio output stream.
|
|
<p>
|
|
The stream is started automatically, if necessary, when a <a class="el" href="classRtWvOut.html#a6">tick</a>() or tickFrame method is called. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a3" doxytag="RtWvOut::stop"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td nowrap valign="top"><b>
|
|
void RtWvOut::stop (
|
|
</b></td>
|
|
<td valign="bottom"><b>
|
|
void )
|
|
</b></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Stop the audio output stream.
|
|
<p>
|
|
It may be necessary to use this method to avoid undesireable audio buffer cycling if you wish to temporarily stop audio output. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a6" doxytag="RtWvOut::tick"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td nowrap valign="top"><b>
|
|
void RtWvOut::tick (
|
|
</b></td>
|
|
<td valign="bottom"><b>
|
|
const MY_FLOAT <em>sample</em> )<code> [virtual]</code>
|
|
</b></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Output a single sample to all channels in a sample frame.
|
|
<p>
|
|
An <a class="el" href="classStkError.html">StkError</a> will be thrown if an error occurs during output.
|
|
<p>
|
|
Reimplemented from <a class="el" href="classWvOut.html#a7">WvOut</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a7" doxytag="RtWvOut::tick"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td nowrap valign="top"><b>
|
|
void RtWvOut::tick (
|
|
</b></td>
|
|
<td valign="bottom"><b>
|
|
const MY_FLOAT * <em>vector</em>,
|
|
</b></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><b>
|
|
unsigned int <em>vectorSize</em> )<code> [virtual]</code>
|
|
</b></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Output each sample in <em>vector</em> to all channels in <em>vectorSize</em> sample frames.
|
|
<p>
|
|
An <a class="el" href="classStkError.html">StkError</a> will be thrown if an error occurs during output.
|
|
<p>
|
|
Reimplemented from <a class="el" href="classWvOut.html#a8">WvOut</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a8" doxytag="RtWvOut::tickFrame"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td nowrap valign="top"><b>
|
|
void RtWvOut::tickFrame (
|
|
</b></td>
|
|
<td valign="bottom"><b>
|
|
const MY_FLOAT * <em>frameVector</em>,
|
|
</b></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><b>
|
|
unsigned int <em>frames</em> = 1 )<code> [virtual]</code>
|
|
</b></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Output the <em>frameVector</em> of sample frames of the given length.
|
|
<p>
|
|
An <a class="el" href="classStkError.html">StkError</a> will be thrown if an error occurs during output.
|
|
<p>
|
|
Reimplemented from <a class="el" href="classWvOut.html#a9">WvOut</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="RtWvOut_8h-source.html">RtWvOut.h</a></ul>
|
|
<HR>
|
|
|
|
<table>
|
|
<tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
|
|
<tr><td>©1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|