<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<?xml-stylesheet href="./_c74_ref.xsl" type="text/xsl"?>
<!--This is an automatically generated file. DO NOT EDIT THIS FILE DIRECTLY.-->
<c74object module="rnbo" kind="rnboobject" name="peek~" category="Sampling">
<!--METADATA-->
<metadatalist>
<metadata name="author">Cycling '74</metadata>
<metadata name="tag">RNBO</metadata>
<metadata name="tag">RNBO Sampling</metadata>
</metadatalist>
<digest>Read values from a buffer object.</digest>
<description><p>
Read sample values from specified channel of a named buffer object at signal-rate.
Input values and indices can be specified either as event or signal values}.
</p></description>
<!--ARGUMENTS-->
<objarglist>
<objarg name="buffername" optional="0" type="symbol">
<digest>Buffer to use</digest>
<description><p>
Name of the buffer to read samples from.
</p></description>
</objarg>
<objarg name="channels" optional="1" type="number">
<digest>Number of channels</digest>
<description><p>
Sets the number of output channels, which determines the number of outlets that the peek~ object will have. If the 
<o objname="rnbo_buffer~">buffer~</o>
 object being referenced by peek~ has more channels than the number of outputs of peek~, the extra channels are not played. If the 
<o objname="rnbo_buffer~">buffer~</o>
 object has fewer channels, the extra peek~ outputs will output 0.
</p></description>
</objarg>
</objarglist>
<!--OPTIONS-->
<rnbooptionlist>
<option name="boundmode" size="1" type="enum">
<digest>Set the bound mode for input sample values</digest>
<attributelist>
<attribute name="enumvals">
<enumlist get="1" set="1" type="atom">
<enum name="fold"></enum>
<enum name="clamp"></enum>
<enum name="clip"></enum>
<enum name="wrap"></enum>
<enum name="mirror"></enum>
<enum name="ignore"></enum>
</enumlist>
</attribute>
<attribute name="default" type="enum" value="ignore"></attribute>
</attributelist>
<description><p>
Set the bound mode for input sample values. This determines how values above or below the number of samples in the referenced buffer are handled.
</p></description>
</option>
<option name="buffername" size="1" type="symbol">
<digest>Buffer to use</digest>
<description><p>
Name of the buffer to read samples from.
</p></description>
</option>
<option name="channelmode" size="1" type="enum">
<digest>Set the bound mode for input channel values</digest>
<attributelist>
<attribute name="enumvals">
<enumlist get="1" set="1" type="atom">
<enum name="fold"></enum>
<enum name="clamp"></enum>
<enum name="clip"></enum>
<enum name="wrap"></enum>
<enum name="mirror"></enum>
<enum name="ignore"></enum>
</enumlist>
</attribute>
<attribute name="default" type="enum" value="ignore"></attribute>
</attributelist>
<description><p>
Set the bound mode for input channel selection values. This determines how values sent to the right inlet that are above or below the number of channels in the referenced buffer are handled.
</p></description>
</option>
<option name="channels" size="1" type="number">
<digest>Number of channels</digest>
<attributelist>
<attribute name="default" type="number" value="1"></attribute>
</attributelist>
<description><p>
Sets the number of output channels, which determines the number of outlets that the peek~ object will have. If the 
<o objname="rnbo_buffer~">buffer~</o>
 object being referenced by peek~ has more channels than the number of outputs of peek~, the extra channels are not played. If the 
<o objname="rnbo_buffer~">buffer~</o>
 object has fewer channels, the extra peek~ outputs will output 0.
</p></description>
</option>
<option name="indexmode" size="1" type="enum">
<digest>Set the lookup mode</digest>
<attributelist>
<attribute name="enumvals">
<enumlist get="1" set="1" type="atom">
<enum name="phase"></enum>
<enum name="samples"></enum>
<enum name="signal"></enum>
<enum name="lookup"></enum>
<enum name="wave"></enum>
</enumlist>
</attribute>
<attribute name="default" type="enum" value="samples"></attribute>
</attributelist>
<description><p>
Sets the lookup mode for accessing buffer values (default = samples).
</p></description>
</option>
<option name="interp" size="1" type="enum">
<digest>Set interpolation type</digest>
<attributelist>
<attribute name="enumvals">
<enumlist get="1" set="1" type="atom">
<enum name="linear"></enum>
<enum name="cubic"></enum>
<enum name="spline"></enum>
<enum name="cosine"></enum>
<enum name="step"></enum>
<enum name="none"></enum>
</enumlist>
</attribute>
<attribute name="default" type="enum" value="none"></attribute>
</attributelist>
<description><p>
Sets teh type of interpolation to use when reading samples from the buffer
</p></description>
</option>
</rnbooptionlist>
<!--ATTRIBUTES-->
<rnboattributelist>
<attribute name="buffer" size="1" type="number">
<digest>If multiple buffer names are declared to be used, this sets the currently active buffer using an index [0 based].</digest>
<attributelist>
<attribute name="default" type="number" value="0"></attribute>
</attributelist>

</attribute>
<attribute name="index" size="1" type="auto">
<digest>Index to sample</digest>
<description><p>
The value stored at the specified sample-index is sent out the peek~ object's outlet.
</p></description>
</attribute>
<attribute name="offset" size="1" type="auto">
<digest>Channel offset (zero-based)</digest>
<description><p>
The buffer channel to read samples from, if a multichannel buffer is in use (starting from 0).
</p></description>
</attribute>
</rnboattributelist>
<!--INLETS-->
<rnboinletlist>
<inlet id="inlet_index" name="index" type="auto">
<digest>Index to sample</digest>
<description><p>
The value stored at the specified sample-index is sent out the peek~ object's outlet.
</p></description>
</inlet>
<inlet id="inlet_offset" name="offset" type="auto">
<digest>Channel offset (zero-based)</digest>
<description><p>
The buffer channel to read samples from, if a multichannel buffer is in use (starting from 0).
</p></description>
</inlet>
</rnboinletlist>
<!--OUTLETS-->
<rnbooutletlist>
<outlet id="outlet_out" name="out" type="signal">
<digest>Sampled value.</digest>
<description><p>
The output signal read from the buffer.
</p></description>
</outlet>
<outlet id="outlet_outindex" name="outindex" type="signal">
<digest>Index (in samples).</digest>

</outlet>
</rnbooutletlist>
<!--SEE ALSO-->
<seealsolist>
<seealso name="peek~" type="refpage" module="MSP"></seealso>
<seealso name="rnbo_peek" type="rnborefpage" module="RNBO" display="peek"></seealso>
<seealso name="rnbo_buffer~" type="rnborefpage" module="RNBO" display="buffer~"></seealso>
<seealso name="rnbo_groove~" type="rnborefpage" module="RNBO" display="groove~"></seealso>
<seealso name="rnbo_poke~" type="rnborefpage" module="RNBO" display="poke~"></seealso>
<seealso name="rnbo_record~" type="rnborefpage" module="RNBO" display="record~"></seealso>
<seealso name="rnbo_splat~" type="rnborefpage" module="RNBO" display="splat~"></seealso>
<seealso name="rnbo_wave~" type="rnborefpage" module="RNBO" display="wave~"></seealso>
</seealsolist>
</c74object>