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.
317 lines
16 KiB
HTML
317 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::PortSink 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_sink.html">PortSink</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="classsdr_1_1_port_sink-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">sdr::PortSink Class Reference<div class="ingroups"><a class="el" href="group__sinks.html">Data sinks.</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="el" href="classsdr_1_1_port_audio.html" title=""Namespace" to collect all static, PortAudio related functions. ">PortAudio</a> playback node.
|
|
<a href="classsdr_1_1_port_sink.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="portaudio_8hh_source.html">portaudio.hh</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for sdr::PortSink:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classsdr_1_1_port_sink.png" usemap="#sdr::PortSink_map" alt=""/>
|
|
<map id="sdr::PortSink_map" name="sdr::PortSink_map">
|
|
<area href="classsdr_1_1_sink_base.html" title="Basic interface of all Sinks. " alt="sdr::SinkBase" shape="rect" coords="0,0,88,24"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a07ddcbde693491c27ad2ef1831f0bc8d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_port_sink.html#a07ddcbde693491c27ad2ef1831f0bc8d">PortSink</a> ()</td></tr>
|
|
<tr class="memdesc:a07ddcbde693491c27ad2ef1831f0bc8d"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a07ddcbde693491c27ad2ef1831f0bc8d">More...</a><br /></td></tr>
|
|
<tr class="separator:a07ddcbde693491c27ad2ef1831f0bc8d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4bad3616a1b9d4fc661a0d05f82195b5"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_port_sink.html#a4bad3616a1b9d4fc661a0d05f82195b5">~PortSink</a> ()</td></tr>
|
|
<tr class="memdesc:a4bad3616a1b9d4fc661a0d05f82195b5"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a4bad3616a1b9d4fc661a0d05f82195b5">More...</a><br /></td></tr>
|
|
<tr class="separator:a4bad3616a1b9d4fc661a0d05f82195b5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a864372dbd08d8f5cc0fd8731f093fea0"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_port_sink.html#a864372dbd08d8f5cc0fd8731f093fea0">config</a> (const <a class="el" href="classsdr_1_1_config.html">Config</a> &src_cfg)</td></tr>
|
|
<tr class="memdesc:a864372dbd08d8f5cc0fd8731f093fea0"><td class="mdescLeft"> </td><td class="mdescRight">Configures the <a class="el" href="classsdr_1_1_port_audio.html" title=""Namespace" to collect all static, PortAudio related functions. ">PortAudio</a> output. <a href="#a864372dbd08d8f5cc0fd8731f093fea0">More...</a><br /></td></tr>
|
|
<tr class="separator:a864372dbd08d8f5cc0fd8731f093fea0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a080e01c07a812fa597487a88bc99b196"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_port_sink.html#a080e01c07a812fa597487a88bc99b196">handleBuffer</a> (const <a class="el" href="classsdr_1_1_raw_buffer.html">RawBuffer</a> &buffer, bool allow_overwrite)</td></tr>
|
|
<tr class="memdesc:a080e01c07a812fa597487a88bc99b196"><td class="mdescLeft"> </td><td class="mdescRight">Playback. <a href="#a080e01c07a812fa597487a88bc99b196">More...</a><br /></td></tr>
|
|
<tr class="separator:a080e01c07a812fa597487a88bc99b196"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classsdr_1_1_sink_base"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classsdr_1_1_sink_base')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classsdr_1_1_sink_base.html">sdr::SinkBase</a></td></tr>
|
|
<tr class="memitem:aaa9fb7219aa47e809ff1d62a819a2d57 inherit pub_methods_classsdr_1_1_sink_base"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_sink_base.html#aaa9fb7219aa47e809ff1d62a819a2d57">SinkBase</a> ()</td></tr>
|
|
<tr class="memdesc:aaa9fb7219aa47e809ff1d62a819a2d57 inherit pub_methods_classsdr_1_1_sink_base"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#aaa9fb7219aa47e809ff1d62a819a2d57">More...</a><br /></td></tr>
|
|
<tr class="separator:aaa9fb7219aa47e809ff1d62a819a2d57 inherit pub_methods_classsdr_1_1_sink_base"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a522205396205d6d3601da6a65bdaf75a inherit pub_methods_classsdr_1_1_sink_base"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_sink_base.html#a522205396205d6d3601da6a65bdaf75a">~SinkBase</a> ()</td></tr>
|
|
<tr class="memdesc:a522205396205d6d3601da6a65bdaf75a inherit pub_methods_classsdr_1_1_sink_base"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a522205396205d6d3601da6a65bdaf75a">More...</a><br /></td></tr>
|
|
<tr class="separator:a522205396205d6d3601da6a65bdaf75a inherit pub_methods_classsdr_1_1_sink_base"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
|
|
Protected Attributes</h2></td></tr>
|
|
<tr class="memitem:a13ef6bcf81b5d490bf33241efcb7d157"><td class="memItemLeft" align="right" valign="top">PaStream * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_port_sink.html#a13ef6bcf81b5d490bf33241efcb7d157">_stream</a></td></tr>
|
|
<tr class="memdesc:a13ef6bcf81b5d490bf33241efcb7d157"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classsdr_1_1_port_audio.html" title=""Namespace" to collect all static, PortAudio related functions. ">PortAudio</a> stream. <a href="#a13ef6bcf81b5d490bf33241efcb7d157">More...</a><br /></td></tr>
|
|
<tr class="separator:a13ef6bcf81b5d490bf33241efcb7d157"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a110e4fb11c1637fc7ff94389d684cda3"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_port_sink.html#a110e4fb11c1637fc7ff94389d684cda3">_frame_size</a></td></tr>
|
|
<tr class="memdesc:a110e4fb11c1637fc7ff94389d684cda3"><td class="mdescLeft"> </td><td class="mdescRight">The frame-size. <a href="#a110e4fb11c1637fc7ff94389d684cda3">More...</a><br /></td></tr>
|
|
<tr class="separator:a110e4fb11c1637fc7ff94389d684cda3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p><a class="el" href="classsdr_1_1_port_audio.html" title=""Namespace" to collect all static, PortAudio related functions. ">PortAudio</a> playback node. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a07ddcbde693491c27ad2ef1831f0bc8d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">PortSink::PortSink </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4bad3616a1b9d4fc661a0d05f82195b5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">PortSink::~PortSink </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Destructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a864372dbd08d8f5cc0fd8731f093fea0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PortSink::config </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsdr_1_1_config.html">Config</a> & </td>
|
|
<td class="paramname"><em>src_cfg</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Configures the <a class="el" href="classsdr_1_1_port_audio.html" title=""Namespace" to collect all static, PortAudio related functions. ">PortAudio</a> output. </p>
|
|
|
|
<p>Implements <a class="el" href="classsdr_1_1_sink_base.html#aacebf73840f06c82c438e352bf1eb75e">sdr::SinkBase</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a080e01c07a812fa597487a88bc99b196"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PortSink::handleBuffer </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsdr_1_1_raw_buffer.html">RawBuffer</a> & </td>
|
|
<td class="paramname"><em>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>allow_overwrite</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Playback. </p>
|
|
|
|
<p>Implements <a class="el" href="classsdr_1_1_sink_base.html#ae64ff25bdf0b31ec5366dab55e219088">sdr::SinkBase</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a class="anchor" id="a110e4fb11c1637fc7ff94389d684cda3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t sdr::PortSink::_frame_size</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The frame-size. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a13ef6bcf81b5d490bf33241efcb7d157"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">PaStream* sdr::PortSink::_stream</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The <a class="el" href="classsdr_1_1_port_audio.html" title=""Namespace" to collect all static, PortAudio related functions. ">PortAudio</a> stream. </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>
|