/usr/share/doc/portaudio19-doc/doc/html/structPaStreamParameters.html is in portaudio19-doc 19+svn20140130-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 | <!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.6"/>
<title>PortAudio: PaStreamParameters Struct 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
 <span id="projectnumber">2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">PaStreamParameters Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="portaudio_8h_source.html">portaudio.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aebaf648b4d11dd1252a747b76b8da084"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPaStreamParameters.html#aebaf648b4d11dd1252a747b76b8da084">device</a></td></tr>
<tr class="separator:aebaf648b4d11dd1252a747b76b8da084"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a861ff361da71fc2572dd356c9c9878ca"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structPaStreamParameters.html#a861ff361da71fc2572dd356c9c9878ca">channelCount</a></td></tr>
<tr class="separator:a861ff361da71fc2572dd356c9c9878ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad8d2d3063757b812f9e5f8709f41052b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPaStreamParameters.html#ad8d2d3063757b812f9e5f8709f41052b">sampleFormat</a></td></tr>
<tr class="separator:ad8d2d3063757b812f9e5f8709f41052b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa1e80ac0551162fd091db8936ccbe9a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="portaudio_8h.html#af17a7e6d0471a23071acf8dbd7bbe4bd">PaTime</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPaStreamParameters.html#aa1e80ac0551162fd091db8936ccbe9a0">suggestedLatency</a></td></tr>
<tr class="separator:aa1e80ac0551162fd091db8936ccbe9a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aff01b9fa0710ad1654471e97665c06a9"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPaStreamParameters.html#aff01b9fa0710ad1654471e97665c06a9">hostApiSpecificStreamInfo</a></td></tr>
<tr class="separator:aff01b9fa0710ad1654471e97665c06a9"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Parameters for one direction (input or output) of a stream. </p>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00487">487</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a861ff361da71fc2572dd356c9c9878ca"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int PaStreamParameters::channelCount</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of channels of sound to be delivered to the stream callback or accessed by <a class="el" href="portaudio_8h.html#a0b62d4b74b5d3d88368e9e4c0b8b2dc7">Pa_ReadStream()</a> or <a class="el" href="portaudio_8h.html#a075a6efb503a728213bdae24347ed27d">Pa_WriteStream()</a>. It can range from 1 to the value of maxInputChannels in the <a class="el" href="structPaDeviceInfo.html">PaDeviceInfo</a> record for the device specified by the device parameter. </p>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00502">502</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="aebaf648b4d11dd1252a747b76b8da084"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#ad79317e65bde63d76c4b8e711ac5a361">PaDeviceIndex</a> PaStreamParameters::device</td>
</tr>
</table>
</div><div class="memdoc">
<p>A valid device index in the range 0 to (<a class="el" href="portaudio_8h.html#acfe4d3c5ec1a343f459981bfa2057f8d">Pa_GetDeviceCount()</a>-1) specifying the device to be used or the special constant paUseHostApiSpecificDeviceSpecification which indicates that the actual device(s) to use are specified in hostApiSpecificStreamInfo. This field must not be set to paNoDevice. </p>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00495">495</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="aff01b9fa0710ad1654471e97665c06a9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* PaStreamParameters::hostApiSpecificStreamInfo</td>
</tr>
</table>
</div><div class="memdoc">
<p>An optional pointer to a host api specific data structure containing additional information for device setup and/or stream processing. hostApiSpecificStreamInfo is never required for correct operation, if not used it should be set to NULL. </p>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00528">528</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad8d2d3063757b812f9e5f8709f41052b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#a4582d93c2c2e60e12be3d74c5fe00b96">PaSampleFormat</a> PaStreamParameters::sampleFormat</td>
</tr>
</table>
</div><div class="memdoc">
<p>The sample format of the buffer provided to the stream callback, a_ReadStream() or <a class="el" href="portaudio_8h.html#a075a6efb503a728213bdae24347ed27d">Pa_WriteStream()</a>. It may be any of the formats described by the PaSampleFormat enumeration. </p>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00508">508</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa1e80ac0551162fd091db8936ccbe9a0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="portaudio_8h.html#af17a7e6d0471a23071acf8dbd7bbe4bd">PaTime</a> PaStreamParameters::suggestedLatency</td>
</tr>
</table>
</div><div class="memdoc">
<p>The desired latency in seconds. Where practical, implementations should configure their latency based on these parameters, otherwise they may choose the closest viable latency instead. Unless the suggested latency is greater than the absolute upper limit for the device implementations should round the suggestedLatency up to the next practical value - ie to provide an equal or higher latency than suggestedLatency wherever possible. Actual latency values for an open stream may be retrieved using the inputLatency and outputLatency fields of the <a class="el" href="structPaStreamInfo.html">PaStreamInfo</a> structure returned by <a class="el" href="portaudio_8h.html#a3d9c4cbda4e9f381b76f287c3de8a758">Pa_GetStreamInfo()</a>. </p>
<dl class="section see"><dt>See Also</dt><dd>default*Latency in <a class="el" href="structPaDeviceInfo.html">PaDeviceInfo</a>, *Latency in <a class="el" href="structPaStreamInfo.html">PaStreamInfo</a> </dd></dl>
<p>Definition at line <a class="el" href="portaudio_8h_source.html#l00521">521</a> of file <a class="el" href="portaudio_8h_source.html">portaudio.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="portaudio_8h_source.html">portaudio.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Feb 25 2014 21:08:45 for PortAudio by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
|