Sophie

Sophie

distrib > Mageia > 5 > x86_64 > media > core-release > by-pkgid > b707d9a4ee443103660a75ccb6e51334 > files > 2549

csound-doc-5.19.01-10.mga5.noarch.rpm

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>schedkwhennamed</title>
    <link rel="stylesheet" type="text/css" href="csound.css" />
    <meta name="generator" content="DocBook XSL Stylesheets V1.76.1" />
    <link rel="home" href="index.html" title="The Canonical Csound Reference Manual" />
    <link rel="up" href="OpcodesTop.html" title="Orchestra Opcodes and Operators" />
    <link rel="prev" href="schedkwhen.html" title="schedkwhen" />
    <link rel="next" href="schedule.html" title="schedule" />
  </head>
  <body>
    <div class="navheader">
      <table width="100%" summary="Navigation header">
        <tr>
          <th colspan="3" align="center">schedkwhennamed</th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="schedkwhen.html">Prev</a> </td>
          <th width="60%" align="center">Orchestra Opcodes and Operators</th>
          <td width="20%" align="right"> <a accesskey="n" href="schedule.html">Next</a></td>
        </tr>
      </table>
      <hr />
    </div>
    <div class="refentry" title="schedkwhennamed">
      <a id="schedkwhennamed"></a>
      <div class="titlepage"></div>
      <a id="IndexSchedkwhennamed" class="indexterm"></a>
      <div class="refnamediv">
        <h2>
          <span class="refentrytitle">schedkwhennamed</span>
        </h2>
        <p>schedkwhennamed — 
      Similar to schedkwhen but uses a named instrument at init-time.
    </p>
      </div>
      <div class="refsect1" title="Description">
        <a id="idp41525808"></a>
        <h2>Description</h2>
        <p>
      Similar to <a class="link" href="schedkwhen.html" title="schedkwhen"><em class="citetitle">schedkwhen</em></a> but uses a named instrument at init-time.
    </p>
      </div>
      <div class="refsect1" title="Syntax">
        <a id="idp41526944"></a>
        <h2>Syntax</h2>
        <pre class="synopsis"><span class="command"><strong>schedkwhennamed</strong></span> ktrigger, kmintim, kmaxnum, "name", kwhen, kdur \
      [, ip4] [, ip5] [...]</pre>
      </div>
      <div class="refsect1" title="Initialization">
        <a id="idp41588272"></a>
        <h2>Initialization</h2>
        <p>
      <span class="emphasis"><em>ip4, ip5, ...</em></span> -- Equivalent to p4, p5, etc., in a score <a class="link" href="i.html" title="i Statement (Instrument or Note Statement)"><em class="citetitle">i statement</em></a>
    </p>
      </div>
      <div class="refsect1" title="Performance">
        <a id="idp41589568"></a>
        <h2>Performance</h2>
        <p>
      <span class="emphasis"><em>ktrigger</em></span> -- triggers a new score event. If <span class="emphasis"><em>ktrigger</em></span> is 0, no new event is triggered.
    </p>
        <p>
      <span class="emphasis"><em>kmintim</em></span> -- minimum time between generated events, in seconds. If <span class="emphasis"><em>kmintim</em></span> is less than or equal to 0, no time limit exists.
    </p>
        <p>
      <span class="emphasis"><em>kmaxnum</em></span> -- maximum number of simultaneous instances of named instrument allowed. If the number of existant instances of the named instrument is greater than or equal to <span class="emphasis"><em>kmaxnum</em></span>, no new event is generated. If <span class="emphasis"><em>kmaxnum</em></span> is less than or equal to 0, it is not used to limit event generation.
    </p>
        <p>
      <span class="emphasis"><em>"name"</em></span> -- the named instrument's name.
    </p>
        <p>
      <span class="emphasis"><em>kwhen</em></span> -- start time of the new event. Equivalent to p2 in a score <a class="link" href="i.html" title="i Statement (Instrument or Note Statement)"><em class="citetitle">i statement</em></a>. Measured from the time of the triggering event. <span class="emphasis"><em>kwhen</em></span> must be greater than or equal to 0. If <span class="emphasis"><em>kwhen</em></span> greater than 0, the instrument will not be initialized until the actual time when it should start performing.
    </p>
        <p>
      <span class="emphasis"><em>kdur</em></span> -- duration of event. Equivalent to p3 in a score <a class="link" href="i.html" title="i Statement (Instrument or Note Statement)"><em class="citetitle">i statement</em></a>. If <span class="emphasis"><em>kdur</em></span> is 0, the instrument will only do an initialization pass, with no performance. If <span class="emphasis"><em>kdur</em></span> is negative, a held note is initiated. (See <a class="link" href="ihold.html" title="ihold"><em class="citetitle">ihold</em></a> and <a class="link" href="i.html" title="i Statement (Instrument or Note Statement)"><em class="citetitle">i statement</em></a>.)
    </p>
        <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
          <table border="0" summary="Note">
            <tr>
              <td rowspan="2" align="center" valign="top" width="25">
                <img alt="[Note]" src="images/note.png" />
              </td>
              <th align="left">Note</th>
            </tr>
            <tr>
              <td align="left" valign="top">
                <p> While waiting for events to be triggered by <span class="emphasis"><em>schedkwhennamed</em></span>, the performance must be kept going, or Csound may quit if no score events are expected. To guarantee continued performance, an <a class="link" href="f.html" title="f Statement (or Function Table Statement)"><em class="citetitle">f0 statement</em></a> may be used in the score.</p>
              </td>
            </tr>
          </table>
        </div>
        <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
          <table border="0" summary="Note">
            <tr>
              <td rowspan="2" align="center" valign="top" width="25">
                <img alt="[Note]" src="images/note.png" />
              </td>
              <th align="left">Note</th>
            </tr>
            <tr>
              <td align="left" valign="top">
                <p> Note that the <span class="emphasis"><em>schedkwhennamed</em></span> opcode can't accept string p-fields. If you need to pass strings when instantiating an instrument, use the <a class="link" href="scoreline.html" title="scoreline"><em class="citetitle">scoreline</em></a> or <a class="link" href="scoreline_i.html" title="scoreline_i"><em class="citetitle">scoreline_i</em></a> opcode.</p>
              </td>
            </tr>
          </table>
        </div>
      </div>
      <div class="refsect1" title="Examples">
        <a id="idp41599888"></a>
        <h2>Examples</h2>
        <p>
      Here is an example of the schedkwhennamed opcode. It uses the file <a class="ulink" href="examples/schedkwhennamed.csd" target="_top"><em class="citetitle">schedkwhennamed.csd</em></a>.

      </p>
        <div class="example">
          <a id="idp41600888"></a>
          <p class="title">
            <strong>Example 743. Example of the schedkwhennamed opcode.</strong>
          </p>
          <div class="example-contents">
            <p>See the sections <a class="link" href="UsingRealTime.html" title="Real-Time Audio"><em class="citetitle">Real-time Audio</em></a> and <a class="link" href="CommandFlags.html" title="Csound command line"><em class="citetitle">Command Line Flags</em></a> for more information on using command line flags.</p>
            <pre class="programlisting">
