MKtlLookup | SuperCollider 3.13.0 Help

Description

MKtlLookup provides a single dictionary with unique lookup names for all hardware/network devices found or declared, so they can be used with MKtls. MKtlLookup works in the background when doing MKtl.find;, so you will rarely encounter it, except when you debug device finding mechanisms.

The names are intentionally long to be both unique and descriptive of the source. short nicknames can and should be given in the MKtl creation:MKtl(\nk2, 'midi_0_nanokontrol2'); MKtl('nk2').listenTo( 0 ).sendTo(0); MKtl('nk2').trace; MKtl(\nk2b, 'midi_0_nanokontrol2'); MKtl('nk2b').listenTo( 1 ).sendTo(1); MKtl('nk2b').trace; MKtl('nk2b').elementAt(\play).value_(1); MKtl.find; // does these find operations: // HID.findAvailable; // MIDIClient.init; // MKtlLookup.addAllHID; // MKtlLookup.addAllMIDI; // (OSC devices are not found automatically) // depending on the kind of device MKtlLookup.names.printcsAll; // add some osc devices by hand: MKtlLookup.addOSC(NetAddr.localAddr, \sclang); MKtlLookup.addOSC(s.addr, "server_%".format(s.name).asSymbol).put(\server, s); MKtlLookup.addOSC(NetAddr("192.168.94.23", 1234), \gyrosc); MKtlLookup.names.printcsAll; // list all midi devices: MKtlLookup.allFor(\midi); // for each device found, MKtlLookup has a dict with all the useful info // that is known about the device at this point. // E.g. the dict for a midi device will contain : MKtlLookup.allFor(\midi).choose.postcs; ( 'idInfo': nanoKONTROL2, // name of the device as it registers to the OS 'protocol': midi, // the protocol it uses // the endpoints that belong to it, src and dest: 'srcDevice': MIDIEndPoint("nanoKONTROL2", "SLIDER/KNOB", 1140916328), 'destDevice': MIDIEndPoint("nanoKONTROL2", "CTRL", -1609859973), // the unique name under which the info is stored 'lookupName': midi_0_nanokontrol2, // name of the matching description file if there is one: 'filename': korg-nanokontrol2, // all the endpoints that belong to it: 'deviceInfo': [ MIDIEndPoint("nanoKONTROL2", "SLIDER/KNOB", 1140916328), MIDIEndPoint("nanoKONTROL2", "CTRL", -1609859973) ] )

NOTE: Currently, all endpoints found for the same device name are registered as one info dict. For most single-in, single-out devices this works perfectly. When multiple devices of the same kind are present (e.g. 2 midifader boxes), they are identified by a multiIndex. See Connecting_multiple_identical_devices.

Class Methods

.all

the lookup dictionary of all device infos found

.names

the lookup names of all device infos found

.postInfo

post info on all devices found

.allFor

the lookup names of all device infos using that protocol

.addHID

add a HIDInfo by as found by index in HID.available

.addAllHID

add all HIDINfos currently found in HID.available

.addMIDI

add a MIDIEndpoint as found by index in MIDIClient.sources or .destinations. type (\src or \dest) tells MKtlLookup whether it is in sources or .destinations.

.addAllMIDI

add all MIDIEndpoints currently found in MIDIClient sources or destinations. Happens automatically in MIDIMktlDevice.find.

.midiAll

a separate dict for sorting and matching all midi ports

.addOSC

add an OSC source or dest. As these are not globally represented, one makes them by hand, with sendAddr, replyAddr, and (given) name.

.findByIDInfo

// On OSX, MKtl.find detects installed IAC Driver MKtl.find(\midi); // finds it directly by name MKtlLookup.findByIDInfo("IAC Driver"); // also when given in a dict: MKtlLookup.findByIDInfo((deviceName: "IAC Driver")); // and even when the dict says srcPortIndex 0, // and the lookup info has no srcPortIndex (i.e. it is a single port MKtlLookup.findByIDInfo((deviceName: "IAC Driver", srcPortIndex: 0 ));

Instance Methods

None, MKtlLookup is a Singleton.

helpfile source: Modality/HelpSource/Classes/MKtlLookup.schelp
link::Modality-toolkit/Classes/MKtlLookup::

MKtlLookupExtension