MIKMIDIEntity

Objective-C

@interface MIKMIDIEntity : MIKMIDIObject

Swift

class MIKMIDIEntity : MIKMIDIObject

MIKMIDIEntity represents a logical grouping of endpoints within a MIDI device. It essentially acts as a simple container for endpoints.

As part of MIKMIDIDevice’s support for wrapping virtual endpoints, an MIKMIDIEntity can also be created using virtual MIDI endpoints.

  • Convenience method for creating a “virtual” MIKMIDIEntity instance from one or more virtual endpoints. This method is typically not called directly by clients of MIKMIDI. Rather it’s used by MIKMIDIDevice’s internal machinery for creating virtual devices.

    See

    +[MIKMIDIDevice deviceWithVirtualEndpoints:]

    Declaration

    Objective-C

    + (nullable instancetype)entityWithVirtualEndpoints:
    (nonnull NSArray<MIKMIDIEndpoint *> *)endpoints;

    Parameters

    endpoints

    An array of one or more virtual endpoints, including both source and destination endpoints.

    Return Value

    An initialized MIKMIDIEntity instance.

  • Creates and initializes a “virtual” MIKMIDIEntity instance from one or more virtual endpoints. This method is typically not called directly by clients of MIKMIDI. Rather it’s used by MIKMIDIDevice’s internal machinery for creating virtual devices.

    See

    -[MIKMIDIDevice initWithVirtualEndpoints:]

    Declaration

    Objective-C

    - (nullable instancetype)initWithVirtualEndpoints:
    (nonnull NSArray<MIKMIDIEndpoint *> *)endpoints;

    Swift

    init?(virtualEndpoints endpoints: [MIKMIDIEndpoint])

    Parameters

    endpoints

    An array of one or more virtual endpoints, including both source and destination endpoints.

    Return Value

    An initialized MIKMIDIEntity instance.

  • The device that contains the receiver. May be nil if the receiver is a virtual entity not contained by a virtual device.

    Declaration

    Objective-C

    @property (nonatomic, weak, readonly, nullable) MIKMIDIDevice *device;

    Swift

    weak var device: MIKMIDIDevice? { get }

  • The source (input) endpoints contained by the receiver. An array of MIKMIDISourceEndpoint instances.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<MIKMIDISourceEndpoint *> *_Nonnull sources;

    Swift

    var sources: [MIKMIDISourceEndpoint] { get }

  • The destination (output) endpoints contained by the receiver. An array of MIKMIDIDestinationEndpoint instances.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<MIKMIDIDestinationEndpoint *> *_Nonnull destinations;

    Swift

    var destinations: [MIKMIDIDestinationEndpoint] { get }