CtkPGroup : CtkGroup : CtkNode : CtkObj : Object
Extension
ExtensionDescription
Part of the Composer's Tool Kit (CTK) system. See CTK for more details.
CtkPGroup is a wrapper for a ParGroup suitable for use with CTK objects. It has no ordering constrains for the contained nodes, which means that on parallel architectures (like the supernova server) they can be executed concurrently.
Class Methods
CtkPGroup.new(starttime: 0.0, duration, node, addAction: 0, target: 1, server)
Create new instance - for use with CtkScore or to enable it for real-time use at a later time (see -play)
Arguments:
| starttime |
In NRT or CtkScore rendering mode, the starttime of an CtkGroup event. In real-time mode, this parameter is ignored (defaults to nil). |
| duration |
A duration for the CtkGroup. If not nil, the group will be freed after the specified time. |
| node |
An id for this instance of CtkGroup. Defaults to nil, and one will be allocated for you. |
| addAction |
A symbol (\head, \tail, \before, \after or \replace) or an addAction id (see Server Command Reference: /g_new for a more in-depth description) |
| target |
A node ID (synth or group) or an instance of CtkGroup or CtkNote |
| server |
The server to execute the node on. Defaults to Server.default for real-time performance |
Returns:
a CtkGroup
Inherited class methods
Instance Methods
.release(time, key: 'gate')
Sets the CtkGroup members' 'key' argument to 0. Can be used to set the 'key' argument of every member of a CtkGroup to a value (typically used for 'gate' args)
Arguments:
| time |
In real-time mode, 'time' schedules the release in the future (in seconds). In non-real-time mode, a message to release an instance of CtkGroup is created at CtkGroup starttime + time. |
| key |
'key' defaults to \gate for use in sustained envelopes. |
.play(neg: 0.01)
Create an instance of this CtkGroup on the server for real-time use.
Arguments:
| neg |
Defaults to 0.1. Makes sure CtkGroups are created first. |
.free(time: 0.0, addMsg: true)
Frees the instance of CtkGroup and everything running in that CtkGroup.
Arguments:
| time |
In real-time mode, 'time' schedules the freeing of a node in the future. In non-real-time mode, a message to free the node is created at starttime + time. |
| addMsg |
Defaults to true. This will add the free message to Ctk's internal message keeper and will be added to a score. |
Inherited instance methods
Examples
link::Classes/CtkPGroup::