Sophie

Sophie

distrib > Mageia > 3 > i586 > by-pkgid > d2c3cd0736fcf741288cdfea8c6ba8c2 > files > 906

gnuradio-doc-3.6.4.1-1.mga3.noarch.rpm

<!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.3"/>
<title>GNU Radio 3.6.4.1 C++ API: audio_windows_source 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="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">GNU Radio 3.6.4.1 C++ API
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
</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('classaudio__windows__source.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classaudio__windows__source-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">audio_windows_source Class Reference<div class="ingroups"><a class="el" href="group__audio__blk.html">Audio Interface</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>audio source using winmm mmsystem (win32 only)Output signature is one or two streams of floats. Output samples will be in the range [-1,1].  
 <a href="classaudio__windows__source.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="audio__windows__source_8h_source.html">audio_windows_source.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for audio_windows_source:</div>
<div class="dyncontent">
<div class="center"><img src="classaudio__windows__source__inherit__graph.png" border="0" usemap="#audio__windows__source_inherit__map" alt="Inheritance graph"/></div>
<map name="audio__windows__source_inherit__map" id="audio__windows__source_inherit__map">
<area shape="rect" id="node2" href="classaudio__source.html" title="Creates a source from an audio device." alt="" coords="104,408,203,435"/><area shape="rect" id="node4" href="classgr__sync__block.html" title="synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa..." alt="" coords="100,333,207,360"/><area shape="rect" id="node6" href="classgr__block.html" title="The abstract base class for all &#39;terminal&#39; processing blocks.A signal processing flow is constructed ..." alt="" coords="118,259,188,285"/><area shape="rect" id="node8" 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="99,184,208,211"/><area shape="rect" id="node10" href="classgr__msg__accepter.html" title="Accepts messages and inserts them into a message queue, then notifies subclass gr_basic_block there i..." alt="" coords="13,95,136,121"/><area shape="rect" id="node12" href="classgruel_1_1msg__accepter.html" title="Virtual base class that accepts messages." alt="" coords="5,5,144,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></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:a1cb2574c00b7b6c3a6a704e3d96bbc7e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__windows__source.html#a1cb2574c00b7b6c3a6a704e3d96bbc7e">audio_windows_source</a> (int sampling_freq, const std::string device_name=&quot;&quot;)</td></tr>
<tr class="separator:a1cb2574c00b7b6c3a6a704e3d96bbc7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f653eff25a625541e0327aaf5bfec41"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__windows__source.html#a9f653eff25a625541e0327aaf5bfec41">~audio_windows_source</a> ()</td></tr>
<tr class="separator:a9f653eff25a625541e0327aaf5bfec41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac37a6dca7156bcff972e468c54800b58"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__windows__source.html#ac37a6dca7156bcff972e468c54800b58">work</a> (int noutput_items, <a class="el" href="gr__types_8h.html#a9852a3d906d823cb70eb9c29e7f2a43d">gr_vector_const_void_star</a> &amp;input_items, <a class="el" href="gr__types_8h.html#acd3f499576e769966ea44554b359d949">gr_vector_void_star</a> &amp;output_items)</td></tr>
<tr class="memdesc:ac37a6dca7156bcff972e468c54800b58"><td class="mdescLeft">&#160;</td><td class="mdescRight">just like <a class="el" href="classgr__block.html#adf59080d10f322e3816b7ac8f7cb2a7c" title="compute output items from input items">gr_block::general_work</a>, only this arranges to call consume_each for you  <a href="#ac37a6dca7156bcff972e468c54800b58"></a><br/></td></tr>
<tr class="separator:ac37a6dca7156bcff972e468c54800b58"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_classaudio__source"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classaudio__source')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classaudio__source.html">audio_source</a></td></tr>
<tr class="memitem:a2135ef650ecacb1d5d18367d28b67ed8 inherit pub_types_classaudio__source"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classboost_1_1shared__ptr.html">boost::shared_ptr</a><br class="typebreak"/>
&lt; <a class="el" href="classaudio__source.html">audio_source</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__source.html#a2135ef650ecacb1d5d18367d28b67ed8">sptr</a></td></tr>
<tr class="separator:a2135ef650ecacb1d5d18367d28b67ed8 inherit pub_types_classaudio__source"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_types_classgr__basic__block"><td colspan="2" onclick="javascript:toggleInherit('pro_types_classgr__basic__block')"><img src="closed.png" alt="-"/>&#160;Protected Types inherited from <a class="el" href="classgr__basic__block.html">gr_basic_block</a></td></tr>
<tr class="memitem:a5c90b7c003ddd61f8df6bef2aceeab3d inherit pro_types_classgr__basic__block"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__basic__block.html#a5c90b7c003ddd61f8df6bef2aceeab3d">vcolor</a> { <a class="el" href="classgr__basic__block.html#a5c90b7c003ddd61f8df6bef2aceeab3da476d594a077e729bad0f2cfa2008c899">WHITE</a>, 
<a class="el" href="classgr__basic__block.html#a5c90b7c003ddd61f8df6bef2aceeab3daa6cce7ec34a3f9cf917e545a743dc89f">GREY</a>, 
<a class="el" href="classgr__basic__block.html#a5c90b7c003ddd61f8df6bef2aceeab3da0abd1c82699481ffa502e5bb8d7bdaec">BLACK</a>
 }</td></tr>
