ABPort Class Reference

Port. More...

#import <ABPort.h>

Inherits NSObject.

Inherited by ABAudioFilterPort, ABAudioReceiverPort, ABAudioSenderPort, and ABMIDIPort.

Instance Methods

(void) - launch
 Launches the app belonging to the port and triggers ABPortWillLaunchPortNotification in the appropriate app.
 

Properties

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.
 

Detailed Description

Port.

Ports are the source or destination points for Audiobus connections. Ports can send audio, receive audio, or filter audio. You can define multiple ports of each type in your app to define different audio routes. For example, a multi-track recorder could define additional ports for each track, so each track can be routed to a different place, or recorded to individually.

This class represents a port on another peer.

Method Documentation

- (void) launch

Launches the app belonging to the port and triggers ABPortWillLaunchPortNotification in the appropriate app.

Property Documentation

- (ABPeer*) peer
readnonatomicweak

The peer this port is on.

- (NSString*) name
readnonatomicstrong

The internal port name.

- (NSString*) title
readnonatomicstrong

The title of the port, for display to the user.

- (UIImage*) icon
readnonatomicstrong

The port icon (a 64x64 image)

- (ABPortType) type
readnonatomicassign

The type of the port.

- (uint8_t) attributes
readnonatomicassign

The attributes of this port.

- (id) context
readwritenonatomicweak

Use this property to associate some user defined context with the port.

- (uint32_t) uniqueIdentifier
readnonatomicassign

An port identifier that is unique for the peer itself but also for other peers.

- (BOOL) connected
readnonatomicassign

Whether the port is connected.

- (NSString*) sourcesTitle
readnonatomicassign

A title representing the sources connected to the port.

- (UIImage*) sourcesIcon
readnonatomicassign

An icon representing the sources connected to the port.

- (NSArray*) sourcesRecursive
readnonatomicassign

Returns direct and indirect sources of the port in the pipeline.

The sources are ordered in the way senders - filters.

- (NSString*) destinationsTitle
readnonatomicassign

A title representing the destinations the port is connected to.

- (UIImage*) destinationsIcon
readnonatomicassign

An icon representing the destinations the port is connected to.

- (NSArray*) destinationsRecursive
readnonatomicassign

Returns direct and indirect destinations of the port in the pipeline.

The sources are ordered in the way filters - receivers.

- (NSArray*) audioPipelineIDs
readnonatomicassign

Returns a list of id<NSCopying>.

Each value is the ID of the Audio pipeline the port is assigned to.

A pipeline is one of the "channels" or "tracks" you are seeing in Audiobus. Pipeline ID 0 states, that the port is not assigned to a pipeline.

- (NSArray*) MIDIPipelineIDs
readnonatomicassign

Like audioPipelineIDs.

The only difference is that the IDs represent MIDI connectionPipelineIds.


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