Sophie

Sophie

distrib > Fedora > 18 > x86_64 > media > updates > by-pkgid > 866ae5f99ebc53131e4da7c8445c0009 > files > 152

portaudio-devel-19-16.fc18.i686.rpm

<!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.1"/>
<title>PortAudio: pa_win_wmme.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="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">PortAudio
   &#160;<span id="projectnumber">2.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">pa_win_wmme.h File Reference<div class="ingroups"><a class="el" href="group__public__header.html">Public API definitions for users of PortAudio</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>WMME-specific PortAudio API extension header file.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="portaudio_8h_source.html">portaudio.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="pa__win__waveformat_8h_source.html">pa_win_waveformat.h</a>&quot;</code><br/>
</div>
<p><a href="pa__win__wmme_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="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPaWinMmeDeviceAndChannelCount.html">PaWinMmeDeviceAndChannelCount</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPaWinMmeStreamInfo.html">PaWinMmeStreamInfo</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a730c8a906c8991134bbb419cff40a0a0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a730c8a906c8991134bbb419cff40a0a0"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>paWinMmeUseLowLevelLatencyParameters</b>&#160;&#160;&#160;(0x01)</td></tr>
<tr class="separator:a730c8a906c8991134bbb419cff40a0a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6e9b45c6ff5fd7442e532dab6fc3c93"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae6e9b45c6ff5fd7442e532dab6fc3c93"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>paWinMmeUseMultipleDevices</b>&#160;&#160;&#160;(0x02)  /* use mme specific multiple device feature */</td></tr>
<tr class="separator:ae6e9b45c6ff5fd7442e532dab6fc3c93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a7c36329821a882b95b3e9a0d9016a9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a7c36329821a882b95b3e9a0d9016a9"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>paWinMmeUseChannelMask</b>&#160;&#160;&#160;(0x04)</td></tr>
<tr class="separator:a9a7c36329821a882b95b3e9a0d9016a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89f82596ff104d9b994e97af07022a34"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a89f82596ff104d9b994e97af07022a34"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>paWinMmeDontThrottleOverloadedProcessingThread</b>&#160;&#160;&#160;(0x08)</td></tr>
<tr class="separator:a89f82596ff104d9b994e97af07022a34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0253c24374587b8c74029287d5146d36"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0253c24374587b8c74029287d5146d36"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>paWinMmeWaveFormatDolbyAc3Spdif</b>&#160;&#160;&#160;(0x10)</td></tr>
<tr class="separator:a0253c24374587b8c74029287d5146d36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f5896b4c9be407cff3e067210a74784"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f5896b4c9be407cff3e067210a74784"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>paWinMmeWaveFormatWmaSpdif</b>&#160;&#160;&#160;(0x20)</td></tr>
<tr class="separator:a1f5896b4c9be407cff3e067210a74784"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:af39aa9c30a3ee4628622fca2128f4202"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af39aa9c30a3ee4628622fca2128f4202"></a>
typedef struct <br class="typebreak"/>
<a class="el" href="structPaWinMmeDeviceAndChannelCount.html">PaWinMmeDeviceAndChannelCount</a>&#160;</td><td class="memItemRight" valign="bottom"><b>PaWinMmeDeviceAndChannelCount</b></td></tr>
<tr class="separator:af39aa9c30a3ee4628622fca2128f4202"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a128685b5547c0b4ad8fc6b5ccbb0ef"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a128685b5547c0b4ad8fc6b5ccbb0ef"></a>
typedef struct <a class="el" href="structPaWinMmeStreamInfo.html">PaWinMmeStreamInfo</a>&#160;</td><td class="memItemRight" valign="bottom"><b>PaWinMmeStreamInfo</b></td></tr>
<tr class="separator:a7a128685b5547c0b4ad8fc6b5ccbb0ef"><td class="memSeparator" colspan="2">&#160;</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:aaa47c87fb51f29024ad2db1c3ba85db5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pa__win__wmme_8h.html#aaa47c87fb51f29024ad2db1c3ba85db5">PaWinMME_GetStreamInputHandleCount</a> (<a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *stream)</td></tr>
<tr class="separator:aaa47c87fb51f29024ad2db1c3ba85db5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67a4c1e3b4d2a5830c11bc1c4e7d2caa"><td class="memItemLeft" align="right" valign="top">HWAVEIN&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pa__win__wmme_8h.html#a67a4c1e3b4d2a5830c11bc1c4e7d2caa">PaWinMME_GetStreamInputHandle</a> (<a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *stream, int handleIndex)</td></tr>
<tr class="separator:a67a4c1e3b4d2a5830c11bc1c4e7d2caa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8eae212f83c77fc92eb3e8e95216ede7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pa__win__wmme_8h.html#a8eae212f83c77fc92eb3e8e95216ede7">PaWinMME_GetStreamOutputHandleCount</a> (<a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *stream)</td></tr>
<tr class="separator:a8eae212f83c77fc92eb3e8e95216ede7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7311604a84f712ef70fe90510f96be6"><td class="memItemLeft" align="right" valign="top">HWAVEOUT&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pa__win__wmme_8h.html#ac7311604a84f712ef70fe90510f96be6">PaWinMME_GetStreamOutputHandle</a> (<a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *stream, int handleIndex)</td></tr>
<tr class="separator:ac7311604a84f712ef70fe90510f96be6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>WMME-specific PortAudio API extension header file. </p>