<tr class="separator:a5c90b7c003ddd61f8df6bef2aceeab3d inherit pro_types_classgr__basic__block"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classgr__sync__block"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classgr__sync__block')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classgr__sync__block.html">gr_sync_block</a></td></tr>
<tr class="memitem:a8e8100cc8cafbc89a0cd64fbc2fc4153 inherit pro_methods_classgr__sync__block"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sync__block.html#a8e8100cc8cafbc89a0cd64fbc2fc4153">gr_sync_block</a> (<a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a>)</td></tr>
<tr class="separator:a8e8100cc8cafbc89a0cd64fbc2fc4153 inherit pro_methods_classgr__sync__block"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a832d8dad2dbd38e8e9cfa0b954d37c87 inherit pro_methods_classgr__sync__block"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sync__block.html#a832d8dad2dbd38e8e9cfa0b954d37c87">gr_sync_block</a> (const std::string &amp;<a class="el" href="classgr__basic__block.html#aa12a20d8b8eab341da935530d29299d2">name</a>, <a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> <a class="el" href="classgr__basic__block.html#a58f6d05e85931200f3771d3e50741281">input_signature</a>, <a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> <a class="el" href="classgr__basic__block.html#add68b96f012dfe352700b4fd1c3a184a">output_signature</a>)</td></tr>
<tr class="separator:a832d8dad2dbd38e8e9cfa0b954d37c87 inherit pro_methods_classgr__sync__block"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classgr__block"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classgr__block')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classgr__block.html">gr_block</a></td></tr>
<tr class="memitem:ab467fa14adf6b63148588ffbbe266d82 inherit pro_attribs_classgr__block"><td class="memItemLeft" align="right" valign="top">std::vector&lt; long &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#ab467fa14adf6b63148588ffbbe266d82">d_max_output_buffer</a></td></tr>
<tr class="separator:ab467fa14adf6b63148588ffbbe266d82 inherit pro_attribs_classgr__block"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c331f7d38508c9955ef01f483c573d6 inherit pro_attribs_classgr__block"><td class="memItemLeft" align="right" valign="top">std::vector&lt; long &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#a9c331f7d38508c9955ef01f483c573d6">d_min_output_buffer</a></td></tr>
<tr class="separator:a9c331f7d38508c9955ef01f483c573d6 inherit pro_attribs_classgr__block"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace960ec997da0fff8fc44168983b1a55 inherit pro_attribs_classgr__block"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegruel.html#a16a913898c1d7f7a8ee459eb7ace413d">gruel::mutex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#ace960ec997da0fff8fc44168983b1a55">d_setlock</a></td></tr>
<tr class="separator:ace960ec997da0fff8fc44168983b1a55 inherit pro_attribs_classgr__block"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>audio source using winmm mmsystem (win32 only)</p>
<p>Output signature is one or two streams of floats. Output samples will be in the range [-1,1]. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a1cb2574c00b7b6c3a6a704e3d96bbc7e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">audio_windows_source::audio_windows_source </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>sampling_freq</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string&#160;</td>
          <td class="paramname"><em>device_name</em> = <code>&quot;&quot;</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a9f653eff25a625541e0327aaf5bfec41"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">audio_windows_source::~audio_windows_source </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ac37a6dca7156bcff972e468c54800b58"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int audio_windows_source::work </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>noutput_items</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="gr__types_8h.html#a9852a3d906d823cb70eb9c29e7f2a43d">gr_vector_const_void_star</a> &amp;&#160;</td>
          <td class="paramname"><em>input_items</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="gr__types_8h.html#acd3f499576e769966ea44554b359d949">gr_vector_void_star</a> &amp;&#160;</td>
          <td class="paramname"><em>output_items</em>&#160;</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>just like <a class="el" href="classgr__block.html#adf59080d10f322e3816b7ac8f7cb2a7c" 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/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="audio__windows__source_8h_source.html">audio_windows_source.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="classaudio__windows__source.html">audio_windows_source</a></li>
    <li class="footer">Generated on Fri Apr 19 2013 16:20:36 for GNU Radio 3.6.4.1 C++ API by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li>
  </ul>
</div>
</body>
</html>