PHS:
Filter:
miSCellaneous_lib/Classes (extension) | Libraries > miSCellaneous > HS and HSpar | Streams-Patterns-Events > HS and HSpar

PHS
ExtensionExtension

defines Pbind(s) for using synth values of a HS

Description

Defines Pbind(s) which, when played, can use values of a synth derived from HS's synth definition.

Class Methods

.new

Creates a new PHS object.

Arguments:

helpSynth

A HS object.

helpSynthArgs

Collection of key / value pairs for the HS synth.

... pbindArgs

dur1, pbindData1, ... , durN, pbindDataN

where dur is duration value or pattern / stream of durations for corresponding Pbind(s) and pbindData is a collection of Pbind pairs or a collection of Pbind pair collections, defining possibly several Pbinds with the same event timing.

Instance Methods

.play

A PHSplayer object is instantiated and started using the TempoClock clock. Quant or SimpleNumber quant lets the player step into the quantization as soon as possible, with respect to the necessary latency. The PHSplayer can be stopped and resumed with several options.

.newPaused

VarGui support, see HS_with_VarGui for examples.

Return a new paused Synth derived from HS's ugenFunc definition, which may be passed to a VarGui object. VarGui will automatically detect that the Synth origins from a HS definition and gui functionality wil be adapted.

Arguments:

args

Collection of key / value pairs for the HS synth.

latency

SimpleNumber (seconds).

.asTask

VarGui support, see HS_with_VarGui for examples.

Returns a wrapper Task, which may be passed to a VarGui object. Playing and stopping the wrapper Task invokes playing and stopping behaviour of the underlying PHSplayer, per default also taking control over playing and stopping the help synth.

Arguments:

clock

TempoClock.

quant

Quant or SimpleNumber.

hsStop

Boolean. Determines if help synth will stop together with PHSplayer. Defaults to false.

hsPlay

Boolean. Determines if help synth will resume together with PHSplayer. Defaults to true.

newEnvir

Boolean. Determines if Task will be played in a newly generated environment. Defaults to true. This option especially becomes important when PHS's pbindData contains functional code with environmental variables.

removeCtrWithCmdPeriod

Boolean. Defaults to true. Determines if notification of PHSplayer will be stopped with CmdPeriod.

Examples

Order of execution: three Pbinds defined, scheduling slightly time-shifted internally, so references can be established.

Printout of variables which may be used within a PHS definition, timeGrains is just a time ID, depending on granularity, not used for scheduling. demandIndex indicates the index of the stream of durations, posted demandIndex = 1, as two pbinds are using duration stream #0.