- Inherits from:
- NSObject
- Conforms to:
- NSObject (NSObject)
- Declared in:
- PYMIDI/PYMIDIManager.h
The PYMIDIManager is a singleton object that keeps track of the state of MIDI system and allows you to query that state, as well as providing some useful utility methods.
The sharedInstance class method is used to initialize and return the single shared PYMIDIManager instance for your application.
The PYMIDIManager sends a PYMIDISetupChanged notification whenever endpoints are added or removed, or attributes of them are changed.
Currently available sources and destinations can be queried using the realSources and realDestinations methods.
Creating and initializing a PYMIDIManagerGetting real destinations
- + sharedInstance
Getting real sources
- - realDestinations
- - realDestinationsOnlineOrInUse
- - realDestinationWithDescriptor:
Note names
- - realSources
- - realSourcesOnlineOrInUse
- - realSourceWithDescriptor:
- - nameOfNote:
+ (PYMIDIManager*)sharedInstance
Returns the shared PYMIDIManager instance for the application. You should always use this method to retrieve a PYMIDIManager instance and should never instantiate your own.
- (NSString*)nameOfNote:(Byte)note
Returns a string representing the given MIDI note number in human readable form, from "C-1" through to "G9", with middle C being "C4".
- (NSArray*)realDestinations
Returns an NSArray of PYMIDIRealDestination
objects representing all available MIDI destinations.
Note that any device which goes offline will stay in this list in case the device ever comes back online.
Endpoints are returned sorted alphabetically by display name.
See Also: - realSources
- (NSArray*)realDestinationsOnlineOrInUse
This is similar to the realDestinations method, but returns only
endpoints that are currently either online (as per the endpoint's isOnline
method) or in use (as per the endpoint's isInUse method).
See Also: - realDestinations, - realSourcesOnlineOrInUse
- (PYMIDIEndpoint*)realDestinationWithDescriptor:(PYMIDIEndpointDescriptor*)descriptor
This method searches for and returns a real destination endpoint matching the given descriptor.
If no real endpoint on the system matches the descriptor, a new offline endpoint is created and returned. This endpoint will go online if the corresponding device is later connected.
- (NSArray*)realSources
Returns an NSArray of PYMIDIRealSource
objects representing all available MIDI sources.
Note that any device which goes offline will stay in this list in case the device ever comes back online.
Endpoints are returned sorted alphabetically by display name.
See Also: - realDestinations
- (NSArray*)realSourcesOnlineOrInUse
This is similar to the realSources method, but returns only
endpoints that are currently either online (as per the endpoint's isOnline
method) or in use (as per the endpoint's isInUse method).
See Also: - realSources, - realDestinationsOnlineOrInUse
- (PYMIDIEndpoint*)realSourceWithDescriptor:(PYMIDIEndpointDescriptor*)descriptor
This method searches for and returns a real source endpoint matching the given descriptor.
If no real endpoint on the system matches the descriptor, a new offline endpoint is created and returned. This endpoint will go online if the corresponding device is later connected.
The PYMIDISetupChanged notification is sent by the PYMIDIManager whenever a change occurs in the MIDI system. This includes plugging or unplugging of devices, creation or destruction of virtual endpoints and endpoint property changes.
MIDI system changes that you make yourself through the PYMIDI interfaces will not cause this notification to be sent, although changes made using CoreMIDI calls will.