Help/Streams-Patterns-Events/EventStreamPlayer.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <meta http-equiv="Content-Style-Type" content="text/css">
   6 <title></title>
   7 <meta name="Generator" content="Cocoa HTML Writer">
   8 <meta name="CocoaVersion" content="824.44">
   9 <style type="text/css">
  10 p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 18.0px Helvetica}
  11 p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; min-height: 14.0px}
  12 p.p3 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica}
  13 span.s1 {color: #0031e6}
  14 span.s2 {color: #0024f8}
  15 span.s3 {color: #0000ff}
  16 </style>
  17 </head>
  18 <body>
  19 <p class="p1"><b>EventStreamPlayer</b></p>
  20 <p class="p2"><br></p>
  21 <p class="p3"><b>superclass: PauseStream</b></p>
  22 <p class="p2"><br></p>
  23 <p class="p3">An <b>EventStreamPlayer</b> is used by Event based Patterns. <span class="Apple-converted-space"> </span></p>
  24 <p class="p3">You do not explictly create an EventStreamPlayers, they are created for you</p>
  25 <p class="p3">when you call Pattern-play.</p>
  26 <p class="p2"><br></p>
  27 <p class="p3">The <b>EventStreamPlayer</b> holds a stream which returns a series of Events, and a protoEvent. At each call to next, it copies the protoEvent, passes that to the stream, and calls <b>play</b> on the <b>Event</b> returned.</p>
  28 <p class="p2"><br></p>
  29 <p class="p3">for more on <b>EventStreamPlayer<span class="Apple-converted-space"> </span></b> see <a href="Streams-Patterns-Events4.html"><span class="s1">Streams-Patterns-Events4</span></a></p>
  30 <p class="p2"><br></p>
  31 <p class="p2"><br></p>
  32 <p class="p3">EventStreamPlayer uses the same control methods and status notifications as <a href="../Scheduling/Task.html"><span class="s2">Task</span></a>.</p>
  33 <p class="p2"><br></p>
  34 <p class="p3"><b>play(argClock, doReset, quant)</b></p>
  35 <p class="p3"><b>argClock</b> - (optional) Override the clock assigned in Task.new</p>
  36 <p class="p3"><b>doReset</b> - If true, the task will start over from the beginning. Default is false (task will resume where it was when it was last stopped)</p>
  37 <p class="p3"><b>quant</b> - see the <a href="../Scheduling/Quant.html"><span class="s3">Quant</span></a> helpfile</p>
  38 <p class="p2"><br></p>
  39 <p class="p2"><br></p>
  40 <p class="p3"><b>start(argClock, quant)</b> - Restart the task from the beginning.</p>
  41 <p class="p3"><b>resume(argClock, quant)</b> - Resume the task where it left off.</p>
  42 <p class="p3"><b>pause</b> - Stop playing now.</p>
  43 <p class="p3"><b>stop</b> - Stop playing now. (Pause and stop have the same implementation.)</p>
  44 <p class="p3"><b>reset</b> - Set the stream to restart from the beginning the next time it's played.</p>
  45 </body>
  46 </html>