~ubuntu-branches/ubuntu/trusty/csound-manual/trusty-proposed

<refentry id="vstaudio">

<indexterm id="IndexVstAudio"><primary>vstaudio</primary></indexterm>

  <refentryinfo><title>Plugin Hosting:VST</title></refentryinfo>

  <refmeta>

    <refentrytitle>vstaudio, vstaudiog</refentrytitle>

  </refmeta>

  

  <refnamediv>

    <refname>vstaudio</refname>

    <refpurpose>VST audio output.

    </refpurpose>

  </refnamediv>

  <refsect1>

    <title>Syntax</title>

    <synopsis>aout1,aout2 <command>vstaudio</command> instance, [ain1, ain2]</synopsis>

    <synopsis>aout1,aout2 <command>vstaudiog</command> instance, [ain1, ain2]</synopsis>

  </refsect1>

  <refsect1>

    <title>Description</title>

    <para><emphasis>vstaudio</emphasis> and <emphasis>vstaudiog</emphasis>

      are used for sending and receiving audio from a VST plugin.</para>

    <para><emphasis>vstaudio</emphasis> is used within an instrument

      definition that contains a <emphasis>vstmidiout</emphasis> or

      <emphasis>vstnote</emphasis> opcode. It outputs audio for only that

      one instrument. Any audio remaining in the plugin after the end of the

      note, for example a reverb tail, will be cut off and should be dealt

      with using a damping envelope.</para>

    <para><emphasis>vstaudiog</emphasis> (vstaudio global) is used in a

      separate instrument to process audio from any number of VST notes or

      MIDI events that share the same VST plugin instance (instance). The

      <emphasis>vstaudiog</emphasis> instrument must be numbered higher than

      all the instruments receiving notes or MIDI data, and the note

      controlling the vstplug instrument must have an indefinite duration,

      or at least a duration as long as the VST plugin is active.</para>

  </refsect1>

  <refsect1>

    <title>Initialization</title>

    <para><emphasis>instance</emphasis> - the number which identifies the

      plugin, to be passed to other vst4cs opcodes.</para>

  </refsect1>

  <refsect1>

    <title>Performance</title>

    <para><emphasis>aout1, aout2</emphasis> - the audio output received from

      the plugin.</para>

    <para><emphasis>ain1, ain2</emphasis> - the audio input sent to the

      plugin.</para>

  </refsect1>

  <refsect1>

    <title>Examples</title>

    <para>

      Here is an example of the use of the <emphasis>vstaudio</emphasis> opcode. It uses the file <ulink url="examples/vst4cs.csd"><citetitle>vst4cs.csd</citetitle></ulink>.

      <example>

        <title>Example of the <emphasis>vstaudio</emphasis> opcode.</title>

        <para>See the sections <link linkend="UsingRealTime"><citetitle>Real-time Audio</citetitle></link> and <link linkend="CommandFlags"><citetitle>Command Line Flags</citetitle></link> for more information on using command line flags.</para>

          <xi:include href="examples-xml/vst4cs.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

      </example>

    </para>

  <refsect1>

    <title>Credits</title>

    <para>By: &nameandres; and &namemichael;</para>

    <para>Uses code from Hermann Seib's VSTHost and Thomas Grill's vst~

      object.</para>

    <para>VST is a trademark of Steinberg Media Technologies GmbH.

      VST Plug-In Technology by Steinberg.</para>

  </refsect1>

</refentry>