<!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"/>
<title>GNU Radio 3.3.0 C++ API: audio_portaudio_sink Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="contents">
<h1>audio_portaudio_sink Class Reference</h1><!-- doxytag: class="audio_portaudio_sink" --><!-- doxytag: inherits="gr_sync_block" -->
<p><code>#include <<a class="el" href="audio__portaudio__sink_8h_source.html">audio_portaudio_sink.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for audio_portaudio_sink:</div>
<div class="dynsection">
<div class="center"><img src="classaudio__portaudio__sink__inherit__graph.png" border="0" usemap="#audio__portaudio__sink_inherit__map" alt="Inheritance graph"/></div>
<map name="audio__portaudio__sink_inherit__map" id="audio__portaudio__sink_inherit__map">
<area shape="rect" id="node2" href="classgr__sync__block.html" title="synchronous 1:1 input to output with historyOverride work to provide the signal processing..." alt="" coords="24,315,131,344"/><area shape="rect" id="node4" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing..." alt="" coords="43,237,112,267"/><area shape="rect" id="node6" href="classgr__basic__block.html" title="The abstract base class for all signal processing blocks.Basic blocks are the bare..." alt="" coords="23,160,132,189"/><area shape="rect" id="node8" href="classgr__msg__accepter.html" title="Accepts messages and inserts them into a message queue, then notifies subclass gr_basic_block..." alt="" coords="16,83,139,112"/><area shape="rect" id="node10" href="classgruel_1_1msg__accepter.html" title="Virtual base class that accepts messages." alt="" coords="8,5,147,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classaudio__portaudio__sink-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__portaudio__sink.html#a545391fdb3bc4313282dfe9709bc2e07">~audio_portaudio_sink</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__portaudio__sink.html#a03c5b233e14c6afd06897383ee6128a1">check_topology</a> (int ninputs, int noutputs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Confirm that ninputs and noutputs is an acceptable combination. <a href="#a03c5b233e14c6afd06897383ee6128a1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__portaudio__sink.html#ae2bfcbeaa2eed543014bcb2057f5eb45">work</a> (int noutput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items, <a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">just like <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197" title="compute output items from input items">gr_block::general_work</a>, only this arranges to call consume_each for you <a href="#ae2bfcbeaa2eed543014bcb2057f5eb45"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__portaudio__sink.html#a387f47e510264f54f764e9bc5a734148">audio_portaudio_sink</a> (int sampling_rate, const std::string device_name, <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> ok_to_block)</td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PaStreamCallback </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__portaudio__sink.html#aea834c6ebe46a1635d5a8fe5446e3b18">portaudio_sink_callback</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">audio_portaudio_sink_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__portaudio__sink.html#a038859035fd37affccce1308a8005a59">audio_portaudio_make_sink</a> (int sampling_rate, const std::string device_name, <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> ok_to_block)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">PORTAUDIO audio sink. <a href="#a038859035fd37affccce1308a8005a59"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>\ Audio sink using PORTAUDIO</p>
<p>Input samples must be in the range [-1,1]. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a387f47e510264f54f764e9bc5a734148"></a><!-- doxytag: member="audio_portaudio_sink::audio_portaudio_sink" ref="a387f47e510264f54f764e9bc5a734148" args="(int sampling_rate, const std::string device_name, bool ok_to_block)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">audio_portaudio_sink::audio_portaudio_sink </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>sampling_rate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string </td>
<td class="paramname"> <em>device_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td>
<td class="paramname"> <em>ok_to_block</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a545391fdb3bc4313282dfe9709bc2e07"></a><!-- doxytag: member="audio_portaudio_sink::~audio_portaudio_sink" ref="a545391fdb3bc4313282dfe9709bc2e07" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">audio_portaudio_sink::~audio_portaudio_sink </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a03c5b233e14c6afd06897383ee6128a1"></a><!-- doxytag: member="audio_portaudio_sink::check_topology" ref="a03c5b233e14c6afd06897383ee6128a1" args="(int ninputs, int noutputs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> audio_portaudio_sink::check_topology </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>ninputs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>noutputs</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Confirm that ninputs and noutputs is an acceptable combination. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ninputs</em> </td><td>number of input streams connected </td></tr>
<tr><td valign="top"></td><td valign="top"><em>noutputs</em> </td><td>number of output streams connected</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if this is a valid configuration for this block.</dd></dl>
<p>This function is called by the runtime system whenever the topology changes. Most classes do not need to override this. This check is in addition to the constraints specified by the input and output gr_io_signatures. </p>
<p>Reimplemented from <a class="el" href="classgr__basic__block.html#a50a714df9c3ce8c03854a09ac84e589b">gr_basic_block</a>.</p>
</div>
</div>
<a class="anchor" id="ae2bfcbeaa2eed543014bcb2057f5eb45"></a><!-- doxytag: member="audio_portaudio_sink::work" ref="ae2bfcbeaa2eed543014bcb2057f5eb45" args="(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int audio_portaudio_sink::work </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>noutput_items</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> & </td>
<td class="paramname"> <em>input_items</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> & </td>
<td class="paramname"> <em>output_items</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>just like <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197" title="compute output items from input items">gr_block::general_work</a>, only this arranges to call consume_each for you </p>
<p>The user must override work to define the signal processing code </p>
<p>Implements <a class="el" href="classgr__sync__block.html#a0c523f4285a6eb690f677ee6295ab117">gr_sync_block</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a038859035fd37affccce1308a8005a59"></a><!-- doxytag: member="audio_portaudio_sink::audio_portaudio_make_sink" ref="a038859035fd37affccce1308a8005a59" args="(int sampling_rate, const std::string device_name, bool ok_to_block)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">audio_portaudio_sink_sptr</a> audio_portaudio_make_sink </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>sampling_rate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string </td>
<td class="paramname"> <em>device_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td>
<td class="paramname"> <em>ok_to_block</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>PORTAUDIO audio sink. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sampling_rate</em> </td><td>sampling rate in Hz </td></tr>
<tr><td valign="top"></td><td valign="top"><em>device_name</em> </td><td>PORTAUDIO device name, e.g., "pa:" </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ok_to_block</em> </td><td>true if it's ok for us to block </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aea834c6ebe46a1635d5a8fe5446e3b18"></a><!-- doxytag: member="audio_portaudio_sink::portaudio_sink_callback" ref="aea834c6ebe46a1635d5a8fe5446e3b18" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend PaStreamCallback portaudio_sink_callback<code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="audio__portaudio__sink_8h_source.html">audio_portaudio_sink.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:52:32 2010 for GNU Radio 3.3.0 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
