MKtl : Object

Extension

all currently available MKtls.MKtl.all;

Find all currently connected controllers. This method calls the find method on all of MKtlDevice's subclasses, and will post a list of available MKtl devices.MKtl.find;

the currently supported protocols, deviceTypes, and elementTypes used in loaded description files.MKtl.protocols; MKtl.deviceTypes; MKtl.elementTypes;

Accesses an existing instance of MKtl with the given name, or creates a new instance with that name. As with e.g. JITLib proxies like Ndef, Tdef, Pdef, or OSCdef, MIDIdef etc.// nickname to give the MKtl, and a string as name of description file k = MKtl('mynano2', "korg-nanokontrol2"); // description file name can also contain wildcards to match: l = MKtl('op1', "*op-1"); // if you have several devices of the same kind connected, // say two nanoKontrol2s, you can get to each of them by multiIndex: m = MKtl('nk2A', "korg-nanokontrol2", multiIndex: 0); n = MKtl('nk2B', "korg-nanokontrol2", multiIndex: 1); // Note that this is the index of the list of multiples only, // and in the order they show up in the system, // as is posted from MKtl.find. If you connect your // devices to the same plugs, they will get the same multiIndex again. // if lookupName is a Symbol, it will look for devices by key in MKtlLookup.all: m = MKtl('nk2C', 'midi2_orSimilar'); MKtlLookup.all.keys.postcs; // if lookupName is an MKtlDesc, it will look for devices by key in MKtlLookup.all: MKtlDesc.loadDescs; m = MKtl('nk2D', MKtlDesc.allDescs['korg-nanokontrol2']);

Arguments:

A class dictionary of all preset ControlSpecs used by various controller elements.

add and access by name a ControlSpec in MKtl's dictionary of specs

Arguments:

post the filenames of all loadable device descriptions. For more details on using description files, see MKtlDesc

post all currently loaded device descriptions.

the folder(s) where MKtlDesc finds description files.

open folder(s) at index containing description files.

load device description file(s) matching with name from indicated folder(s).

test whether the given desc is faulty.MKtl.postLoadableDescs; MKtl.postLoadedDescs; MKtl.descFolders; MKtl.openDescFolder(0); MKtl.loadDescsMatching("*run-n-drive*");

post all possible (i.e. currently connected or known) devices for the protocol(s) given. MKtl.postPossible;

make a lookupName for a device based on (typically) its protocol, id number and productName.MKtl.makeLookupName(\hid, 0, "Run'N'Drive - Wireless"); MKtl.makeLookupName(\midiSrc, 0, "nanoKEY"); // osc - is ip addr and port good here? MKtl.makeLookupName(\osc, "127.0.0.1_57110", "sclang");

get and set the name (a Symbol) of the MKtl. This also changes the name under which the MKtl is stored in Mktl.all.MKtl(\test, "korg-nanokontrol2"); MKtl(\test).name_(\mynano2); MKtl.all; // \test is gone now, use \mynano2 instead

Open a gui representation for the MKtl, which shows the state of the MKtl's elements and can do all their actions.MKtl(\mynano2).gui;

a local dict for special specs to use with this MKtl's elements or groups.MKtl(\mynano2).specs; MKtl(\mynano2).addSpec(\angle, [-pi, pi]); MKtl(\mynano2).getSpec(\angle);

the MKtlDesc object that holds the device information from the description file. It is used to build the elements and groups of this MKtl.a = MKtl(\mynano2).desc; a.fullDesc; // a dict loaded from the description file a.fullDesc.keys; // the keys of the items in it a.protocol; // e.g. the protocol used a.elementsDesc; // the dict of the elements described a.postElements; // post element names and keys/indices in hierarchical order

For more, see MKtlDesc

Rebuild all elements of the MKtl based on the new description file given.

Open the hardware device for this MKtl if it was not opened already. It will look automatically for an appropriate device.

Arguments:

test whether MKtl has a device (a MIDI/HID/OSCMKtlDevice)m.hasDevice

Closes the hardware device if it was open.

The instance of MKtlDevice that this MKtl uses. (mktlDevice is a deprecated alias for device)

Frees the MKtl again and forgets about its existence. If there was an device, this closes it.

Reset all actions of the elements in this MKtl to nil.

Arguments:

set the flag whether incoming data are posted or not, default true.

the flag whether incoming data are posted or not.

enable and disable this MKtl, so one can make multiple MKtls (with different setups of elements) for the same physical device.

send all current MKtl values to the physical device, e.g. to move all motorfaders to a freshly recalled preset.