<span class="csdtag">&lt;CsoundSynthesizer&gt;</span>
<span class="csdtag">&lt;CsOptions&gt;</span>
<span class="comment">; Select audio/midi flags here according to platform</span>
<span class="comment">; Audio out   Audio in    No messages</span>
-odac           -iadc     -d
<span class="comment">; For Non-realtime ouput leave only the line below:</span>
<span class="comment">; -o schedkwhennamed.wav -W ;;; for file output any platform</span>
<span class="csdtag">&lt;/CsOptions&gt;</span>
<span class="csdtag">&lt;CsInstruments&gt;</span>

  <span class="ohdr">sr</span>	    <span class="op">=</span>  48000
  <span class="ohdr">ksmps</span>	    <span class="op">=</span>  16
  <span class="ohdr">nchnls</span>    <span class="op">=</span>  2
  <span class="ohdr">0dbfs</span>	    <span class="op">=</span>  1

<span class="comment">; Example by Jonathan Murphy 2007</span>

  gSinstr2  <span class="op">=</span>  "printer"

    <span class="oblock">instr</span> 1

  ktrig	    <span class="opc">metro</span>     1
<span class="octrl">if</span> (ktrig <span class="op">==</span> 1) then
  <span class="comment">;Call instrument "printer" once per second</span>
	    <span class="opc">schedkwhennamed</span>   ktrig, 0, 1, gSinstr2, 0, 1

<span class="octrl">endif</span>

    <span class="oblock">endin</span>

    <span class="oblock">instr</span> printer

  ktime	    <span class="opc">timeinsts</span>
	    <span class="opc">printk2</span>   ktime

    <span class="oblock">endin</span>

<span class="csdtag">&lt;/CsInstruments&gt;</span>
<span class="csdtag">&lt;CsScore&gt;</span>
<span class="stamnt">i</span>1 0 10
<span class="stamnt">e</span>
<span class="csdtag">&lt;/CsScore&gt;</span>
<span class="csdtag">&lt;/CsoundSynthesizer&gt;</span>
</pre>
          </div>
        </div>
        <p><br class="example-break" />
    </p>
      </div>
      <div class="refsect1" title="See also">
        <a id="idp41603184"></a>
        <h2>See also</h2>
        <p><a class="link" href="event.html" title="event"><em class="citetitle">event</em></a>,
    <a class="link" href="event_i.html" title="event_i"><em class="citetitle">event_i</em></a>,
    <a class="link" href="schedule.html" title="schedule"><em class="citetitle">schedule</em></a>,
    <a class="link" href="schedwhen.html" title="schedwhen"><em class="citetitle">schedwhen</em></a>,
    <a class="link" href="schedkwhen.html" title="schedkwhen"><em class="citetitle">schedkwhen</em></a>,
    <a class="link" href="scoreline.html" title="scoreline"><em class="citetitle">scoreline</em></a>,
    <a class="link" href="scoreline_i.html" title="scoreline_i"><em class="citetitle">scoreline_i</em></a></p>
      </div>
      <div class="refsect1" title="Credits">
        <a id="idp41606952"></a>
        <h2>Credits</h2>
        <p>
      </p>
        <table border="0" summary="Simple list" class="simplelist">
          <tr>
            <td>Author: Rasmus Ekman</td>
          </tr>
          <tr>
            <td>EMS, Stockholm, Sweden</td>
          </tr>
        </table>
        <p>
    </p>
        <p>New in Csound version 4.23</p>
      </div>
    </div>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left"><a accesskey="p" href="schedkwhen.html">Prev</a> </td>
          <td width="20%" align="center">
            <a accesskey="u" href="OpcodesTop.html">Up</a>
          </td>
          <td width="40%" align="right"> <a accesskey="n" href="schedule.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">schedkwhen </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top"> schedule</td>
        </tr>
      </table>
    </div>
  </body>
</html>