<p>Definition in file <a class="el" href="pa__win__wmme_8h_source.html">pa_win_wmme.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a67a4c1e3b4d2a5830c11bc1c4e7d2caa"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">HWAVEIN PaWinMME_GetStreamInputHandle </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *&#160;</td>
          <td class="paramname"><em>stream</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>handleIndex</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Retrieve a wave in handle used by a PortAudio WinMME stream.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">stream</td><td>The stream to query. </td></tr>
    <tr><td class="paramname">handleIndex</td><td>The zero based index of the wave in handle to retrieve. This should be in the range [0, PaWinMME_GetStreamInputHandleCount(stream)-1].</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A valid wave in handle, or NULL if an error occurred.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="pa__win__wmme_8h.html#a67a4c1e3b4d2a5830c11bc1c4e7d2caa">PaWinMME_GetStreamInputHandle</a> </dd></dl>

</div>
</div>
<a class="anchor" id="aaa47c87fb51f29024ad2db1c3ba85db5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int PaWinMME_GetStreamInputHandleCount </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *&#160;</td>
          <td class="paramname"><em>stream</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Retrieve the number of wave in handles used by a PortAudio WinMME stream. Returns zero if the stream is output only.</p>
<dl class="section return"><dt>Returns</dt><dd>A non-negative value indicating the number of wave in handles or, a PaErrorCode (which are always negative) if PortAudio is not initialized or an error is encountered.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="pa__win__wmme_8h.html#a67a4c1e3b4d2a5830c11bc1c4e7d2caa">PaWinMME_GetStreamInputHandle</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ac7311604a84f712ef70fe90510f96be6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">HWAVEOUT PaWinMME_GetStreamOutputHandle </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *&#160;</td>
          <td class="paramname"><em>stream</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>handleIndex</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Retrieve a wave out handle used by a PortAudio WinMME stream.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">stream</td><td>The stream to query. </td></tr>
    <tr><td class="paramname">handleIndex</td><td>The zero based index of the wave out handle to retrieve. This should be in the range [0, PaWinMME_GetStreamOutputHandleCount(stream)-1].</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A valid wave out handle, or NULL if an error occurred.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="pa__win__wmme_8h.html#a8eae212f83c77fc92eb3e8e95216ede7">PaWinMME_GetStreamOutputHandleCount</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a8eae212f83c77fc92eb3e8e95216ede7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int PaWinMME_GetStreamOutputHandleCount </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="portaudio_8h.html#a19874734f89958fccf86785490d53b4c">PaStream</a> *&#160;</td>
          <td class="paramname"><em>stream</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Retrieve the number of wave out handles used by a PortAudio WinMME stream. Returns zero if the stream is input only.</p>
<dl class="section return"><dt>Returns</dt><dd>A non-negative value indicating the number of wave out handles or, a PaErrorCode (which are always negative) if PortAudio is not initialized or an error is encountered.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="pa__win__wmme_8h.html#ac7311604a84f712ef70fe90510f96be6">PaWinMME_GetStreamOutputHandle</a> </dd></dl>

</div>
</div>
</div><!-- contents -->
<hr size="1"><address style="text-align: right;"><small>Generated for PortAudio by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a>1.8.3.1</small></address>
</body>
</html>