<?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>schedwhen</title>
<link rel="stylesheet" href="csound.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2" />
<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="schedule.html" title="schedule" />
<link rel="next" href="seed.html" title="seed" />
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">schedwhen</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="schedule.html">Prev</a> </td>
<th width="60%" align="center">Orchestra Opcodes and Operators</th>
<td width="20%" align="right"> <a accesskey="n" href="seed.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="refentry" title="schedwhen">
<a id="schedwhen"></a>
<div class="titlepage"></div>
<a id="IndexSchedwhen" class="indexterm"></a>
<div class="refnamediv">
<h2>
<span class="refentrytitle">schedwhen</span>
</h2>
<p>schedwhen —
Adds a new score event.
</p>
</div>
<div class="refsect1" title="Description">
<a id="id3178752"></a>
<h2>Description</h2>
<p>
Adds a new score event.
</p>
</div>
<div class="refsect1" title="Syntax">
<a id="id3178762"></a>
<h2>Syntax</h2>
<pre class="synopsis"><span class="command"><strong>schedwhen</strong></span> ktrigger, kinsnum, kwhen, kdur [, ip4] [, ip5] [...]</pre>
<pre class="synopsis"><span class="command"><strong>schedwhen</strong></span> ktrigger, "insname", kwhen, kdur [, ip4] [, ip5] [...]</pre>
</div>
<div class="refsect1" title="Initialization">
<a id="id3178830"></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="id3178852"></a>
<h2>Performance</h2>
<p>
<span class="emphasis"><em>kinsnum</em></span> -- instrument number. Equivalent to p1 in a score <a class="link" href="i.html" title="i Statement (Instrument or Note Statement)"><em class="citetitle">i statement</em></a>.
</p>
<p>
<span class="emphasis"><em><span class="quote">“<span class="quote">insname</span>”</span></em></span> -- A string (in double-quotes) representing a named instrument.
</p>
<p>
<span class="emphasis"><em>ktrigger</em></span> -- trigger value for new event
</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>.
</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>.
</p>
<p>
<span class="emphasis"><em>schedwhen</em></span> adds a new score event. The event is only scheduled when the k-rate value <span class="emphasis"><em>ktrigger</em></span> is first non-zero. The arguments, including options, are the same as in a score. The <span class="emphasis"><em>kwhen</em></span> time (p2) is measured from the time of this event.
</p>
<p>
If the duration is zero or negative the new event is of MIDI type, and inherits the release sub-event from the scheduling instruction.
</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> Note that the <span class="emphasis"><em>schedwhen</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="id3179830"></a>
<h2>Examples</h2>
<p>
Here is an example of the schedwhen opcode. It uses the file <a class="ulink" href="examples/schedwhen.csd" target="_top"><em class="citetitle">schedwhen.csd</em></a>.
</p>
<div class="example">
<a id="id3179846"></a>
<p class="title">
<b>Example 547. Example of the schedwhen opcode.</b>
</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"><CsoundSynthesizer></span>
<span class="csdtag"><CsOptions></span>
<span class="comment">; Select audio/midi flags here according to platform</span>
<span class="comment">; Audio out Audio in</span>
-odac -iadc <span class="comment">;;;RT audio I/O</span>
<span class="comment">; For Non-realtime ouput leave only the line below:</span>
<span class="comment">; -o schedwhen.wav -W ;;; for file output any platform</span>
<span class="csdtag"></CsOptions></span>
<span class="csdtag"><CsInstruments></span>
<span class="comment">; Initialize the global variables.</span>
<span class="ohdr">sr</span> <span class="op">=</span> 44100
<span class="ohdr">kr</span> <span class="op">=</span> 44100
<span class="ohdr">ksmps</span> <span class="op">=</span> 1
<span class="ohdr">nchnls</span> <span class="op">=</span> 1
<span class="comment">; Instrument #1 - oscillator with a high note.</span>
<span class="oblock">instr</span> 1
<span class="comment">; Use the fourth p-field as the trigger.</span>
ktrigger <span class="op">=</span> p4
kinsnum <span class="op">=</span> 2
kwhen <span class="op">=</span> 0
kdur <span class="op">=</span> p3
<span class="comment">; Play Instrument #2 at the same time, if the trigger is set.</span>
<span class="opc">schedwhen</span> ktrigger, kinsnum, kwhen, kdur
<span class="comment">; Play a high note.</span>
a1 <span class="opc">oscils</span> 10000, 880, 1
<span class="opc">out</span> a1
<span class="oblock">endin</span>
<span class="comment">; Instrument #2 - oscillator with a low note.</span>
<span class="oblock">instr</span> 2
<span class="comment">; Play a low note.</span>
a1 <span class="opc">oscils</span> 10000, 220, 1
<span class="opc">out</span> a1
<span class="oblock">endin</span>
<span class="csdtag"></CsInstruments></span>
<span class="csdtag"><CsScore></span>
<span class="comment">; Table #1, a sine wave.</span>
<span class="stamnt">f</span> 1 0 16384 10 1
<span class="comment">; p4 = trigger for Instrument #2 (when p4 > 0).</span>
<span class="comment">; Play Instrument #1 for half a second, trigger Instrument #2.</span>
<span class="stamnt">i</span> 1 0 0.5 1
<span class="comment">; Play Instrument #1 for half a second, no trigger.</span>
<span class="stamnt">i</span> 1 1 0.5 0
<span class="stamnt">e</span>
<span class="csdtag"></CsScore></span>
<span class="csdtag"></CsoundSynthesizer></span>
</pre>
</div>
</div>
<p><br class="example-break" />
</p>
</div>
<div class="refsect1" title="See also">
<a id="id3179884"></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="schedkwhen.html" title="schedkwhen"><em class="citetitle">schedkwhen</em></a>,
<a class="link" href="schedkwhennamed.html" title="schedkwhennamed"><em class="citetitle">schedkwhennamed</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="id3179947"></a>
<h2>Credits</h2>
<p>
</p>
<table border="0" summary="Simple list" class="simplelist">
<tr>
<td>Author: John ffitch</td>
</tr>
<tr>
<td>University of Bath/Codemist Ltd.</td>
</tr>
<tr>
<td>Bath, UK</td>
</tr>
<tr>
<td>November 1998</td>
</tr>
</table>
<p>
</p>
<p>Example written by Kevin Conder.</p>
<p>New in Csound version 3.491</p>
<p>Based on work by Gabriel Maldonado</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="schedule.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="seed.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">schedule </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> seed</td>
</tr>
</table>
</div>
</body>
</html>
