class_i_byte_chunk_reader.html

<!-- HTML header for doxygen 1.8.14-->
<!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.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>iPlug 2: IByteChunkReader 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/x-mathjax-config">
MathJax.Hub.Config({
  extensions: ["tex2jax.js"],
  jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="style.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: 80px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">iPlug2 - C++ Audio Plug-in Framework
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_i_byte_chunk_reader-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">IByteChunkReader Class Reference<div class="ingroups"><a class="el" href="group___i_plug_structs.html">IPlug::Structs</a></div></div></div>
</div><!--header-->
<div class="contents">

<p>Helper class to maintain a read position whilst extracting data from an <a class="el" href="class_i_byte_chunk.html" title="Manages a block of memory, for plug-in settings store/recall.">IByteChunk</a> <br  />
  
 <a href="class_i_byte_chunk_reader.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_i_plug_structs_8h_source.html">IPlugStructs.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad05fa78275e3cfa2d1f273eb90911f18"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_byte_chunk_reader.html#ad05fa78275e3cfa2d1f273eb90911f18">IByteChunkReader</a> (const <a class="el" href="class_i_byte_chunk.html">IByteChunk</a> &amp;chunk, int startPos=0)</td></tr>
<tr class="separator:ad05fa78275e3cfa2d1f273eb90911f18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4f075aa8fa070ad61e30f9423621c77"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_byte_chunk_reader.html#ab4f075aa8fa070ad61e30f9423621c77">GetBytes</a> (void *pBuf, int nBytesToCopy)</td></tr>
<tr class="memdesc:ab4f075aa8fa070ad61e30f9423621c77"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy <code>nBytesToCopy</code> bytes from the managed <a class="el" href="class_i_byte_chunk.html" title="Manages a block of memory, for plug-in settings store/recall.">IByteChunk</a> into <code>pBuf</code> .  <a href="class_i_byte_chunk_reader.html#ab4f075aa8fa070ad61e30f9423621c77">More...</a><br /></td></tr>
<tr class="separator:ab4f075aa8fa070ad61e30f9423621c77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8baf002118238f50cf83c36b30f7e0c7"><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr>
<tr class="memitem:a8baf002118238f50cf83c36b30f7e0c7"><td class="memTemplItemLeft" align="right" valign="top">int&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_i_byte_chunk_reader.html#a8baf002118238f50cf83c36b30f7e0c7">Get</a> (T *pDst)</td></tr>
<tr class="memdesc:a8baf002118238f50cf83c36b30f7e0c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy arbitary typed data out of the managed <a class="el" href="class_i_byte_chunk.html" title="Manages a block of memory, for plug-in settings store/recall.">IByteChunk</a> at the current position and update the position.  <a href="class_i_byte_chunk_reader.html#a8baf002118238f50cf83c36b30f7e0c7">More...</a><br /></td></tr>
<tr class="separator:a8baf002118238f50cf83c36b30f7e0c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8d45964364cd694363b00201a942c6c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_byte_chunk_reader.html#ad8d45964364cd694363b00201a942c6c">GetStr</a> (WDL_String &amp;str)</td></tr>
<tr class="memdesc:ad8d45964364cd694363b00201a942c6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve a string from the managed <a class="el" href="class_i_byte_chunk.html" title="Manages a block of memory, for plug-in settings store/recall.">IByteChunk</a> and put it in <code>str</code> .  <a href="class_i_byte_chunk_reader.html#ad8d45964364cd694363b00201a942c6c">More...</a><br /></td></tr>
<tr class="separator:ad8d45964364cd694363b00201a942c6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a0035a8a39a5265a7d25e08a6b805ae"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_byte_chunk_reader.html#a4a0035a8a39a5265a7d25e08a6b805ae">Tell</a> () const</td></tr>
<tr class="memdesc:a4a0035a8a39a5265a7d25e08a6b805ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the current position in the managed <a class="el" href="class_i_byte_chunk.html" title="Manages a block of memory, for plug-in settings store/recall.">IByteChunk</a>.  <a href="class_i_byte_chunk_reader.html#a4a0035a8a39a5265a7d25e08a6b805ae">More...</a><br /></td></tr>
<tr class="separator:a4a0035a8a39a5265a7d25e08a6b805ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f4a3aedd70e432a900c86b7aa1b3f9a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_byte_chunk_reader.html#a2f4a3aedd70e432a900c86b7aa1b3f9a">Seek</a> (int pos)</td></tr>
<tr class="memdesc:a2f4a3aedd70e432a900c86b7aa1b3f9a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the current position in the managed <a class="el" href="class_i_byte_chunk.html" title="Manages a block of memory, for plug-in settings store/recall.">IByteChunk</a>.  <a href="class_i_byte_chunk_reader.html#a2f4a3aedd70e432a900c86b7aa1b3f9a">More...</a><br /></td></tr>
<tr class="separator:a2f4a3aedd70e432a900c86b7aa1b3f9a"><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 >Helper class to maintain a read position whilst extracting data from an <a class="el" href="class_i_byte_chunk.html" title="Manages a block of memory, for plug-in settings store/recall.">IByteChunk</a> <br  />
 </p>

<p class="definition">Definition at line <a class="el" href="_i_plug_structs_8h_source.html#l00331">331</a> of file <a class="el" href="_i_plug_structs_8h_source.html">IPlugStructs.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad05fa78275e3cfa2d1f273eb90911f18" name="ad05fa78275e3cfa2d1f273eb90911f18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad05fa78275e3cfa2d1f273eb90911f18">&#9670;&#160;</a></span>IByteChunkReader()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">IByteChunkReader::IByteChunkReader </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_i_byte_chunk.html">IByteChunk</a> &amp;&#160;</td>
          <td class="paramname"><em>chunk</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>startPos</em> = <code>0</code>&#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">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_i_plug_structs_8h_source.html#l00334">334</a> of file <a class="el" href="_i_plug_structs_8h_source.html">IPlugStructs.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8baf002118238f50cf83c36b30f7e0c7" name="a8baf002118238f50cf83c36b30f7e0c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8baf002118238f50cf83c36b30f7e0c7">&#9670;&#160;</a></span>Get()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int IByteChunkReader::Get </td>
          <td>(</td>
          <td class="paramtype">T *&#160;</td>
          <td class="paramname"><em>pDst</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Copy arbitary typed data out of the managed <a class="el" href="class_i_byte_chunk.html" title="Manages a block of memory, for plug-in settings store/recall.">IByteChunk</a> at the current position and update the position. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">T</td><td>type of the variable to get </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pDst</td><td>Pointer to the destination where the value will be stored </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>int Next read position in the <a class="el" href="class_i_byte_chunk.html" title="Manages a block of memory, for plug-in settings store/recall.">IByteChunk</a> </dd></dl>

<p class="definition">Definition at line <a class="el" href="_i_plug_structs_8h_source.html#l00355">355</a> of file <a class="el" href="_i_plug_structs_8h_source.html">IPlugStructs.h</a>.</p>

<p class="reference">References <a class="el" href="_i_plug_structs_8h_source.html#l00181">IByteChunk::Get()</a>.</p>

</div>
</div>
<a id="ab4f075aa8fa070ad61e30f9423621c77" name="ab4f075aa8fa070ad61e30f9423621c77"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4f075aa8fa070ad61e30f9423621c77">&#9670;&#160;</a></span>GetBytes()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int IByteChunkReader::GetBytes </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>pBuf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>nBytesToCopy</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">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Copy <code>nBytesToCopy</code> bytes from the managed <a class="el" href="class_i_byte_chunk.html" title="Manages a block of memory, for plug-in settings store/recall.">IByteChunk</a> into <code>pBuf</code> . </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pBuf</td><td>Destination buffer </td></tr>
    <tr><td class="paramname">nBytesToCopy</td><td>Number of bytes to copy </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Next read position in the <a class="el" href="class_i_byte_chunk.html" title="Manages a block of memory, for plug-in settings store/recall.">IByteChunk</a> </dd></dl>

<p class="definition">Definition at line <a class="el" href="_i_plug_structs_8h_source.html#l00344">344</a> of file <a class="el" href="_i_plug_structs_8h_source.html">IPlugStructs.h</a>.</p>

<p class="reference">References <a class="el" href="_i_plug_structs_8h_source.html#l00160">IByteChunk::GetBytes()</a>.</p>

</div>
</div>
<a id="ad8d45964364cd694363b00201a942c6c" name="ad8d45964364cd694363b00201a942c6c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8d45964364cd694363b00201a942c6c">&#9670;&#160;</a></span>GetStr()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int IByteChunkReader::GetStr </td>
          <td>(</td>
          <td class="paramtype">WDL_String &amp;&#160;</td>
          <td class="paramname"><em>str</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Retrieve a string from the managed <a class="el" href="class_i_byte_chunk.html" title="Manages a block of memory, for plug-in settings store/recall.">IByteChunk</a> and put it in <code>str</code> . </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">str</td><td>Destination for the string </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>int Next read position in the <a class="el" href="class_i_byte_chunk.html" title="Manages a block of memory, for plug-in settings store/recall.">IByteChunk</a> </dd></dl>

<p class="definition">Definition at line <a class="el" href="_i_plug_structs_8h_source.html#l00364">364</a> of file <a class="el" href="_i_plug_structs_8h_source.html">IPlugStructs.h</a>.</p>

<p class="reference">References <a class="el" href="_i_plug_structs_8h_source.html#l00200">IByteChunk::GetStr()</a>.</p>

</div>
</div>
<a id="a2f4a3aedd70e432a900c86b7aa1b3f9a" name="a2f4a3aedd70e432a900c86b7aa1b3f9a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f4a3aedd70e432a900c86b7aa1b3f9a">&#9670;&#160;</a></span>Seek()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void IByteChunkReader::Seek </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>pos</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Set the current position in the managed <a class="el" href="class_i_byte_chunk.html" title="Manages a block of memory, for plug-in settings store/recall.">IByteChunk</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pos</td><td>The new <a class="el" href="class_i_byte_chunk.html" title="Manages a block of memory, for plug-in settings store/recall.">IByteChunk</a> position </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="_i_plug_structs_8h_source.html#l00379">379</a> of file <a class="el" href="_i_plug_structs_8h_source.html">IPlugStructs.h</a>.</p>

</div>
</div>
<a id="a4a0035a8a39a5265a7d25e08a6b805ae" name="a4a0035a8a39a5265a7d25e08a6b805ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a0035a8a39a5265a7d25e08a6b805ae">&#9670;&#160;</a></span>Tell()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int IByteChunkReader::Tell </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Return the current position in the managed <a class="el" href="class_i_byte_chunk.html" title="Manages a block of memory, for plug-in settings store/recall.">IByteChunk</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>The current position in the <a class="el" href="class_i_byte_chunk.html" title="Manages a block of memory, for plug-in settings store/recall.">IByteChunk</a> </dd></dl>

<p class="definition">Definition at line <a class="el" href="_i_plug_structs_8h_source.html#l00372">372</a> of file <a class="el" href="_i_plug_structs_8h_source.html">IPlugStructs.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_i_plug_structs_8h_source.html">IPlugStructs.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
</small></address>
</body>
</html>