JackoAudioIn.xml

<refentry id="JackoAudioIn">
  <indexterm id="IndexJackoAudioIn"><primary>JackoAudioIn</primary></indexterm>
  <refentryinfo><title>Jacko Opcodes</title></refentryinfo>
  <refmeta>
    <refentrytitle>JackoAudioIn</refentrytitle>
  </refmeta>
  
  <refnamediv>
    <refname>JackoAudioIn</refname>
    <refpurpose>
      Receives an audio signal from a Jack port.
    </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>
      Receives an audio signal from a Jack audio input port 
      inside this instance of Csound, which in turn has 
      received the signal from its connected external Jack 
      audio output port.
    </para>
  </refsect1>
  
  <refsect1>
    <title>Syntax</title>
    <synopsis>asignal <command>JackoAudioIn </command>ScsoundPortName</synopsis>
  </refsect1>
  
  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>ScsoundPortName</emphasis> -- The short name ("portname") 
      of the internal Jack audio input port.
    </para>    
  </refsect1>
  
  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>asignal</emphasis> -- Audio received from the external Jack 
      output port to which ScsoundPortName is connected.
    </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 JackoAudioIn opcode. It uses the file <ulink url="examples/JackoAudioIn.csd"><citetitle>JackoAudioIn.csd</citetitle></ulink>.
      <example>
        <title>Example of the JackoAudioIn 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/JackoAudioIn.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="JackoMidiInConnect"><citetitle>JackoMidiInConnect</citetitle></link>, 
      <link linkend="JackoMidiOutConnect"><citetitle>JackoMidiOutConnect</citetitle></link>, 
      <link linkend="JackoOn"><citetitle>JackoOn</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>