Protocols

The following protocols are available globally.

  • Objects that conform to this protocol can be used as a destination for MIDI commands to
    be sent to by MIKMIDISequencer.
    
    - see: MIKMIDISequencer
    
    See more

    Declaration

    Objective-C

    @protocol MIKMIDICommandScheduler <NSObject>

    Swift

    protocol MIKMIDICommandScheduler : NSObjectProtocol
  • Protocol containing method(s) to be implemented by delegates of MIKMIDIConnectionManager.

    See more

    Declaration

    Objective-C

    @protocol MIKMIDIConnectionManagerDelegate <NSObject>

    Swift

    protocol MIKMIDIConnectionManagerDelegate : NSObjectProtocol
  • This protocol defines methods that that must be implemented by MIDI responder objects to be mapped using MIKMIDIMappingGenerator, and to whom MIDI messages will selectively be routed using a MIDI mapping during normal operation.

    See more

    Declaration

    Objective-C

    @protocol MIKMIDIMappableResponder <MIKMIDIResponder>

    Swift

    protocol MIKMIDIMappableResponder : MIKMIDIResponder
  • Defines methods to be implemented by the delegate of an MIKMIDIMappingGenerator in order to customize mapping generation behavior.

    See more

    Declaration

    Objective-C

    @protocol MIKMIDIMappingGeneratorDelegate <NSObject>

    Swift

    protocol MIKMIDIMappingGeneratorDelegate : NSObjectProtocol
  • This is currently undocumented. Documentation contributions are always welcome!

    See more

    Declaration

    Objective-C

    @protocol MIKMIDIMappingManagerDelegate <NSObject>
    
    /**
     *  Used to determine the file name for a user mapping. This file name does *not* include the
     *	file extension, which will be added by the caller.
     *
     *  If this method is not implemented, or returns nil, the mapping's name itself will be used.
     *
     *  @param manager The MIKMIDIMappingManager asking for the name.
     *  @param mapping The mapping a file name is needed for.
     *
     *  @return A file name for the mapping.
     */
    - (nullable NSString *)mappingManager:(MIKMIDIMappingManager *)manager fileNameForMapping:(MIKMIDIMapping *)mapping;
    
    /**
     *	When deleting user mappings, this method is called as a way to provide any additional
     *	file names that the mapping may have had in past versions of -fileNameForMapping:
     *
     *	If you have changed the naming scheme that -fileNameForMapping: uses in any user-reaching
     *	code, you will probably want to implement this method as well, so users will be able to
     *	properly delete mappings with the old naming scheme.
     *
     *	Just as with -fileNameForMapping:, the file names should *not* include the file extension.
     *
     *  @param manager The MIKMIDIMappingManager asking for legacy names.
     *	@param mapping The mapping to return legacy file names for.
     *
     *	@return An array of legacy file names, or nil.
     */
    - (nullable MIKArrayOf(NSString *) *)mappingManager:(MIKMIDIMappingManager *)manager legacyFileNamesForUserMapping:(MIKMIDIMapping *)mapping;
    
    @end

    Swift

    protocol MIKMIDIMappingManagerDelegate : NSObjectProtocol
  • The MIKMIDIResponder protocol defines methods to be implemented by any object that wishes to receive MIDI messages/commands.

    Any class in an application can implement this protocol. To actually receive MIDI messages, a responder object must be registered by calling -[NS/UIApplication registerMIDIResponder]. Additionally, it is the client application’s responsibility to pass incoming MIDI messages to the application instance by calling -[NS/UIApplication handleMIDICommand:]

    See more

    Declaration

    Objective-C

    @protocol MIKMIDIResponder <NSObject>

    Swift

    protocol MIKMIDIResponder : NSObjectProtocol