ABMIDIPort is the base class of ABMIDISenderPort, ABMIDIFilterPort and ABMIDIReceiverPort. More...

#import <ABMIDIPort.h>

Inherits ABPort, and <ABLocalPort>.

Inherited by ABMIDIFilterPort, ABMIDIReceiverPort, and ABMIDISenderPort.

Protected Member Functions

(void) - ABMIDIPortSendPacketList
 Send a MIDIPacketList.
 
(BOOL) - ABMIDIPortIsConnected
 Like property connected, but for usage in realtime context.
 

Properties

BOOL allowsMultipleInstances
 Whether this port allows multiple instance.
 
NSArray *_Nonnull destinations
 Currently-connected destinations.
 
BOOL connected
 Whether the port is connected.
 
ByteCount outPacketListMaxSize
 This is the buffer size reserved for output MIDI Packet lists.
 
- Properties inherited from ABPort
ABPeerpeer
 The peer this port is on.
 
NSString * name
 The internal port name.
 
NSString * title
 The title of the port, for display to the user.
 
UIImage * icon
 The port icon (a 64x64 image)
 
ABPortType type
 The type of the port.
 
uint8_t attributes
 The attributes of this port.
 
id context
 Use this property to associate some user defined context with the port.
 
uint32_t uniqueIdentifier
 An port identifier that is unique for the peer itself but also for other peers.
 
BOOL connected
 Whether the port is connected.
 
NSString * sourcesTitle
 A title representing the sources connected to the port.
 
UIImage * sourcesIcon
 An icon representing the sources connected to the port.
 
NSArray * sourcesRecursive
 Returns direct and indirect sources of the port in the pipeline.
 
NSString * destinationsTitle
 A title representing the destinations the port is connected to.
 
UIImage * destinationsIcon
 An icon representing the destinations the port is connected to.
 
NSArray * destinationsRecursive
 Returns direct and indirect destinations of the port in the pipeline.
 
NSArray * audioPipelineIDs
 Returns a list of id<NSCopying>.
 
NSArray * MIDIPipelineIDs
 Like audioPipelineIDs.
 

Additional Inherited Members

- Instance Methods inherited from ABPort
(void) - launch
 Launches the app belonging to the port and triggers ABPortWillLaunchPortNotification in the appropriate app.
 

Detailed Description

ABMIDIPort is the base class of ABMIDISenderPort, ABMIDIFilterPort and ABMIDIReceiverPort.

It implements common features of both classes.

Do not instantiate this class directly.

Method Documentation

- (void) ABMIDIPortSendPacketList (__unsafe_unretained ABMIDIPort *_Nonnull)  MIDIPort
(const MIDIPacketList *_Nonnull)  MIDIPacketList 

Send a MIDIPacketList.

Use this function when you want to send MIDI events.

Note: For MIDI Filter Ports, this operates independently of MIDI received via ABMIDIFilterBlock.

Parameters
MIDIPortThe MIDI port from which the bytes are sent
MIDIPacketListThe MIDI packet list to be sent
- (BOOL) ABMIDIPortIsConnected (__unsafe_unretained ABMIDIPort *_Nonnull)  port

Like property connected, but for usage in realtime context.

Property Documentation

- (BOOL) allowsMultipleInstances
readnonatomicassign

Whether this port allows multiple instance.

YES if multiple instances of this prototype port can be created (see initWithName:title:instanceConnectedBlock:instanceDisconnectedBlock:)

- (NSArray* _Nonnull) destinations
readnonatomicstrong

Currently-connected destinations.

This is an array of ABPort.

- (BOOL) connected
readnonatomicassign

Whether the port is connected.

- (ByteCount) outPacketListMaxSize
readwritenonatomicassign

This is the buffer size reserved for output MIDI Packet lists.

This value defaults to 16 kBytes. Increase this value when you need more or less.


The documentation for this class was generated from the following file: