CoreMidi Namespace

The CoreMidi namespace provides classes for interacting with the MIDI subsystem.

Classes

IOErrorEventArgs

Provides data for the IOError event.

Midi

Global methods and constants for using CoreMidi.

Midi.Notifications

Notification posted by the Midi class.

MidiCIProfile
MidiCIProfileState
MidiCISession
MidiClient

Main entry point to use MIDI in MacOS X and iOS.

MidiDevice

Represents a MIDI device (typically they represent a hardware device, but virtual devices also exist). Devices can contain one or more entities.

MidiDeviceList
MidiEndpoint

Endpoints represent an individual source or destination on the MIDI stream.

MidiEntity

A MidiObject that represents a sub-component of a MidiDevice.

MidiException

Exception raised by Midi methods.

MidiNetworkConnection

A connection to a MIDI network host, using a MidiNetworkSession.

MidiNetworkHost

A remote MIDI host.

MidiNetworkSession

A singleton class that maintains the MidiNetworkConnections between various MIDI entities.

MidiObject

Base class for the MidiClient, MidiPort, MidiEntity, MidiDevice and MidiEndpoint classes.

MidiPacket

Encapsulates a series of MIDI events.

MidiPacketsEventArgs

Provides data for the MessageReceived and E:CoreMidi.MidiPacketsEventArgs.MessageReceived events.

MidiPort

Input and Output ports.

MidiThruConnection

Manages MIDI play-through connections.

MidiThruConnectionParams

MIDI transformations and routings.

ObjectAddedOrRemovedEventArgs

Provides data for the ObjectRemoved and E:CoreMidi.ObjectAddedOrRemovedEventArgs.ObjectRemoved events.

ObjectPropertyChangedEventArgs

Provides data for the PropertyChanged event.

Structs

MidiCIDeviceIdentification
MidiControlTransform

Represents a transformation of a MIDI control.

MidiThruConnectionEndpoint

Source or Destination of a MidiThruConnection.

MidiTransform

Object that defines how a MIDI event is transformed.

MidiValueMap

MIDI Value map.

Enums

MidiError

Errors raised by the CoreMIDI stack.

MidiNetworkConnectionPolicy

An enumeration whose values specify which hosts are eligible to connect to a MIDI network session.

MidiTransformControlType

MIDI Control Transformation Type.

MidiTransformType

MIDI transform types.

Delegates

MidiCIProfileChangedHandler
MidiCIPropertyChangedHandler
MidiCIPropertyResponseHandler

Remarks

CoreMIDI is an API that talks to the MIDI server on iOS and OSX which in turn interacts with MIDI devices connected to your Mac or iOS device.

When using CoreMIDI, you will run into various classes that deal with different parts of the MIDI stack, the following graphic illustrates the relationships:

The MIDI device itself is represented by the MidiDevice class. Devices can contain one or more entities (MidiEntity). For example a MIDI device could contain two independent MIDI tone generators. Each Entity contains a series of endpoints which are either sources or destintions. Both MIDI sources and MIDI destinations are encapsulated by the MidiEntity class.

To start with MIDI, you will need to create a MidiClient object. This object is the gateway between your application and the MIDI server process. You subscribe to the events that this object raises to track devices being added, removed and to changes in their properties and setup configuration.

You also use the MidiClient to create input ports and output ports. The input ports raise the MessageReceived event when new MIDI data is available and you can use the Packets property in the arguments received to get the data out

See the MidiClient class for an example of how to set things up.

To use networked MIDI connections, you need to enable the network session and set its connection policy, like this:


var session = MidiNetworkSession.DefaultSession;
session.Enabled = true;
session.ConnectionPolicy = MidiNetworkConnectionPolicy.Anyone;

To connect to a remote MIDI network host you use the MidiNetworkHost, like this:


var host = MidiNetworkHost.Create ("My Session", "myhost.xamarin.com", 5004);
var connection = MidiNetworkConnection.FromHost (host);