Inherits from NSObject
Conforms to NSCopying
Declared in MIKMIDIMapping.h

Overview

MIKMIDIMappingItem contains information about a mapping between a physical MIDI control, and a single command supported by a particular MIDI responder object.

MIKMIDIMappingItem specifies the command type, and MIDI channel for the commands sent by the mapped physical control along with the control’s interaction type (e.g. knob, turntable, button, etc.). It also specifies the (software) MIDI responder to which incoming commands from the mapped control should be routed.

Tasks

  • – initWithMIDIResponderIdentifier:andCommandIdentifier:

    Creates and initializes a new MIKMIDIMappingItem instance.

  • – XMLStringRepresentation

    Returns an NSString instance containing an XML representation of the receiver. The XML document returned by this method can be written to disk.

  •   MIDIResponderIdentifier

    The MIDI identifier for the (software) responder object being mapped. This is the same value as returned by calling -MIDIIdentifier on the responder to be mapped.

    property
  •   commandIdentifier

    The identifier for the command mapped by this mapping item. This will be one of the identifier’s returned by the mapped responder’s -commandIdentifiers method.

    property
  •   interactionType

    The interaction type for the physical control mapped by this item. This can be used to determine how to interpret the incoming MIDI messages mapped by this item.

    property
  •   flipped

    If YES, value decreases as slider/knob goes left->right or top->bottom. This property is currently only relevant for knobs and sliders, and has no meaning for buttons or other responder types.

    property
  •   channel

    The MIDI channel upon which commands are sent by the control mapped by this item.

    property
  •   commandType

    The MIDI command type of commands sent by the control mapped by this item.

    property
  •   controlNumber

    The control number of the control mapped by this item. This is either the note number (for Note On/Off commands) or controller number (for control change commands).

    property
  •   additionalAttributes

    Optional additional key value pairs, which will be saved as attributes in this item’s XML representation. Keys and values must be NSStrings.

    property

Properties

MIDIResponderIdentifier

@property (nonatomic, readonly) NSString *MIDIResponderIdentifier
Discussion

The MIDI identifier for the (software) responder object being mapped. This is the same value as returned by calling -MIDIIdentifier on the responder to be mapped.

This value can be used to retrieve the MIDI responder to which this mapping refers at runtime using [NS/UIApplication MIDIResponderWithIdentifier].

Declared In

MIKMIDIMapping.h

additionalAttributes

@property (nonatomic, copy) NSDictionary *additionalAttributes
Discussion

Optional additional key value pairs, which will be saved as attributes in this item’s XML representation. Keys and values must be NSStrings.

Declared In

MIKMIDIMapping.h

channel

@property (nonatomic) NSInteger channel
Discussion

The MIDI channel upon which commands are sent by the control mapped by this item.

Declared In

MIKMIDIMapping.h

commandIdentifier

@property (nonatomic, readonly) NSString *commandIdentifier
Discussion

The identifier for the command mapped by this mapping item. This will be one of the identifier’s returned by the mapped responder’s -commandIdentifiers method.

Declared In

MIKMIDIMapping.h

commandType

@property (nonatomic) MIKMIDICommandType commandType
Discussion

The MIDI command type of commands sent by the control mapped by this item.

Declared In

MIKMIDIMapping.h

controlNumber

@property (nonatomic) NSUInteger controlNumber
Discussion

The control number of the control mapped by this item. This is either the note number (for Note On/Off commands) or controller number (for control change commands).

Declared In

MIKMIDIMapping.h

flipped

@property (nonatomic, getter=isFlipped) BOOL flipped
Discussion

If YES, value decreases as slider/knob goes left->right or top->bottom. This property is currently only relevant for knobs and sliders, and has no meaning for buttons or other responder types.

Declared In

MIKMIDIMapping.h

interactionType

@property (nonatomic) MIKMIDIResponderType interactionType
Discussion

The interaction type for the physical control mapped by this item. This can be used to determine how to interpret the incoming MIDI messages mapped by this item.

Declared In

MIKMIDIMapping.h

Instance Methods

XMLStringRepresentation

- (NSString *)XMLStringRepresentation
Discussion

Returns an NSString instance containing an XML representation of the receiver. The XML document returned by this method can be written to disk.

Return Value

An NSString containing an XML representation of the receiver.

Declared In

MIKMIDIMapping.h

initWithMIDIResponderIdentifier:andCommandIdentifier:

- (instancetype)initWithMIDIResponderIdentifier:(NSString *)MIDIResponderIdentifier andCommandIdentifier:(NSString *)commandIdentifier
Discussion

Creates and initializes a new MIKMIDIMappingItem instance.

Parameters

MIDIResponderIdentifier

The identifier for the MIDI responder object being mapped.

commandIdentifier

The identifer for the command to be mapped.

Return Value

An initialized MIKMIDIMappingItem instance.

Declared In

MIKMIDIMapping.h