STKDrummer.xml

<refentry id="STKDrummer">
  <indexterm id="IndexStkdrummer"><primary>STKDrummer</primary></indexterm>
  <refentryinfo><title>Signal Generators:STK Opcodes</title></refentryinfo>
  <refmeta>
    <refentrytitle>STKDrummer</refentrytitle>
  </refmeta>
 
  <refnamediv>
    <refname>STKDrummer</refname>
    <refpurpose>
      STKDrummer is a drum sampling synthesizer.
      </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>Plugin opcode in stkopd. This opcode is part of the plugin repository and has to be installed separately. 
    The plugin repository can be found here: <ulink url="https://github.com/csound/plugins"><citetitle>https://github.com/csound/plugins</citetitle></ulink></para>
    <para>
      STKDrummer is a drum sampling synthesizer using raw waves and one-pole filters,
      The drum rawwave files are sampled at 22050 Hz, but will be appropriately interpolated for other sample rates.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis>asignal <command>STKDrummer</command> ifrequency, iamplitude</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Initialization</title>
        <para>
      <emphasis>ifrequency</emphasis> -- Samples being played.
    </para>
   
    <para>
      <emphasis>iamplitude</emphasis> -- Amplitude of note played (range 0-1).
    </para>
  </refsect1>
 
    <refsect1>
    <note>
      <title>Note</title>
      <para>
         The code for this opcode is taken directly from the Drummer class in the Synthesis Toolkit in C++ by Perry R. Cook and Gary P. Scavone. More on the STK classes can be found here:  
<ulink url="https://ccrma.stanford.edu/software/stk/classes.html"><citetitle>https://ccrma.stanford.edu/software/stk/classes.html</citetitle></ulink>
</para>
    </note>
  </refsect1>
  
  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the STKDrummer opcode. It uses the file <ulink url="examples/STKDrummer.csd"><citetitle>STKDrummer.csd</citetitle></ulink>.
     
      <example>
        <title>Example of the STKDrummer opcode.</title>
        <xi:include href="examples-xml/STKDrummer.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>
 
  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="STKClarinet"><citetitle>STKClarinet</citetitle></link>.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &namemichael; (after &nameperry;)</member>
        <member>Irreducible Productions</member>
        <member>New York, NY</member>
      </simplelist>
    </para>
    <para>New in Csound version 5.11</para>
  </refsect1>
</refentry>