diff options
Diffstat (limited to 'html/structPaStreamParameters.html')
| -rw-r--r-- | html/structPaStreamParameters.html | 176 |
1 files changed, 176 insertions, 0 deletions
diff --git a/html/structPaStreamParameters.html b/html/structPaStreamParameters.html new file mode 100644 index 000000000..419cf54ae --- /dev/null +++ b/html/structPaStreamParameters.html @@ -0,0 +1,176 @@ +<!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>navit: 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="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</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">navit +  <span id="projectnumber">0.5.1-trunk</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><a href="namespaces.html"><span>Namespaces</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 id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('structPaStreamParameters.html','');}); +</script> +<div id="doc-content"> +<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="portaudio19_8h_source.html">portaudio19.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="portaudio19_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="portaudio19_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="portaudio19_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> +</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="portaudio19_8h.html#a0b62d4b74b5d3d88368e9e4c0b8b2dc7">Pa_ReadStream()</a> or <a class="el" href="portaudio19_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> + +</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="portaudio19_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="portaudio19_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> + +</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> + +</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="portaudio19_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="portaudio19_8h.html#a075a6efb503a728213bdae24347ed27d">Pa_WriteStream()</a>. It may be any of the formats described by the PaSampleFormat enumeration. </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="portaudio19_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 practial value - ie to provide an equal or higher latency than suggestedLatency wherever possibe. 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="portaudio19_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> + +</div> +</div> +<hr/>The documentation for this struct was generated from the following file:<ul> +<li>support/espeak/<a class="el" href="portaudio19_8h_source.html">portaudio19.h</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="structPaStreamParameters.html">PaStreamParameters</a></li> + <li class="footer">Generated by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> + </ul> +</div> +</body> +</html> |