Files
stk/doc/html/structRtApi_1_1RtApiDevice.html
2013-09-29 23:41:50 +02:00

366 lines
14 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"> &nbsp; <img src="ccrma.gif"> &nbsp; <img src="mcgill.gif"><P>
<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.4.4 -->
<div class="nav">
<a class="el" href="classRtApi.html">RtApi</a>::<a class="el" href="structRtApi_1_1RtApiDevice.html">RtApiDevice</a></div>
<h1>RtApi::RtApiDevice Struct Reference</h1><!-- doxytag: class="RtApi::RtApiDevice" --><a href="structRtApi_1_1RtApiDevice-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<p>
<p>
Definition at line <a class="el" href="RtAudio_8h-source.html#l00207">207</a> of file <a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>.<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0"></a><!-- doxytag: member="RtApi::RtApiDevice::RtApiDevice" ref="a0" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtApi_1_1RtApiDevice.html#a0">RtApiDevice</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtApi_1_1RtApiDevice.html#o0">name</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtApi_1_1RtApiDevice.html#o1">probed</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o2"></a><!-- doxytag: member="RtApi::RtApiDevice::apiDeviceId" ref="o2" args="" -->
void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtApi_1_1RtApiDevice.html#o2">apiDeviceId</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtApi_1_1RtApiDevice.html#o3">maxOutputChannels</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtApi_1_1RtApiDevice.html#o4">maxInputChannels</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtApi_1_1RtApiDevice.html#o5">maxDuplexChannels</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtApi_1_1RtApiDevice.html#o6">minOutputChannels</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtApi_1_1RtApiDevice.html#o7">minInputChannels</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtApi_1_1RtApiDevice.html#o8">minDuplexChannels</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtApi_1_1RtApiDevice.html#o9">hasDuplexSupport</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtApi_1_1RtApiDevice.html#o10">isDefault</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector&lt; int &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtApi_1_1RtApiDevice.html#o11">sampleRates</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">RtAudioFormat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtApi_1_1RtApiDevice.html#o12">nativeFormats</a></td></tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="o0"></a><!-- doxytag: member="RtApi::RtApiDevice::name" ref="o0" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">std::string <a class="el" href="structRtApi_1_1RtApiDevice.html#o0">RtApi::RtApiDevice::name</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Character string device identifier.
<p>
Definition at line <a class="el" href="RtAudio_8h-source.html#l00208">208</a> of file <a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>. </td>
</tr>
</table>
<a class="anchor" name="o1"></a><!-- doxytag: member="RtApi::RtApiDevice::probed" ref="o1" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool <a class="el" href="structRtApi_1_1RtApiDevice.html#o1">RtApi::RtApiDevice::probed</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
true if the device capabilities were successfully probed.
<p>
Definition at line <a class="el" href="RtAudio_8h-source.html#l00209">209</a> of file <a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>. </td>
</tr>
</table>
<a class="anchor" name="o3"></a><!-- doxytag: member="RtApi::RtApiDevice::maxOutputChannels" ref="o3" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int <a class="el" href="structRtApi_1_1RtApiDevice.html#o3">RtApi::RtApiDevice::maxOutputChannels</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Maximum output channels supported by device.
<p>
Definition at line <a class="el" href="RtAudio_8h-source.html#l00211">211</a> of file <a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>. </td>
</tr>
</table>
<a class="anchor" name="o4"></a><!-- doxytag: member="RtApi::RtApiDevice::maxInputChannels" ref="o4" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int <a class="el" href="structRtApi_1_1RtApiDevice.html#o4">RtApi::RtApiDevice::maxInputChannels</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Maximum input channels supported by device.
<p>
Definition at line <a class="el" href="RtAudio_8h-source.html#l00212">212</a> of file <a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>. </td>
</tr>
</table>
<a class="anchor" name="o5"></a><!-- doxytag: member="RtApi::RtApiDevice::maxDuplexChannels" ref="o5" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int <a class="el" href="structRtApi_1_1RtApiDevice.html#o5">RtApi::RtApiDevice::maxDuplexChannels</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Maximum simultaneous input/output channels supported by device.
<p>
Definition at line <a class="el" href="RtAudio_8h-source.html#l00213">213</a> of file <a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>. </td>
</tr>
</table>
<a class="anchor" name="o6"></a><!-- doxytag: member="RtApi::RtApiDevice::minOutputChannels" ref="o6" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int <a class="el" href="structRtApi_1_1RtApiDevice.html#o6">RtApi::RtApiDevice::minOutputChannels</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Minimum output channels supported by device.
<p>
Definition at line <a class="el" href="RtAudio_8h-source.html#l00214">214</a> of file <a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>. </td>
</tr>
</table>
<a class="anchor" name="o7"></a><!-- doxytag: member="RtApi::RtApiDevice::minInputChannels" ref="o7" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int <a class="el" href="structRtApi_1_1RtApiDevice.html#o7">RtApi::RtApiDevice::minInputChannels</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Minimum input channels supported by device.
<p>
Definition at line <a class="el" href="RtAudio_8h-source.html#l00215">215</a> of file <a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>. </td>
</tr>
</table>
<a class="anchor" name="o8"></a><!-- doxytag: member="RtApi::RtApiDevice::minDuplexChannels" ref="o8" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int <a class="el" href="structRtApi_1_1RtApiDevice.html#o8">RtApi::RtApiDevice::minDuplexChannels</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Minimum simultaneous input/output channels supported by device.
<p>
Definition at line <a class="el" href="RtAudio_8h-source.html#l00216">216</a> of file <a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>. </td>
</tr>
</table>
<a class="anchor" name="o9"></a><!-- doxytag: member="RtApi::RtApiDevice::hasDuplexSupport" ref="o9" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool <a class="el" href="structRtApi_1_1RtApiDevice.html#o9">RtApi::RtApiDevice::hasDuplexSupport</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
true if device supports duplex mode.
<p>
Definition at line <a class="el" href="RtAudio_8h-source.html#l00217">217</a> of file <a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>. </td>
</tr>
</table>
<a class="anchor" name="o10"></a><!-- doxytag: member="RtApi::RtApiDevice::isDefault" ref="o10" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool <a class="el" href="structRtApi_1_1RtApiDevice.html#o10">RtApi::RtApiDevice::isDefault</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
true if this is the default output or input device.
<p>
Definition at line <a class="el" href="RtAudio_8h-source.html#l00218">218</a> of file <a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>. </td>
</tr>
</table>
<a class="anchor" name="o11"></a><!-- doxytag: member="RtApi::RtApiDevice::sampleRates" ref="o11" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">std::vector&lt;int&gt; <a class="el" href="structRtApi_1_1RtApiDevice.html#o11">RtApi::RtApiDevice::sampleRates</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Supported sample rates.
<p>
Definition at line <a class="el" href="RtAudio_8h-source.html#l00219">219</a> of file <a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>. </td>
</tr>
</table>
<a class="anchor" name="o12"></a><!-- doxytag: member="RtApi::RtApiDevice::nativeFormats" ref="o12" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">RtAudioFormat <a class="el" href="structRtApi_1_1RtApiDevice.html#o12">RtApi::RtApiDevice::nativeFormats</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Bit mask of supported data formats.
<p>
Definition at line <a class="el" href="RtAudio_8h-source.html#l00220">220</a> of file <a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>. </td>
</tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="RtAudio_8h-source.html">RtAudio.h</a></ul>
<HR>
<table>
<tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<tr><td>&copy;1995-2007 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>