mirror of https://github.com/hmatuschek/libsdr
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
352 lines
16 KiB
HTML
352 lines
16 KiB
HTML
<!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.9.1"/>
|
|
<title>libsdr: sdr::PortAudio Class 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="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</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">libsdr
|
|
 <span id="projectnumber">0.1.0</span>
|
|
</div>
|
|
<div id="projectbrief">A simple SDR library</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.9.1 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<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>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><b>sdr</b></li><li class="navelem"><a class="el" href="classsdr_1_1_port_audio.html">PortAudio</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="classsdr_1_1_port_audio-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">sdr::PortAudio Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>"Namespace" to collect all static, <a class="el" href="classsdr_1_1_port_audio.html" title=""Namespace" to collect all static, PortAudio related functions. ">PortAudio</a> related functions.
|
|
<a href="classsdr_1_1_port_audio.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="portaudio_8hh_source.html">portaudio.hh</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:aaec93bedb614d249c5d8f74138b55c3a"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_port_audio.html#aaec93bedb614d249c5d8f74138b55c3a">init</a> ()</td></tr>
|
|
<tr class="memdesc:aaec93bedb614d249c5d8f74138b55c3a"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the <a class="el" href="classsdr_1_1_port_audio.html" title=""Namespace" to collect all static, PortAudio related functions. ">PortAudio</a> system, must be called first. <a href="#aaec93bedb614d249c5d8f74138b55c3a">More...</a><br /></td></tr>
|
|
<tr class="separator:aaec93bedb614d249c5d8f74138b55c3a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1b2c9c26f19d788e436806675f268ec3"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_port_audio.html#a1b2c9c26f19d788e436806675f268ec3">terminate</a> ()</td></tr>
|
|
<tr class="memdesc:a1b2c9c26f19d788e436806675f268ec3"><td class="mdescLeft"> </td><td class="mdescRight">Shutdown. <a href="#a1b2c9c26f19d788e436806675f268ec3">More...</a><br /></td></tr>
|
|
<tr class="separator:a1b2c9c26f19d788e436806675f268ec3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3cdb7755e7bd2a1e750b7a717a5bd946"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_port_audio.html#a3cdb7755e7bd2a1e750b7a717a5bd946">numDevices</a> ()</td></tr>
|
|
<tr class="memdesc:a3cdb7755e7bd2a1e750b7a717a5bd946"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of devices available. <a href="#a3cdb7755e7bd2a1e750b7a717a5bd946">More...</a><br /></td></tr>
|
|
<tr class="separator:a3cdb7755e7bd2a1e750b7a717a5bd946"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1990e85770c15c10fb29ddaea82fc447"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_port_audio.html#a1990e85770c15c10fb29ddaea82fc447">defaultInputDevice</a> ()</td></tr>
|
|
<tr class="memdesc:a1990e85770c15c10fb29ddaea82fc447"><td class="mdescLeft"> </td><td class="mdescRight">Returns the index of the default input device. <a href="#a1990e85770c15c10fb29ddaea82fc447">More...</a><br /></td></tr>
|
|
<tr class="separator:a1990e85770c15c10fb29ddaea82fc447"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a05af7d9c2963d085e342f12a719c33f1"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_port_audio.html#a05af7d9c2963d085e342f12a719c33f1">defaultOutputDevice</a> ()</td></tr>
|
|
<tr class="memdesc:a05af7d9c2963d085e342f12a719c33f1"><td class="mdescLeft"> </td><td class="mdescRight">Returns the index of the default output device. <a href="#a05af7d9c2963d085e342f12a719c33f1">More...</a><br /></td></tr>
|
|
<tr class="separator:a05af7d9c2963d085e342f12a719c33f1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3e2e0df7ad08bf37b0e436ffb68c36e2"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_port_audio.html#a3e2e0df7ad08bf37b0e436ffb68c36e2">hasInputStream</a> (int idx)</td></tr>
|
|
<tr class="memdesc:a3e2e0df7ad08bf37b0e436ffb68c36e2"><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> of the given device provides an input chanel. <a href="#a3e2e0df7ad08bf37b0e436ffb68c36e2">More...</a><br /></td></tr>
|
|
<tr class="separator:a3e2e0df7ad08bf37b0e436ffb68c36e2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9c5fe4bf24d4876fe6a9a4c9c0a3f77e"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_port_audio.html#a9c5fe4bf24d4876fe6a9a4c9c0a3f77e">hasOutputStream</a> (int idx)</td></tr>
|
|
<tr class="memdesc:a9c5fe4bf24d4876fe6a9a4c9c0a3f77e"><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> of the given device provides an output chanel. <a href="#a9c5fe4bf24d4876fe6a9a4c9c0a3f77e">More...</a><br /></td></tr>
|
|
<tr class="separator:a9c5fe4bf24d4876fe6a9a4c9c0a3f77e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a179ad1349b899080303ddd535e6d23d9"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_port_audio.html#a179ad1349b899080303ddd535e6d23d9">deviceName</a> (int idx)</td></tr>
|
|
<tr class="memdesc:a179ad1349b899080303ddd535e6d23d9"><td class="mdescLeft"> </td><td class="mdescRight">Returns the device name. <a href="#a179ad1349b899080303ddd535e6d23d9">More...</a><br /></td></tr>
|
|
<tr class="separator:a179ad1349b899080303ddd535e6d23d9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>"Namespace" to collect all static, <a class="el" href="classsdr_1_1_port_audio.html" title=""Namespace" to collect all static, PortAudio related functions. ">PortAudio</a> related functions. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a1990e85770c15c10fb29ddaea82fc447"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int PortAudio::defaultInputDevice </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the index of the default input device. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a05af7d9c2963d085e342f12a719c33f1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int PortAudio::defaultOutputDevice </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the index of the default output device. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a179ad1349b899080303ddd535e6d23d9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string PortAudio::deviceName </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>idx</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the device name. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3e2e0df7ad08bf37b0e436ffb68c36e2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool PortAudio::hasInputStream </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>idx</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns <code>true</code> of the given device provides an input chanel. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9c5fe4bf24d4876fe6a9a4c9c0a3f77e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool PortAudio::hasOutputStream </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>idx</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns <code>true</code> of the given device provides an output chanel. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aaec93bedb614d249c5d8f74138b55c3a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PortAudio::init </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initializes the <a class="el" href="classsdr_1_1_port_audio.html" title=""Namespace" to collect all static, PortAudio related functions. ">PortAudio</a> system, must be called first. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3cdb7755e7bd2a1e750b7a717a5bd946"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int PortAudio::numDevices </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the number of devices available. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1b2c9c26f19d788e436806675f268ec3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PortAudio::terminate </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Shutdown. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>/Users/hannes/Uni/Elektronik/sdr/libsdr/src/<a class="el" href="portaudio_8hh_source.html">portaudio.hh</a></li>
|
|
<li>/Users/hannes/Uni/Elektronik/sdr/libsdr/src/portaudio.cc</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Tue Jun 2 2015 18:28:39 for libsdr by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|