EX.MusicBuffer.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>webdoc: Class: MusicBuffer</title>

    <script src="scripts/prettify.js"> </script>
    <script src="scripts/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/tomorrow.min.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
    <div id="main">
        <h1 class="page-title">Class: MusicBuffer</h1>
        

<section>

<header>
    
        <h2>
            
            EX.MusicBuffer
            
        </h2>
        
        
</header>

<article>
    <div class="container-overview">
        
            
        <h4 class="name" id="MusicBuffer">
            MusicBuffer
        </h4>
    

<dl class="details">

    
        <dt class="mixes">Mixes In:</dt>
        <dd class="mixes">
          <ul>
            
                <li><a href="EX.LowpassFilter.html">EX.LowpassFilter</a></li>
                
          </ul>
      </dd>
    

</dl>


    </div>

    
        <h3 class="subsection-title">Extends</h3>

        
<ul>
  
    <li><a href="EX.AbstractFileBuffer.html">EX.AbstractFileBuffer</a></li>
  
</ul>

    
        <h3 class="subsection-title">Members</h3>

        
<h4 class="name" id="dirtyID"><span class="type-signature"></span>dirtyID<span class="type-signature"> :number</span></h4>


    <h5>Type:</h5>
    <ul>
        <li>
            
        <span class="param-type">number</span>
        

        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EX.AbstractFileBuffer.html#dirtyID">[object Object]</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="flushID"><span class="type-signature"></span>flushID<span class="type-signature"> :number</span></h4>


    <h5>Type:</h5>
    <ul>
        <li>
            
        <span class="param-type">number</span>
        

        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EX.AbstractFileBuffer.html#flushID">[object Object]</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="pointer"><span class="type-signature"></span>pointer<span class="type-signature"> :number</span></h4>


    <h5>Type:</h5>
    <ul>
        <li>
            
        <span class="param-type">number</span>
        

        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EX.AbstractFileBuffer.html#pointer">[object Object]</a>
    </li></ul></dd>
    

</dl>


        <h3 class="subsection-title">Methods</h3>

        
        <h4 class="name" id="update">
            <span class="type-signature"></span>update<span class="signature">()</span><span class="type-signature"></span>
        </h4>
    

    <div class="description">
        <p>Update the buffer's contents w.r.t the file.</p>
    </div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EX.AbstractFileBuffer.html#update">[object Object]</a>
    </li></ul></dd>
    

</dl>


        <h4 class="name" id="createFileBuffer">
            <span class="type-signature"></span>createFileBuffer<span class="signature">(file)</span><span class="type-signature"></span>
        </h4>
    

        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
    <tr>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            

            <td class="type">
            
                
            </td>

            
            <td class="description last">
                
                
            </td>
        </tr>
    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EX.AbstractFileBuffer.html#createFileBuffer">[object Object]</a>
    </li></ul></dd>
    

</dl>


        <h4 class="name" id="cloneFile">
            <span class="type-signature"></span>cloneFile<span class="signature">(file)</span><span class="type-signature"></span>
        </h4>
    

        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
    <tr>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            

            <td class="type">
            
                
            </td>

            
            <td class="description last">
                
                
            </td>
        </tr>
    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EX.AbstractFileBuffer.html#cloneFile">[object Object]</a>
    </li></ul></dd>
    

</dl>


        <h4 class="name" id="next">
            <span class="type-signature"></span>next<span class="signature">()</span><span class="type-signature"></span>
        </h4>
    

    <div class="description">
        <p>Shift the buffer-frame right</p>
    </div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EX.AbstractFileBuffer.html#next">[object Object]</a>
    </li></ul></dd>
    

</dl>


        <h4 class="name" id="sync">
            <span class="type-signature"></span>sync<span class="signature">(forceFS)</span><span class="type-signature"></span>
        </h4>
    

        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
    <tr>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            

            <td class="type">
            
                
            </td>

            
            <td class="description last">
                
                
            </td>
        </tr>
    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EX.AbstractFileBuffer.html#sync">[object Object]</a>
    </li></ul></dd>
    

</dl>


        <h4 class="name" id="setUpperCutoff">
            <span class="type-signature"></span>setUpperCutoff<span class="signature">(t)</span><span class="type-signature"></span>
        </h4>
    

    <div class="description">
        <p>The max. frequency to be allowed in the stream</p>
    </div>


        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
    <tr>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            

            <td class="type">
            
                
            </td>

            
            <td class="description last">
                threshold
                
            </td>
        </tr>
    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EX.LowpassFilter.html#setUpperCutoff">[object Object]</a>
    </li></ul></dd>
    

</dl>


        <h3 class="subsection-title">Events</h3>

        
        <h4 class="name" id="shift">
            shift
        </h4>
    

    <div class="description">
        <p>Fired when the stream buffer frame is shifted, e.g. when {@code next} or {@code prev}
is called.</p>
    </div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="EX.AbstractFileBuffer.html#shift">[object Object]</a>
    </li></ul></dd>
    

</dl>


</article>

</section>


    </div>
    <nav>
        <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="EX.html">EX</a></li><li><a href="EX.conditional.html">EX.conditional</a></li><li><a href="EX.filters.html">EX.filters</a></li></ul><h3>Classes</h3><ul><li><a href="ArcUtils.html">ArcUtils</a></li><li><a href="EX.AbstractFileBuffer.html">EX.AbstractFileBuffer</a></li><li><a href="EX.MusicBuffer.html">EX.MusicBuffer</a></li><li><a href="EX.StreamBuffer.html">EX.StreamBuffer</a></li><li><a href="EX.StreamBuffer.Reducer.html">EX.StreamBuffer.Reducer</a></li><li><a href="EX.StreamBuilder.html">EX.StreamBuilder</a></li><li><a href="EX.TiledStreamBuffer.html">EX.TiledStreamBuffer</a></li></ul><h3>Interfaces</h3><ul><li><a href="EX.IFileBuffer.html">EX.IFileBuffer</a></li></ul><h3>Events</h3><ul><li><a href="EX.AbstractFileBuffer.html#shift">EX.AbstractFileBuffer.shift</a></li><li><a href="EX.MusicBuffer.html#shift">EX.MusicBuffer.shift</a></li><li><a href="EX.StreamBuffer.html#shift">EX.StreamBuffer.shift</a></li><li><a href="EX.StreamBuilder.html#built">EX.StreamBuilder.built</a></li><li><a href="EX.TiledStreamBuffer.html#shift">EX.TiledStreamBuffer.shift</a></li></ul><h3>Mixins</h3><ul><li><a href="EX.LowpassFilter.html">EX.LowpassFilter</a></li></ul>
    </nav>
    <br class="clear">
    <footer>
        Documentation generated by <a href="https://github.com/jsdoc/jsdoc">webdoc 1</a>
    </footer>
    <script> prettyPrint(); </script>
    <script src="scripts/linenumber.js"> </script>
</body>
</html>