JackoInfo.xml

<refentry id="JackoInfo">
  <indexterm id="IndexJackoInfo"><primary>JackoInfo</primary></indexterm>
  <refentryinfo><title>Jacko Opcodes</title></refentryinfo>
  <refmeta>
    <refentrytitle>JackoInfo</refentrytitle>
  </refmeta>
  
  <refnamediv>
    <refname>JackoInfo</refname>
    <refpurpose>
      Prints information about the Jack system.
    </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>
      Prints the Jack daemon and client names, the
      sampling rate and frames per period, 
      and all active Jack port names, 
      types, states, and connections.
    </para>
  </refsect1>
  
  <refsect1>
    <title>Syntax</title>
    <synopsis><command>JackoInfo </command></synopsis>
  </refsect1>
  
  <refsect1>
    <title>Initialization</title>
    <para>
      May be called any number of times in the orchestra header,
      for example both before and after creating Jack ports
      in the Csound orchestra header.
    </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 JackoInfo opcode. It uses the file <ulink url="examples/JackoInfo.csd"><citetitle>JackInfo.csd</citetitle></ulink>.
      <example>
        <title>Example of the JackoInfo 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/JackoInfo.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>
  
  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="JackoInit"><citetitle>JackoInit</citetitle></link>, 
      <link linkend="JackoFreewheel"><citetitle>JackoFreewheel</citetitle></link>, 
      <link linkend="JackoAudioInConnect"><citetitle>JackoAudioInConnect</citetitle></link>, 
      <link linkend="JackoAudioOutConnect"><citetitle>JackoAudioOutConnect</citetitle></link>, 
      <link linkend="JackoMidiInConnect"><citetitle>JackoMidiInConnect</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>