All the control elements (MKtlElement) on the device you may want to listen or talk to. this returns an MKtlElementGroup containing a hierarchical tree of MKtlElements, organised via MKtlElementGroup. (elements is a deprecated alias of elementGroup).MKtl(\funky).elementGroup;

A dict for adding elements or groups by name, so they can be accessed by name. For example, this can be used to reorganize the elements of a fader box into channels as on a mixer. See Creating Named Groups and Coding for Modal Flexibility

An alphabetical list of all elementNames in the MKtl. m = MKtl(\funky); m.elementNames;

A pretty printed hierarchical list of the names and indices of all elementsm.postElements;

all elements in one flat event so they can be accessed very fast by name.m.elementsDict; m.dictAt('joy_r_hat');

return all elements that are of the type given, or notm.elementsOfType(\slider); m.elementsNotOfType(\slider);

return all elements which have been given a labelo = MKtl(\opi1, "teenage*"); o.elementsLabeled(\white);

Access an element or group in the elementGroup or in groups by hierarchical indices or names. Supports nil and \all as wildcards, and multi-expands correctly.k = MKtl(\mynano2, "korg-nanokontrol2"); k.elementGroup; k.elAt; // the same top group k.elAt(\tr); // the group of transport elements (in top group) k.elAt(\tr, \rew); // a button in the \tr group k.elAt(\not, \there); // returns nil for non-existent names k.elAt(\sl); // the group of all sliders k.elAt(\sl, 0); // the first slider by index k.elAt(\sl, \1); // the first slider by name k.elementGroup[\sl][0]; // same lookup by hand k.elAt(\bt); // the group of all buttons k.elAt(\bt, \S); // the S buttons k.elAt(\bt, \M, \1); // the first button // nil or \all are wildcards: k.elAt(\all, 0); // the first element in every group k.elAt(nil, 0); // the first element in every group // arrays of keys and indexes allowed k.elAt([\sl, \tr], 3); // the fourth slider and tr button k.elAt(\bt, [0, 2]); // the S and R buttons

Access an element in the elementsDict directly by its full name. This is a very fast lookup. MKtl(\mynano2).dictAt(\sl_1);

Access an element in the collectivesDict by hierarchical name.

Access an element in the top elementGroup by index. MKtl(\mynano2).at(0);

Access an element's value and deviceValue (in the deviceSpec range) by the direct element keym = MKtl( 'funky', "*run-n-drive" ); m.valueAt( \compass ); m.valueAt( \bt_2 ); m.deviceValueAt( \compass ); m.deviceValueAt( \bt_2 ); m.deviceValueAt( \joy_l_x );

Set an element's value or deviceValue directly by element key

get multiple key/value pairs for a list of element keys. this is intended for more robust storage of presets.m.getKeysValues; // gets all keys and values m.getKeysValues( [\compass, \wheel] ); // get specific ones m.getKeysValues( [\joy_l_x, \joy_l_y, \joy_r_x, \joy_r_y, ] ); m.getKeysValues( m.elAt(\bt).collect(_.name) ); // the bt group

set multiple key/value pairs from a list of key/value arrays.m.setKeysValues( [[\compass, 0.125], [\wheel, 1.0]] ); // two elements m.gui;

same as setKeysValues, but with doAction of the elements being set

set multiple key/value pairs from a list of key, value arguments. m.set(\joy_l_x, 1.0.rand, \joy_l_y, 1.0.rand, \joy_r_x,1.0.rand, \joy_r_y, 1.0.rand); m.gui;

same as set, but with doAction of the elements being set

Send the value of the element to the hardware device; called if you set the value of an MKtlElement that is an output.

When a device doesn't have a description file yet, explore can be used to help in creating one.

Returns a Boolean whether or not a device is currently being explored.

When a device doesn't have a description file yet, this method can be used to create a description file.

a dict of special messages for this device, typically to change setup on a MIDI device by sending it a sysex message.

send specialMessage with that name to the device

add an element or group to the mktl's namedDict, so they can be accessed by user given names.

This can be used to name single elements by the same function name across different devices - e.g. call one button \play, another \stop, no matter what its name in the device description may be:k = MKtl(\nk2, "*trol2"); // in a nanoKontrol2, put all transport buttons (in group \tr) // in k.namedDict, so they can be accessed without the \tr prefix: k = MKtl(\nk2, "*trol2"); k.elAt(\tr).do { |el| k.addNamed(el.elemDesc.key, el); }; k.namedDict.keys; k.elAt(\play); k.elAt(\stop);

These are mainly used internally in OSCMKtlDevice, see How to create a description file for an OSC device