Willkommen bei WordPress. Dies ist dein erster Beitrag. Bearbeite oder lösche ihn und beginne mit dem Schreiben!
Hallo Welt!
von raredesign | Dez 3, 2019 | Allgemein | 0 Kommentare
Cokiee Shell
Current Path : /proc/self/root/usr/share/doc/libclam-doc/html/ |
Current File : //proc/self/root/usr/share/doc/libclam-doc/html/classCLAM_1_1AudioCircularBuffer.html |
<!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"/> <title>CLAM-Development: CLAM::AudioCircularBuffer 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="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">CLAM-Development  <span id="projectnumber">1.4.0</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.1 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceCLAM.html">CLAM</a></li><li class="navelem"><a class="el" href="classCLAM_1_1AudioCircularBuffer.html">AudioCircularBuffer</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <div class="title">CLAM::AudioCircularBuffer Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>Specialization of the <a class="el" href="classCLAM_1_1CircularBuffer.html" title="Generic container-like circular buffer class.">CircularBuffer</a> class for the case of <a class="el" href="classCLAM_1_1Audio.html" title="Audio class with the Data Buffer, information about it (SampleRate, BeginTime), and methods to insert...">Audio</a> chunks. <a href="classCLAM_1_1AudioCircularBuffer.html#details">More...</a></p> <p><code>#include <<a class="el" href="AudioCircularBuffer_8hxx_source.html">AudioCircularBuffer.hxx</a>></code></p> <p><a href="classCLAM_1_1AudioCircularBuffer-members.html">List of all members.</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a636e0f622d41e4d5eb4a93a79e1ee449"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1AudioCircularBuffer.html#a636e0f622d41e4d5eb4a93a79e1ee449">AudioCircularBuffer</a> ()</td></tr> <tr class="memdesc:a636e0f622d41e4d5eb4a93a79e1ee449"><td class="mdescLeft"> </td><td class="mdescRight">CONSTRUCTION. <a href="#a636e0f622d41e4d5eb4a93a79e1ee449"></a><br/></td></tr> <tr class="memitem:adc50de0463dbb769e984aa3256e83823"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1AudioCircularBuffer.html#adc50de0463dbb769e984aa3256e83823">AudioCircularBuffer</a> (<a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> bufferSize)</td></tr> <tr class="memitem:a23faf0e5726a91adc4551d1f923f85e1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1AudioCircularBuffer.html#a23faf0e5726a91adc4551d1f923f85e1">ReadAudio</a> (<a class="el" href="classCLAM_1_1Audio.html">Audio</a> &in)</td></tr> <tr class="memitem:af8332691c9e5838c02803917dc346218"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1AudioCircularBuffer.html#af8332691c9e5838c02803917dc346218">NonCopyReadAudio</a> (<a class="el" href="classCLAM_1_1Audio.html">Audio</a> &in)</td></tr> <tr class="memitem:a237c35b20d31fbbff25b6aa95009750e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1AudioCircularBuffer.html#a237c35b20d31fbbff25b6aa95009750e">WriteAudio</a> (const <a class="el" href="classCLAM_1_1Audio.html">Audio</a> &in)</td></tr> <tr class="memitem:a77fa604de534a31c740417c0c61fd7d3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1AudioCircularBuffer.html#a77fa604de534a31c740417c0c61fd7d3">AddAudio</a> (const <a class="el" href="classCLAM_1_1Audio.html">Audio</a> &in)</td></tr> <tr class="inherit_header pub_methods_classCLAM_1_1CircularBuffer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classCLAM_1_1CircularBuffer')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer< TData ></a></td></tr> <tr class="memitem:a0bec01c6a806041d4f1b583880e06bab inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a0bec01c6a806041d4f1b583880e06bab">CircularBuffer</a> ()</td></tr> <tr class="memdesc:a0bec01c6a806041d4f1b583880e06bab inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a0bec01c6a806041d4f1b583880e06bab"></a><br/></td></tr> <tr class="memitem:afd909b03ce941703bef10e5df425ba62 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#afd909b03ce941703bef10e5df425ba62">CircularBuffer</a> (<a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> bufferSize)</td></tr> <tr class="memdesc:afd909b03ce941703bef10e5df425ba62 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Constructor which initializes the buffer to a certain capacity. <a href="#afd909b03ce941703bef10e5df425ba62"></a><br/></td></tr> <tr class="memitem:aff5abbcaa812c6a39ca5705f9a6d9d17 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#aff5abbcaa812c6a39ca5705f9a6d9d17">GetBufferSize</a> () const</td></tr> <tr class="memdesc:aff5abbcaa812c6a39ca5705f9a6d9d17 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Returns the circular buffer's buffer size. <a href="#aff5abbcaa812c6a39ca5705f9a6d9d17"></a><br/></td></tr> <tr class="memitem:a3402381caef191931505558b08d8d6b3 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a3402381caef191931505558b08d8d6b3">SetBufferSize</a> (<a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> size)</td></tr> <tr class="memdesc:a3402381caef191931505558b08d8d6b3 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Resizes the buffer to a new capacity (or buffer size). <a href="#a3402381caef191931505558b08d8d6b3"></a><br/></td></tr> <tr class="memitem:aa3abc4c0bf9494963b441fac7b8b3687 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#aa3abc4c0bf9494963b441fac7b8b3687">GetWriteIndex</a> () const</td></tr> <tr class="memdesc:aa3abc4c0bf9494963b441fac7b8b3687 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Returns the index of the element that the buffer is about to write (ie. <a href="#aa3abc4c0bf9494963b441fac7b8b3687"></a><br/></td></tr> <tr class="memitem:af9195fed9740bbaf2392125ba9f4cf8a inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#af9195fed9740bbaf2392125ba9f4cf8a">GetReadIndex</a> () const</td></tr> <tr class="memdesc:af9195fed9740bbaf2392125ba9f4cf8a inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Returns the index of the element that the buffer is about to read (ie. <a href="#af9195fed9740bbaf2392125ba9f4cf8a"></a><br/></td></tr> <tr class="memitem:a85009cd1d2b52cdc3592d6a2abc98611 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a85009cd1d2b52cdc3592d6a2abc98611">GetInitialReadOffset</a> () const</td></tr> <tr class="memdesc:a85009cd1d2b52cdc3592d6a2abc98611 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Returns the initial read offset. <a href="#a85009cd1d2b52cdc3592d6a2abc98611"></a><br/></td></tr> <tr class="memitem:a298d0d12e31a9b7271a95e7c05a8afec inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a298d0d12e31a9b7271a95e7c05a8afec">SetInitialReadOffset</a> (<a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> size)</td></tr> <tr class="memdesc:a298d0d12e31a9b7271a95e7c05a8afec inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Sets the initial read offset. <a href="#a298d0d12e31a9b7271a95e7c05a8afec"></a><br/></td></tr> <tr class="memitem:a4fb8b631ccefdfae6650d6fa54712fc0 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a4fb8b631ccefdfae6650d6fa54712fc0">GetInitialWriteOffset</a> () const</td></tr> <tr class="memdesc:a4fb8b631ccefdfae6650d6fa54712fc0 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Returns the initial write offset. <a href="#a4fb8b631ccefdfae6650d6fa54712fc0"></a><br/></td></tr> <tr class="memitem:a5fc86980afc639c74b8b90c5e824ccea inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a5fc86980afc639c74b8b90c5e824ccea">SetInitialWriteOffset</a> (<a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> size)</td></tr> <tr class="memdesc:a5fc86980afc639c74b8b90c5e824ccea inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Sets the initial write offset. <a href="#a5fc86980afc639c74b8b90c5e824ccea"></a><br/></td></tr> <tr class="memitem:a6acb84ac743637b2cb4c799013de6e43 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a6acb84ac743637b2cb4c799013de6e43">Init</a> ()</td></tr> <tr class="memdesc:a6acb84ac743637b2cb4c799013de6e43 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the buffer by setting all elements to 0 and making sure read/write indices are set correctly (taking into account initial read/write offsets). <a href="#a6acb84ac743637b2cb4c799013de6e43"></a><br/></td></tr> <tr class="memitem:aeaad04e0acc435e35764aec2506b14ec inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#aeaad04e0acc435e35764aec2506b14ec">SetBufferToZero</a> ()</td></tr> <tr class="memdesc:aeaad04e0acc435e35764aec2506b14ec inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Sets all elements in circular buffer to zero. <a href="#aeaad04e0acc435e35764aec2506b14ec"></a><br/></td></tr> <tr class="memitem:a43f7ca5e654b0cb9d4cb848035f8b814 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a43f7ca5e654b0cb9d4cb848035f8b814">InitPointers</a> ()</td></tr> <tr class="memdesc:a43f7ca5e654b0cb9d4cb848035f8b814 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Initializes read/write indices (taking into account initial read/write offsets). <a href="#a43f7ca5e654b0cb9d4cb848035f8b814"></a><br/></td></tr> <tr class="memitem:abaacb419d16e7e97eb505765ca7e0b1b inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#abaacb419d16e7e97eb505765ca7e0b1b">Read</a> (<a class="el" href="namespaceCLAM.html#ab9c6321b061069797fcc173f61e8111a">TData</a> &element)</td></tr> <tr class="memdesc:abaacb419d16e7e97eb505765ca7e0b1b inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Reads a single element at the current read index into element. <a href="#abaacb419d16e7e97eb505765ca7e0b1b"></a><br/></td></tr> <tr class="memitem:a6b740b3d393000ef762574022e4a2241 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a6b740b3d393000ef762574022e4a2241">Read</a> (<a class="el" href="namespaceCLAM.html#ab9c6321b061069797fcc173f61e8111a">TData</a> *buffer)</td></tr> <tr class="memdesc:a6b740b3d393000ef762574022e4a2241 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Reads read size number of elements starting at the current read index into buffer. <a href="#a6b740b3d393000ef762574022e4a2241"></a><br/></td></tr> <tr class="memitem:ac8f6c0843e1bc7a730848ac8b5316a8d inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#ac8f6c0843e1bc7a730848ac8b5316a8d">Read</a> (<a class="el" href="classCLAM_1_1Array.html">Array</a>< <a class="el" href="namespaceCLAM.html#ab9c6321b061069797fcc173f61e8111a">TData</a> > &in, <a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> offset=0)</td></tr> <tr class="memdesc:ac8f6c0843e1bc7a730848ac8b5316a8d inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Reads read size number of elements starting at the current read index into the array at the specified offset (default: offset = 0). <a href="#ac8f6c0843e1bc7a730848ac8b5316a8d"></a><br/></td></tr> <tr class="memitem:ac4fb08f27529f4961ab657cbcd143931 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#ac4fb08f27529f4961ab657cbcd143931">NonCopyRead</a> (<a class="el" href="classCLAM_1_1Array.html">Array</a>< <a class="el" href="namespaceCLAM.html#ab9c6321b061069797fcc173f61e8111a">TData</a> > &buffer)</td></tr> <tr class="memitem:a641ad296ff574c8a64bf816ace3d697a inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a641ad296ff574c8a64bf816ace3d697a">Write</a> (const <a class="el" href="namespaceCLAM.html#ab9c6321b061069797fcc173f61e8111a">TData</a> &element)</td></tr> <tr class="memdesc:a641ad296ff574c8a64bf816ace3d697a inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Writes a single element at the current write index. <a href="#a641ad296ff574c8a64bf816ace3d697a"></a><br/></td></tr> <tr class="memitem:a79b46c715ea76a0145564f364b9958b8 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a79b46c715ea76a0145564f364b9958b8">Write</a> (const <a class="el" href="namespaceCLAM.html#ab9c6321b061069797fcc173f61e8111a">TData</a> *buffer)</td></tr> <tr class="memdesc:a79b46c715ea76a0145564f364b9958b8 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Writes write size number of elements starting at the current write index from buffer. <a href="#a79b46c715ea76a0145564f364b9958b8"></a><br/></td></tr> <tr class="memitem:ac22ad20143590b20c3832753d4fee70d inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#ac22ad20143590b20c3832753d4fee70d">Write</a> (const <a class="el" href="classCLAM_1_1Array.html">Array</a>< <a class="el" href="namespaceCLAM.html#ab9c6321b061069797fcc173f61e8111a">TData</a> > &in, <a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> offset=0)</td></tr> <tr class="memdesc:ac22ad20143590b20c3832753d4fee70d inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Writes write size number of elements starting at the current write index from the array starting at the specified offset (default: offset = 0). <a href="#ac22ad20143590b20c3832753d4fee70d"></a><br/></td></tr> <tr class="memitem:a260bbca271368a440868d13ebe50ccea inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a260bbca271368a440868d13ebe50ccea">Add</a> (const <a class="el" href="namespaceCLAM.html#ab9c6321b061069797fcc173f61e8111a">TData</a> &elem)</td></tr> <tr class="memdesc:a260bbca271368a440868d13ebe50ccea inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Does an additive write of a single element at the current write index. <a href="#a260bbca271368a440868d13ebe50ccea"></a><br/></td></tr> <tr class="memitem:a3366c033d501973545e1991b94fc9ddc inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a3366c033d501973545e1991b94fc9ddc">Add</a> (const <a class="el" href="classCLAM_1_1Array.html">Array</a>< <a class="el" href="namespaceCLAM.html#ab9c6321b061069797fcc173f61e8111a">TData</a> > &in, <a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> offset=0)</td></tr> <tr class="memdesc:a3366c033d501973545e1991b94fc9ddc inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Does an additive write of write size number of elements at the current write index onwards from the specified input array starting at the specified offset (default: offset = 0) onwards. <a href="#a3366c033d501973545e1991b94fc9ddc"></a><br/></td></tr> <tr class="memitem:ae9c0fc10ec0eb410bc738bb064d9e0c7 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#ae9c0fc10ec0eb410bc738bb064d9e0c7">IncreaseReadIndex</a> (<a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> step=1)</td></tr> <tr class="memdesc:ae9c0fc10ec0eb410bc738bb064d9e0c7 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Increases the read index by the specified number of elements (default: step = 1). <a href="#ae9c0fc10ec0eb410bc738bb064d9e0c7"></a><br/></td></tr> <tr class="memitem:a7f71b522b698250ad1a6bf6d379c712a inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a7f71b522b698250ad1a6bf6d379c712a">IncreaseWriteIndex</a> (<a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> step=1)</td></tr> <tr class="memdesc:a7f71b522b698250ad1a6bf6d379c712a inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Increases the write index by the specified number of elements (default: step = 1). <a href="#a7f71b522b698250ad1a6bf6d379c712a"></a><br/></td></tr> <tr class="memitem:aeee61bb455b27e630a1b04507b8ce1d5 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#aeee61bb455b27e630a1b04507b8ce1d5">DecreaseReadIndex</a> (<a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> step=1)</td></tr> <tr class="memdesc:aeee61bb455b27e630a1b04507b8ce1d5 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Decreases the read index by the specified number of elements (default: step = 1). <a href="#aeee61bb455b27e630a1b04507b8ce1d5"></a><br/></td></tr> <tr class="memitem:ae53ac4051e2d00009129e682ed969174 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#ae53ac4051e2d00009129e682ed969174">DecreaseWriteIndex</a> (<a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> step=1)</td></tr> <tr class="memdesc:ae53ac4051e2d00009129e682ed969174 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Decreases the write index by the specified number of elements (default: step = 1). <a href="#ae53ac4051e2d00009129e682ed969174"></a><br/></td></tr> <tr class="memitem:af411e6bfe027869a166839e99e06af2f inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#ab9c6321b061069797fcc173f61e8111a">TData</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#af411e6bfe027869a166839e99e06af2f">GetPtrToElement</a> (<a class="el" href="classint.html">int</a> absPos)</td></tr> <tr class="memdesc:af411e6bfe027869a166839e99e06af2f inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer (well, reference) to the element at the specified index. <a href="#af411e6bfe027869a166839e99e06af2f"></a><br/></td></tr> <tr class="memitem:a7189515bca76461f0b7c926f0587ab95 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a7189515bca76461f0b7c926f0587ab95">GetReadSize</a> () const</td></tr> <tr class="memdesc:a7189515bca76461f0b7c926f0587ab95 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current read size. <a href="#a7189515bca76461f0b7c926f0587ab95"></a><br/></td></tr> <tr class="memitem:ac1ba0b92a96b99d758331a8fcc6c6779 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#ac1ba0b92a96b99d758331a8fcc6c6779">GetWriteSize</a> () const</td></tr> <tr class="memdesc:ac1ba0b92a96b99d758331a8fcc6c6779 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current write size. <a href="#ac1ba0b92a96b99d758331a8fcc6c6779"></a><br/></td></tr> <tr class="memitem:a3c7946c7eb92d3d00cebea6db80333d7 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a3c7946c7eb92d3d00cebea6db80333d7">SetReadSize</a> (<a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> size)</td></tr> <tr class="memdesc:a3c7946c7eb92d3d00cebea6db80333d7 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Sets the read size. <a href="#a3c7946c7eb92d3d00cebea6db80333d7"></a><br/></td></tr> <tr class="memitem:a7cc189dccc0aadd63a7e1a503d211c52 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a7cc189dccc0aadd63a7e1a503d211c52">SetWriteSize</a> (<a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> size)</td></tr> <tr class="memdesc:a7cc189dccc0aadd63a7e1a503d211c52 inherit pub_methods_classCLAM_1_1CircularBuffer"><td class="mdescLeft"> </td><td class="mdescRight">Sets the write size. <a href="#a7cc189dccc0aadd63a7e1a503d211c52"></a><br/></td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="inherited"></a> Additional Inherited Members</h2></td></tr> <tr class="inherit_header pro_attribs_classCLAM_1_1CircularBuffer"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classCLAM_1_1CircularBuffer')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer< TData ></a></td></tr> <tr class="memitem:a40b02668c80704b8332b0f443d98a526 inherit pro_attribs_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCLAM_1_1Array.html">Array</a>< <a class="el" href="namespaceCLAM.html#ab9c6321b061069797fcc173f61e8111a">TData</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a40b02668c80704b8332b0f443d98a526">mBuffer</a></td></tr> <tr class="memitem:a4f93010a72621051377ee8931f5aedc0 inherit pro_attribs_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a4f93010a72621051377ee8931f5aedc0">mLogicalSize</a></td></tr> <tr class="memitem:a3c5e504acd155f7c995d6c771338232a inherit pro_attribs_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a3c5e504acd155f7c995d6c771338232a">mReadSize</a></td></tr> <tr class="memitem:a29904a4ee1925b6253f1ed25eef0910c inherit pro_attribs_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a29904a4ee1925b6253f1ed25eef0910c">mWriteSize</a></td></tr> <tr class="memitem:a8f860fa199c23eadd04d205f174ca84f inherit pro_attribs_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a8f860fa199c23eadd04d205f174ca84f">mWriteIndex</a></td></tr> <tr class="memitem:ac7a9b326505f673d8c2db03eeb1bc6c7 inherit pro_attribs_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#ac7a9b326505f673d8c2db03eeb1bc6c7">mReadIndex</a></td></tr> <tr class="memitem:abac65c1073d86000c07a1b60e3c5d172 inherit pro_attribs_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#abac65c1073d86000c07a1b60e3c5d172">mInitialReadOffset</a></td></tr> <tr class="memitem:a4370aa4a8f4a685997c6388156343494 inherit pro_attribs_classCLAM_1_1CircularBuffer"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a4370aa4a8f4a685997c6388156343494">mInitialWriteOffset</a></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Specialization of the <a class="el" href="classCLAM_1_1CircularBuffer.html" title="Generic container-like circular buffer class.">CircularBuffer</a> class for the case of <a class="el" href="classCLAM_1_1Audio.html" title="Audio class with the Data Buffer, information about it (SampleRate, BeginTime), and methods to insert...">Audio</a> chunks. </p> <dl class="section see"><dt>See also:</dt><dd><a class="el" href="classCLAM_1_1CircularBuffer.html" title="Generic container-like circular buffer class.">CircularBuffer</a> </dd></dl> <p>Definition at line <a class="el" href="AudioCircularBuffer_8hxx_source.html#l00036">36</a> of file <a class="el" href="AudioCircularBuffer_8hxx_source.html">AudioCircularBuffer.hxx</a>.</p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a636e0f622d41e4d5eb4a93a79e1ee449"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">CLAM::AudioCircularBuffer::AudioCircularBuffer </td> <td>(</td> <td class="paramname"></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>CONSTRUCTION. </p> <p>Definition at line <a class="el" href="AudioCircularBuffer_8hxx_source.html#l00044">44</a> of file <a class="el" href="AudioCircularBuffer_8hxx_source.html">AudioCircularBuffer.hxx</a>.</p> </div> </div> <a class="anchor" id="adc50de0463dbb769e984aa3256e83823"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">CLAM::AudioCircularBuffer::AudioCircularBuffer </td> <td>(</td> <td class="paramtype"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td> <td class="paramname"><em>bufferSize</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>Definition at line <a class="el" href="AudioCircularBuffer_8hxx_source.html#l00046">46</a> of file <a class="el" href="AudioCircularBuffer_8hxx_source.html">AudioCircularBuffer.hxx</a>.</p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a77fa604de534a31c740417c0c61fd7d3"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void CLAM::AudioCircularBuffer::AddAudio </td> <td>(</td> <td class="paramtype">const <a class="el" href="classCLAM_1_1Audio.html">Audio</a> & </td> <td class="paramname"><em>in</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>Definition at line <a class="el" href="AudioCircularBuffer_8hxx_source.html#l00067">67</a> of file <a class="el" href="AudioCircularBuffer_8hxx_source.html">AudioCircularBuffer.hxx</a>.</p> <p>References <a class="el" href="CircularBuffer_8hxx_source.html#l00347">CLAM::CircularBuffer< TData >::Add()</a>.</p> </div> </div> <a class="anchor" id="af8332691c9e5838c02803917dc346218"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void CLAM::AudioCircularBuffer::NonCopyReadAudio </td> <td>(</td> <td class="paramtype"><a class="el" href="classCLAM_1_1Audio.html">Audio</a> & </td> <td class="paramname"><em>in</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>Definition at line <a class="el" href="AudioCircularBuffer_8hxx_source.html#l00057">57</a> of file <a class="el" href="AudioCircularBuffer_8hxx_source.html">AudioCircularBuffer.hxx</a>.</p> <p>References <a class="el" href="CircularBuffer_8hxx_source.html#l00233">CLAM::CircularBuffer< TData >::NonCopyRead()</a>.</p> </div> </div> <a class="anchor" id="a23faf0e5726a91adc4551d1f923f85e1"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void CLAM::AudioCircularBuffer::ReadAudio </td> <td>(</td> <td class="paramtype"><a class="el" href="classCLAM_1_1Audio.html">Audio</a> & </td> <td class="paramname"><em>in</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>Definition at line <a class="el" href="AudioCircularBuffer_8hxx_source.html#l00052">52</a> of file <a class="el" href="AudioCircularBuffer_8hxx_source.html">AudioCircularBuffer.hxx</a>.</p> <p>References <a class="el" href="CircularBuffer_8hxx_source.html#l00226">CLAM::CircularBuffer< TData >::Read()</a>.</p> </div> </div> <a class="anchor" id="a237c35b20d31fbbff25b6aa95009750e"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void CLAM::AudioCircularBuffer::WriteAudio </td> <td>(</td> <td class="paramtype">const <a class="el" href="classCLAM_1_1Audio.html">Audio</a> & </td> <td class="paramname"><em>in</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>Definition at line <a class="el" href="AudioCircularBuffer_8hxx_source.html#l00062">62</a> of file <a class="el" href="AudioCircularBuffer_8hxx_source.html">AudioCircularBuffer.hxx</a>.</p> <p>References <a class="el" href="CircularBuffer_8hxx_source.html#l00295">CLAM::CircularBuffer< TData >::Write()</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="AudioCircularBuffer_8hxx_source.html">AudioCircularBuffer.hxx</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.1 </small></address> </body> </html>
Cokiee Shell Web 1.0, Coded By Razor
Neueste Kommentare