<!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.2.2 C++ API: audio_osx_sink Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GNU Radio 3.2.2 C++ API</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classaudio__osx__sink.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<h1>audio_osx_sink Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="audio_osx_sink" --><!-- doxytag: inherits="gr_sync_block" -->
<p>audio sink using OSX
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="audio__osx__sink_8h_source.html">audio_osx_sink.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for audio_osx_sink:</div>
<div class="dyncontent">
<div class="center"><img src="classaudio__osx__sink__inherit__graph.png" border="0" usemap="#audio__osx__sink_inherit__map" alt="Inheritance graph"/></div>
<map name="audio__osx__sink_inherit__map" id="audio__osx__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 implementa..." alt="" coords="8,160,115,189"/><area shape="rect" id="node4" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing flow is cons..." alt="" coords="27,83,96,112"/><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 abstraction of an ..." alt="" coords="7,5,116,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classaudio__osx__sink-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
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__osx__sink.html#aa62867a778efec48976d1537bcb48a9d">~audio_osx_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__osx__sink.html#a53164060127827d69af2c1298fddb156">IsRunning</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__osx__sink.html#af4004bd08b0577701983ba0e2029bd48">start</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called to enable drivers, etc for i/o devices. <a href="#af4004bd08b0577701983ba0e2029bd48"></a><br/></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__osx__sink.html#af57ebe4d74be578d0357e9a7171eb785">stop</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called to disable drivers, etc for i/o devices. <a href="#af57ebe4d74be578d0357e9a7171eb785"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__osx__sink.html#a38c0585e65251d0f5b399751ebf36d17">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="#a38c0585e65251d0f5b399751ebf36d17"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
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__osx__sink.html#abb21a07565b78ce7a861d3c8ee4c4db0">audio_osx_sink</a> (int sample_rate=44100, const std::string device_name="2", <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> do_block=true, int channel_config=-1, int max_sample_count=-1)</td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">audio_osx_sink_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__osx__sink.html#aef50e214a04a63ddfb094944486caee9">audio_osx_make_sink</a> (int sample_rate, const std::string device_name, <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> do_block, int channel_config, int max_sample_count)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>audio sink using OSX </p>
<p>input signature is one or two streams of floats. Input samples must be in the range [-1,1]. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="abb21a07565b78ce7a861d3c8ee4c4db0"></a><!-- doxytag: member="audio_osx_sink::audio_osx_sink" ref="abb21a07565b78ce7a861d3c8ee4c4db0" args="(int sample_rate=44100, const std::string device_name="2", bool do_block=true, int channel_config=-1, int max_sample_count=-1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">audio_osx_sink::audio_osx_sink </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>sample_rate</em> = <code>44100</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string </td>
<td class="paramname"><em>device_name</em> = <code>"2"</code>, </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>do_block</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>channel_config</em> = <code>-1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>max_sample_count</em> = <code>-1</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa62867a778efec48976d1537bcb48a9d"></a><!-- doxytag: member="audio_osx_sink::~audio_osx_sink" ref="aa62867a778efec48976d1537bcb48a9d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">audio_osx_sink::~audio_osx_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="a53164060127827d69af2c1298fddb156"></a><!-- doxytag: member="audio_osx_sink::IsRunning" ref="a53164060127827d69af2c1298fddb156" args="()" -->
<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_osx_sink::IsRunning </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af4004bd08b0577701983ba0e2029bd48"></a><!-- doxytag: member="audio_osx_sink::start" ref="af4004bd08b0577701983ba0e2029bd48" args="()" -->
<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_osx_sink::start </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called to enable drivers, etc for i/o devices. </p>
<p>This allows a block to enable an associated driver to begin transfering data just before we start to execute the scheduler. The end result is that this reduces latency in the pipeline when dealing with audio devices, usrps, etc. </p>
<p>Reimplemented from <a class="el" href="classgr__block.html#a49ea94a86f3199f23563bb837633ea1f">gr_block</a>.</p>
</div>
</div>
<a class="anchor" id="af57ebe4d74be578d0357e9a7171eb785"></a><!-- doxytag: member="audio_osx_sink::stop" ref="af57ebe4d74be578d0357e9a7171eb785" args="()" -->
<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_osx_sink::stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called to disable drivers, etc for i/o devices. </p>
<p>Reimplemented from <a class="el" href="classgr__block.html#a53c2c89c037e4e393b75414d605e36b1">gr_block</a>.</p>
</div>
</div>
<a class="anchor" id="a38c0585e65251d0f5b399751ebf36d17"></a><!-- doxytag: member="audio_osx_sink::work" ref="a38c0585e65251d0f5b399751ebf36d17" 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_osx_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>
</tr>
<tr>
<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="aef50e214a04a63ddfb094944486caee9"></a><!-- doxytag: member="audio_osx_sink::audio_osx_make_sink" ref="aef50e214a04a63ddfb094944486caee9" args="(int sample_rate, const std::string device_name, bool do_block, int channel_config, int max_sample_count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">audio_osx_sink_sptr</a> audio_osx_make_sink </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>sample_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>do_block</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>channel_config</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>max_sample_count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><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__osx__sink_8h_source.html">audio_osx_sink.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classaudio__osx__sink.html">audio_osx_sink</a> </li>
<li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
166
