HelpSource/Classes/EventStreamPlayer.schelp

   1 class:: EventStreamPlayer
   2 summary:: two streams combined by a binary operator
   3 related:: Classes/Event, Classes/Pbind
   4 categories:: Streams-Patterns-Events
   5
   6 description::
   7
   8 An EventStreamPlayer is used by link::Classes/Event:: based Patterns.
   9
  10 The EventStreamPlayer 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 strong::play:: on the link::Classes/Event:: returned.
  11
  12 For more on EventStreamPlayer see link::Tutorials/Streams-Patterns-Events4::
  13
  14 EventStreamPlayer uses the same control methods and status notifications as link::Classes/Task::.
  15
  16 ClassMethods::
  17
  18 method::new
  19 note::
  20 You do not explictly create an EventStreamPlayers, they are created for you when you call link::Classes/Pattern#-play::.
  21 ::
  22
  23 InstanceMethods::
  24
  25 private::prStop, prNext
  26
  27 method::play
  28
  29 argument::argClock
  30 (optional) Override the clock assigned in Task.new.
  31
  32 argument::doReset
  33 If true, the task will start over from the beginning. Default is false (task will resume where it was when it was last stopped).
  34
  35 argument::quant
  36 See the link::Classes/Quant:: helpfile.
  37
  38 method::start
  39 Restart the task from the beginning.
  40
  41 method::resume
  42 Resume the task where it left off.
  43
  44 method::pause
  45 Stop playing now.
  46
  47 method::stop
  48 Stop playing now. (Pause and stop have the same implementation.)
  49
  50 method::reset
  51 Set the stream to restart from the beginning the next time it's played.