CtkAudio:
Filter:
Classes (extension) | Libraries > CTK

CtkAudio : CtkBus : CtkObj : Object
ExtensionExtension

Representation of an audio bus for CTK objects
Source: CTK.sc
 

Description

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

CtkAudio is a wrapper for an audio Bus suitable for use with CTK objects. CtkAudio object can be passed in straight to a CtkNotes arg. The bus id will be extracted for you.

NOTE: See Using CtkAudio to set output bus for caveats.

Class Methods

CtkAudio.new(numChans: 1, bus, server)

Create new instance

Arguments:

numChans

The number of channels to allocate. Defaults to 1.

bus

the bus id to write values to. Defaults to nil, where an id will be allocated for you.

server

and instance of Server to allocate the audio bus from. Defaults to Server.default.

Returns:

a CtkAudio

CtkAudio.play(numChans: 1, bus, server)

Create new instance and make it ready for RealTime use.

Inherited class methods

Instance Methods

.bus

From superclass: CtkBus

Returns:

bus number of this CtkAudio (similar to Bus: -index)

.free

returns the bus id to the allocation pool

Inherited instance methods

Examples

CtkScore

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.

Using CtkAudio to set output bus

CtkAudio can be passed directly to set an argument specifying the output bus, but this will not work if that bus number is subject to any operation (e.g. addition).