Initial release
This commit is contained in:
@@ -0,0 +1,405 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
||||
<meta name="generator" content="Doxygen 1.13.2"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Interface Technology Basics: IBStream 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>
|
||||
<script type="text/javascript" src="clipboard.js"></script>
|
||||
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="cookie.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>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
<link href="smtg_extra.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 id="projectrow">
|
||||
<td id="projectalign">
|
||||
<div id="projectname">Interface Technology Basics<span id="projectnumber"> VST 3.8</span>
|
||||
</div>
|
||||
<div id="projectbrief">SDK for developing VST plug-in</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.13.2 -->
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||||
/* @license-end */
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(function() { codefold.init(0); });
|
||||
/* @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&dn=expat.txt MIT */
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search',true);
|
||||
$(function() { init_search(); });
|
||||
});
|
||||
/* @license-end */
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
</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">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(function(){initNavTree('classSteinberg_1_1IBStream.html',''); initResizable(true); });
|
||||
/* @license-end */
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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 class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-types">Public Types</a> |
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="#pub-static-attribs">Static Public Attributes</a> |
|
||||
<a href="classSteinberg_1_1IBStream-members.html">List of all members</a> </div>
|
||||
<div class="headertitle"><div class="title">IBStream Class Reference<span class="mlabels"><span class="mlabel abstract">abstract</span></span><div class="ingroups"><a class="el" href="group__pluginBase.html">Basic Interfaces</a></div></div></div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Base class for streams.
|
||||
<a href="#details">More...</a></p>
|
||||
|
||||
<p><code>#include <ibstream.h></code></p>
|
||||
<div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
||||
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for IBStream:</div>
|
||||
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
|
||||
</div>
|
||||
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
|
||||
<div class="center"><img src="classSteinberg_1_1IBStream__inherit__graph.png" border="0" usemap="#aIBStream_inherit__map" alt="Inheritance graph"/></div>
|
||||
<map name="aIBStream_inherit__map" id="aIBStream_inherit__map">
|
||||
<area shape="rect" title="Base class for streams." alt="" coords="30,155,90,277"/>
|
||||
<area shape="rect" href="classSteinberg_1_1FUnknown.html" title="The basic interface of all interfaces." alt="" coords="5,5,114,107"/>
|
||||
<area shape="poly" title=" " alt="" coords="62,122,62,156,57,156,57,122"/>
|
||||
</map>
|
||||
</div>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
|
||||
Public Types</h2></td></tr>
|
||||
<tr class="memitem:a578603bbda4a0145412cb895b14efdd4" id="r_a578603bbda4a0145412cb895b14efdd4"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="#a578603bbda4a0145412cb895b14efdd4">IStreamSeekMode</a> { <a class="el" href="#a578603bbda4a0145412cb895b14efdd4aa6df685ae526fa7efefe23ce2c5e6e97">kIBSeekSet</a> = 0
|
||||
, <a class="el" href="#a578603bbda4a0145412cb895b14efdd4a38fe1bc7808828aa43282a56e5ed70f1">kIBSeekCur</a>
|
||||
, <a class="el" href="#a578603bbda4a0145412cb895b14efdd4aee2005d02e649de8da100c7f417cc2d8">kIBSeekEnd</a>
|
||||
}</td></tr>
|
||||
<tr class="separator:a578603bbda4a0145412cb895b14efdd4"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><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:aa08e74cc72149c52cd30b35c25efd5b5" id="r_aa08e74cc72149c52cd30b35c25efd5b5"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__smtgtypedef.html#ga902761e005a6252e538c766de48fc957">tresult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa08e74cc72149c52cd30b35c25efd5b5">read</a> (void *buffer, <a class="el" href="group__smtgtypedef.html#gab7903878916593daecbeb95b98115ab0">int32</a> numBytes, <a class="el" href="group__smtgtypedef.html#gab7903878916593daecbeb95b98115ab0">int32</a> *numBytesRead=nullptr)=0</td></tr>
|
||||
<tr class="memdesc:aa08e74cc72149c52cd30b35c25efd5b5"><td class="mdescLeft"> </td><td class="mdescRight">Reads binary data from stream. <br /></td></tr>
|
||||
<tr class="separator:aa08e74cc72149c52cd30b35c25efd5b5"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ae611e1d9d2baf0c9b9490b506ddfcbfd" id="r_ae611e1d9d2baf0c9b9490b506ddfcbfd"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__smtgtypedef.html#ga902761e005a6252e538c766de48fc957">tresult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae611e1d9d2baf0c9b9490b506ddfcbfd">write</a> (void *buffer, <a class="el" href="group__smtgtypedef.html#gab7903878916593daecbeb95b98115ab0">int32</a> numBytes, <a class="el" href="group__smtgtypedef.html#gab7903878916593daecbeb95b98115ab0">int32</a> *numBytesWritten=nullptr)=0</td></tr>
|
||||
<tr class="memdesc:ae611e1d9d2baf0c9b9490b506ddfcbfd"><td class="mdescLeft"> </td><td class="mdescRight">Writes binary data to stream. <br /></td></tr>
|
||||
<tr class="separator:ae611e1d9d2baf0c9b9490b506ddfcbfd"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a1449a39ff2d3f964a08753f128626702" id="r_a1449a39ff2d3f964a08753f128626702"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__smtgtypedef.html#ga902761e005a6252e538c766de48fc957">tresult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1449a39ff2d3f964a08753f128626702">seek</a> (<a class="el" href="group__smtgtypedef.html#ga7cde0074dfd288f2d70c0e035dacb28a">int64</a> pos, <a class="el" href="group__smtgtypedef.html#gab7903878916593daecbeb95b98115ab0">int32</a> mode, <a class="el" href="group__smtgtypedef.html#ga7cde0074dfd288f2d70c0e035dacb28a">int64</a> *result=nullptr)=0</td></tr>
|
||||
<tr class="memdesc:a1449a39ff2d3f964a08753f128626702"><td class="mdescLeft"> </td><td class="mdescRight">Sets stream read-write position. <br /></td></tr>
|
||||
<tr class="separator:a1449a39ff2d3f964a08753f128626702"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a25dc574e08d9d76e0c2805bb2f30f7ba" id="r_a25dc574e08d9d76e0c2805bb2f30f7ba"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__smtgtypedef.html#ga902761e005a6252e538c766de48fc957">tresult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a25dc574e08d9d76e0c2805bb2f30f7ba">tell</a> (<a class="el" href="group__smtgtypedef.html#ga7cde0074dfd288f2d70c0e035dacb28a">int64</a> *pos)=0</td></tr>
|
||||
<tr class="memdesc:a25dc574e08d9d76e0c2805bb2f30f7ba"><td class="mdescLeft"> </td><td class="mdescRight">Gets current stream read-write position. <br /></td></tr>
|
||||
<tr class="separator:a25dc574e08d9d76e0c2805bb2f30f7ba"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="inherit_header pub_methods_classSteinberg_1_1FUnknown"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classSteinberg_1_1FUnknown')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classSteinberg_1_1FUnknown.html">FUnknown</a></td></tr>
|
||||
<tr class="memitem:a4199134d0669bfa92b7419dac14c01a7 inherit pub_methods_classSteinberg_1_1FUnknown" id="r_a4199134d0669bfa92b7419dac14c01a7"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__smtgtypedef.html#ga902761e005a6252e538c766de48fc957">tresult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSteinberg_1_1FUnknown.html#a4199134d0669bfa92b7419dac14c01a7">queryInterface</a> (const <a class="el" href="group__pluginBase.html#ga6935af93744bfe4ecc455f274ef1ec36">TUID</a> _iid, void **obj)=0</td></tr>
|
||||
<tr class="memdesc:a4199134d0669bfa92b7419dac14c01a7 inherit pub_methods_classSteinberg_1_1FUnknown"><td class="mdescLeft"> </td><td class="mdescRight">Query for a pointer to the specified interface. <br /></td></tr>
|
||||
<tr class="separator:a4199134d0669bfa92b7419dac14c01a7 inherit pub_methods_classSteinberg_1_1FUnknown"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aaa3c5a2a5410d41153d7f5e3f4e0a635 inherit pub_methods_classSteinberg_1_1FUnknown" id="r_aaa3c5a2a5410d41153d7f5e3f4e0a635"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__smtgtypedef.html#gacbd4acd0d29e2d6c43104827f77d9cd2">uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSteinberg_1_1FUnknown.html#aaa3c5a2a5410d41153d7f5e3f4e0a635">addRef</a> ()=0</td></tr>
|
||||
<tr class="memdesc:aaa3c5a2a5410d41153d7f5e3f4e0a635 inherit pub_methods_classSteinberg_1_1FUnknown"><td class="mdescLeft"> </td><td class="mdescRight">Adds a reference and returns the new reference count. <br /></td></tr>
|
||||
<tr class="separator:aaa3c5a2a5410d41153d7f5e3f4e0a635 inherit pub_methods_classSteinberg_1_1FUnknown"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a58847c78bf6142f01ce214c2802cb146 inherit pub_methods_classSteinberg_1_1FUnknown" id="r_a58847c78bf6142f01ce214c2802cb146"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__smtgtypedef.html#gacbd4acd0d29e2d6c43104827f77d9cd2">uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSteinberg_1_1FUnknown.html#a58847c78bf6142f01ce214c2802cb146">release</a> ()=0</td></tr>
|
||||
<tr class="memdesc:a58847c78bf6142f01ce214c2802cb146 inherit pub_methods_classSteinberg_1_1FUnknown"><td class="mdescLeft"> </td><td class="mdescRight">Releases a reference and returns the new reference count. <br /></td></tr>
|
||||
<tr class="separator:a58847c78bf6142f01ce214c2802cb146 inherit pub_methods_classSteinberg_1_1FUnknown"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
|
||||
Static Public Attributes</h2></td></tr>
|
||||
<tr class="memitem:a07978c93295b03d09c4bc97aa12e9c60" id="r_a07978c93295b03d09c4bc97aa12e9c60"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classSteinberg_1_1FUID.html">FUID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a07978c93295b03d09c4bc97aa12e9c60">iid</a></td></tr>
|
||||
<tr class="separator:a07978c93295b03d09c4bc97aa12e9c60"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="inherit_header pub_static_attribs_classSteinberg_1_1FUnknown"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_static_attribs_classSteinberg_1_1FUnknown')"><img src="closed.png" alt="-"/> Static Public Attributes inherited from <a class="el" href="classSteinberg_1_1FUnknown.html">FUnknown</a></td></tr>
|
||||
<tr class="memitem:a07978c93295b03d09c4bc97aa12e9c60 inherit pub_static_attribs_classSteinberg_1_1FUnknown" id="r_a07978c93295b03d09c4bc97aa12e9c60"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classSteinberg_1_1FUID.html">FUID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSteinberg_1_1FUnknown.html#a07978c93295b03d09c4bc97aa12e9c60">iid</a></td></tr>
|
||||
<tr class="separator:a07978c93295b03d09c4bc97aa12e9c60 inherit pub_static_attribs_classSteinberg_1_1FUnknown"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Base class for streams. </p>
|
||||
<ul>
|
||||
<li>read/write binary data from/to stream</li>
|
||||
<li>get/set stream read-write position (read and write position is the same) </li>
|
||||
</ul>
|
||||
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
|
||||
<a id="a578603bbda4a0145412cb895b14efdd4" name="a578603bbda4a0145412cb895b14efdd4"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a578603bbda4a0145412cb895b14efdd4">◆ </a></span>IStreamSeekMode</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">enum <a class="el" href="#a578603bbda4a0145412cb895b14efdd4">IStreamSeekMode</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<table class="fieldtable">
|
||||
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a578603bbda4a0145412cb895b14efdd4aa6df685ae526fa7efefe23ce2c5e6e97" name="a578603bbda4a0145412cb895b14efdd4aa6df685ae526fa7efefe23ce2c5e6e97"></a>kIBSeekSet </td><td class="fielddoc"><p>set absolute seek position </p>
|
||||
</td></tr>
|
||||
<tr><td class="fieldname"><a id="a578603bbda4a0145412cb895b14efdd4a38fe1bc7808828aa43282a56e5ed70f1" name="a578603bbda4a0145412cb895b14efdd4a38fe1bc7808828aa43282a56e5ed70f1"></a>kIBSeekCur </td><td class="fielddoc"><p>set seek position relative to current position </p>
|
||||
</td></tr>
|
||||
<tr><td class="fieldname"><a id="a578603bbda4a0145412cb895b14efdd4aee2005d02e649de8da100c7f417cc2d8" name="a578603bbda4a0145412cb895b14efdd4aee2005d02e649de8da100c7f417cc2d8"></a>kIBSeekEnd </td><td class="fielddoc"><p>set seek position relative to stream end </p>
|
||||
</td></tr>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a id="aa08e74cc72149c52cd30b35c25efd5b5" name="aa08e74cc72149c52cd30b35c25efd5b5"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#aa08e74cc72149c52cd30b35c25efd5b5">◆ </a></span>read()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">virtual <a class="el" href="group__smtgtypedef.html#ga902761e005a6252e538c766de48fc957">tresult</a> read </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>buffer</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"><a class="el" href="group__smtgtypedef.html#gab7903878916593daecbeb95b98115ab0">int32</a></td> <td class="paramname"><span class="paramname"><em>numBytes</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"><a class="el" href="group__smtgtypedef.html#gab7903878916593daecbeb95b98115ab0">int32</a> *</td> <td class="paramname"><span class="paramname"><em>numBytesRead</em></span><span class="paramdefsep"> = </span><span class="paramdefval">nullptr</span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Reads binary data from stream. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">buffer</td><td>: destination buffer </td></tr>
|
||||
<tr><td class="paramname">numBytes</td><td>: amount of bytes to be read </td></tr>
|
||||
<tr><td class="paramname">numBytesRead</td><td>: result - how many bytes have been read from stream (set to 0 if this is of no interest) </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ae611e1d9d2baf0c9b9490b506ddfcbfd" name="ae611e1d9d2baf0c9b9490b506ddfcbfd"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ae611e1d9d2baf0c9b9490b506ddfcbfd">◆ </a></span>write()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">virtual <a class="el" href="group__smtgtypedef.html#ga902761e005a6252e538c766de48fc957">tresult</a> write </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>buffer</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"><a class="el" href="group__smtgtypedef.html#gab7903878916593daecbeb95b98115ab0">int32</a></td> <td class="paramname"><span class="paramname"><em>numBytes</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"><a class="el" href="group__smtgtypedef.html#gab7903878916593daecbeb95b98115ab0">int32</a> *</td> <td class="paramname"><span class="paramname"><em>numBytesWritten</em></span><span class="paramdefsep"> = </span><span class="paramdefval">nullptr</span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Writes binary data to stream. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">buffer</td><td>: source buffer </td></tr>
|
||||
<tr><td class="paramname">numBytes</td><td>: amount of bytes to write </td></tr>
|
||||
<tr><td class="paramname">numBytesWritten</td><td>: result - how many bytes have been written to stream (set to 0 if this is of no interest) </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a1449a39ff2d3f964a08753f128626702" name="a1449a39ff2d3f964a08753f128626702"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a1449a39ff2d3f964a08753f128626702">◆ </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">virtual <a class="el" href="group__smtgtypedef.html#ga902761e005a6252e538c766de48fc957">tresult</a> seek </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="group__smtgtypedef.html#ga7cde0074dfd288f2d70c0e035dacb28a">int64</a></td> <td class="paramname"><span class="paramname"><em>pos</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"><a class="el" href="group__smtgtypedef.html#gab7903878916593daecbeb95b98115ab0">int32</a></td> <td class="paramname"><span class="paramname"><em>mode</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"><a class="el" href="group__smtgtypedef.html#ga7cde0074dfd288f2d70c0e035dacb28a">int64</a> *</td> <td class="paramname"><span class="paramname"><em>result</em></span><span class="paramdefsep"> = </span><span class="paramdefval">nullptr</span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Sets stream read-write position. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">pos</td><td>: new stream position (dependent on mode) </td></tr>
|
||||
<tr><td class="paramname">mode</td><td>: value of enum <a class="el" href="#a578603bbda4a0145412cb895b14efdd4">IStreamSeekMode</a> </td></tr>
|
||||
<tr><td class="paramname">result</td><td>: new seek position (set to 0 if this is of no interest) </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a25dc574e08d9d76e0c2805bb2f30f7ba" name="a25dc574e08d9d76e0c2805bb2f30f7ba"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a25dc574e08d9d76e0c2805bb2f30f7ba">◆ </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">virtual <a class="el" href="group__smtgtypedef.html#ga902761e005a6252e538c766de48fc957">tresult</a> tell </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="group__smtgtypedef.html#ga7cde0074dfd288f2d70c0e035dacb28a">int64</a> *</td> <td class="paramname"><span class="paramname"><em>pos</em></span></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Gets current stream read-write position. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">pos</td><td>: is assigned the current position if function succeeds </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Member Data Documentation</h2>
|
||||
<a id="a07978c93295b03d09c4bc97aa12e9c60" name="a07978c93295b03d09c4bc97aa12e9c60"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a07978c93295b03d09c4bc97aa12e9c60">◆ </a></span>iid</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">const::Steinberg::FUID iid</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel static">static</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<html>
|
||||
<head>
|
||||
<title>Empty</title>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
||||
<meta name="Author" content="Steinberg">
|
||||
</head>
|
||||
<body>
|
||||
<br/>
|
||||
<hr width="100%" size="2" align="left" />
|
||||
<div align=right>
|
||||
Copyright ©<span id="year"></span> <a href="http://www.steinberg.net" target="_blank"><u>Steinberg Media Technologies GmbH</u></a>.
|
||||
All Rights Reserved. This documentation is under this <a href="http://www.steinberg.net/sdklicenses" target="_blank"><u>license</u></a>.
|
||||
</div>
|
||||
<script>
|
||||
document.querySelector("#year").textContent = new Date().getFullYear();
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user