MIKMIDIDevice

@interface MIKMIDIDevice : MIKMIDIObject

class MIKMIDIDevice : MIKMIDIObject

MIKMIDIDevice represents a MIDI device such as a DJ controller, MIDI piano keyboard, etc.

Overview

MIDI devices are for example, DJ controllers, MIDI piano keyboards, etc. For many applications, being able to discover, connect to, and receive messages from devices is fundamental to their use of MIDI. Instances of MIKMIDIDevice represent a MIDI device and MIKMIDIDevice includes methods for retrieving information about the device as well as obtaining its MIDI entities and endpoints in order to communicate with it.

MIDI devices can contain multiple entities, and each entity can contain multiple source and destination endpoints. Commonly, however, a device will contain only a single entity, which contains a single source endpoint, and a single destination endpoint.

Retrieving Available Devices

To retrieve a list of the devices that are available, use -[MIKMIDIDeviceManager availableDevices]. Note that some devices (e.g. some Native Instruments DJ controllers) have drivers that present them as pairs of virtual MIDI endpoints. These devices will not be available in the array returned by -availableDevices, and instead will be represented by virtual endpoints found in the arrays returned by -[MIKMIDIDeviceManager virtualSources] and -[MIKMIDIDeviceManager virtualDestinations]. MIKMIDIDevice can be used to “wrap” virtual sources so that it can be used with devices that present solely using virtual endpoings. See +deviceWithVirtualEndpoints: for more.

Connecting to a Device

To connect a device and start receiving MIDI messages from it, you must first get the source endpoints you want to connect to. Often there will be only one. You can retrieve all of a devices source endpoints using the following:

    NSArray *sources = [self.device.entities valueForKeyPath:@"@unionOfArrays.sources"];
  MIKMIDISourceEndpoint = [source firstObject]; // Or whichever source you want, but often there's only one.

Next, connect to that source using MIKMIDIDeviceManager:

MIKMIDIDeviceManager *manager = [MIKMIDIDeviceManager sharedDeviceManager];
NSError *error = nil;
BOOL success = [manager connectInput:source error:&error eventHandler:^(MIKMIDISourceEndpoint *source, NSArray *commands) {
    for (MIKMIDICommand *command in commands) {
        // Handle each command
    }
}];
if (!success) {
    NSLog(@"Unable to connect to %@: %@", source, error);
    // Handle the error
}