CtkGroup:
Filter:
Ctk/Classes (extension) | Libraries > CTK

CtkGroup
ExtensionExtension

Representation of a group on the server for use with CTK objects
 

Description

Part of the Composer's Tool Kit (CTK) system. See Ctk for more details.

CtkGroup is a wrapper for a Group suitable for use with CTK objects. See also CtkPGroup for a CTK implementation of a ParGroup.

Class Methods

.new

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

.play

Create and immediately place a group on the server for real-time usage; see *new for the description of arguments.

Instance Methods

.release

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

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

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.

Examples

Examples that create new instances of a SynthDef directly from CtkProtoNotes:

CtkScore uses

Examples that populate an instance of CtkScore. The CtkScore can then be rendered in NRT, played or saved as a file. See CtkScore for more examples.