JackoFreewheel.xml

<refentry id="JackoFreewheel">
  <indexterm id="IndexJackoFreewheel"><primary>JackoFreewheel</primary></indexterm>
  <refentryinfo><title>Jacko Opcodes</title></refentryinfo>
  <refmeta>
    <refentrytitle>JackoFreewheel</refentrytitle>
  </refmeta>
  
  <refnamediv>
    <refname>JackoFreewheel</refname>
    <refpurpose>
      Turns Jack's freewheeling mode on or off. 
    </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>
      Turns Jack's freewheeling mode on or off. 
    </para>
    
    <para>
      When freewheeling is on, if supported by the rest 
      of the Jack system, Csound will run as fast as possible, 
      which may be either faster or slower than real time.
    </para>
    
    <para>
      This is essential for rendering scores that are too
      dense for real-time performance to a soundfile, 
      without xruns or dropouts.
    </para>
  </refsect1>
  
  <refsect1>
    <title>Syntax</title>
    <synopsis><command>JackoFreewheel </command>[ienabled]</synopsis>
  </refsect1>
  
  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>ienabled</emphasis> -- Turns freewheeling on (the default) or off.
    </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 JackoFreewheel opcode. It uses the file <ulink url="examples/JackoFreewheel.csd"><citetitle>JackoFreewheel.csd</citetitle></ulink>.
            <example>
        <title>Example of the JackoFreewheel 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/JackoFreewheel.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="JackoInfo"><citetitle>JackoInfo</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>