JackoMidiInConnect.xml

<refentry id="JackoMidiInConnect">
  <indexterm id="IndexJackoMidiInConnect"><primary>JackoMidiInConnect</primary></indexterm>
  <refentryinfo><title>Jacko Opcodes</title></refentryinfo>
  <refmeta>
    <refentrytitle>JackoMidiInConnect</refentrytitle>
  </refmeta>
  
  <refnamediv>
    <refname>JackoMidiInConnect</refname>
    <refpurpose>
      Creates a MIDI  connection from a Jack port to Csound.
    </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>
    <para>
    Plugin opcode in jacko. 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>
      In the orchestra header, creates a MIDI connection 
      from an external Jack MIDI output port to this instance of Csound.
    </para>
  </refsect1>
  
  <refsect1>
    <title>Syntax</title>
    <synopsis><command>JackoMidiInConnect </command>SexternalPortName, ScsoundPortName</synopsis>
  </refsect1>
  
  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>SexternalPortName</emphasis> -- The full name ("clientname:portname") 
      of an external Jack MIDI output port.
    </para>

    <para>
      <emphasis>ScsoundPortName</emphasis> -- The short name ("portname") 
      of the internal Jack MIDI input port.
    </para>

    <para> 
      Must be used in conjunction with the 
      -M0 -+rtmidi=null Csound command-line options. 
      Can be used in with the MIDI inter-operability
      command-line options and/or opcodes to enable the 
      use of ordinary Csound instrument definitions to 
      render external scores or MIDI sequences.
    </para>
    
    <para> 
      Note that Csound can connect to ALSA ports through Jack,
      but in that case you will have to identify the port by
      its alias in the JackInfo printout.
    </para>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      The actual  MIDI events will be received in the 
      regular Csound way, i.e. through a MIDI driver 
      and the sensevents mechanism, rather than through 
      a Jack input port opcode. 
    </para>
    
    <para> 
      The granularity of timing is Csound's kperiod.
    </para>
  </refsect1>
     
  <note>works with an already running Jack daemon. Do not use -+rtaudio=jack in CsOptions</note>
 
  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the JackoMidiInConnect opcode. It uses the file <ulink url="examples/JackoMidiInConnect.csd"><citetitle>JackoMidiInConnect.csd</citetitle></ulink>.
          <example>
        <title>Example of the JackoMidiInConnect 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/JackoMidiInConnect.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>
  
  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="JackoInit"><citetitle>JackoInfo</citetitle></link>, 
      <link linkend="JackoInfo"><citetitle>JackoInfo</citetitle></link>, 
      <link linkend="JackoFreewheel"><citetitle>JackoFreewheel</citetitle></link>, 
      <link linkend="JackoAudioInConnect"><citetitle>JackoAudioOutConnect</citetitle></link>, 
      <link linkend="JackoAudioOutConnect"><citetitle>JackoAudioOutConnect</citetitle></link>, 
      <link linkend="JackoMidiOutConnect"><citetitle>JackoMidiOutConnect</citetitle></link>, 
      <link linkend="JackoOn"><citetitle>JackoOn</citetitle></link>, 
      <link linkend="JackoAudioIn"><citetitle>JackoAudioIn</citetitle></link>, 
      <link linkend="JackoAudioOut"><citetitle>JackoAudioOut</citetitle></link>, 
      <link linkend="JackoMidiOut"><citetitle>JackoMidiOut</citetitle></link>, 
      <link linkend="JackoNoteOut"><citetitle>JackoNoteOut</citetitle></link>, 
      <link linkend="JackoTransport"><citetitle>JackoTransport</citetitle></link>.
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>By: &namemichael; 2010</para>
  </refsect1>

</refentry>