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