Functions


MIDIThruConnectionParamsInitialize
Fills a MIDIThruConnectionParams with default values.
MIDIThruConnectionCreate
Creates a thru connection.
MIDIThruConnectionDispose
Disposes a thru connection.
MIDIThruConnectionGetParams
Obtains a thru connection's MIDIThruConnectionParams.
MIDIThruConnectionSetParams
Alters a thru connection's MIDIThruConnectionParams.
MIDIThruConnectionFind
Returns all of the persistent thru connections created by a client.

MIDIThruConnectionParamsInitialize


Fills a MIDIThruConnectionParams with default values.

extern void MIDIThruConnectionParamsInitialize( 
    MIDIThruConnectionParams *inConnectionParams ) ; 
Parameter Descriptions
inConnectionParams
The struct to be initialized.
function result
An OSStatus result code.
Discussion

This convenience function fills the connection structure with default values: no endpoints, no transformations (mostly zeroes except for the channel map). Then, just filling in the source and adding one destination will create a simple, unmodified thru connection.

Availability
Introduced in Mac OS X 10.2

MIDIThruConnectionCreate


Creates a thru connection.

extern OSStatus MIDIThruConnectionCreate(
    CFStringRef inPersistentOwnerID, 
    CFDataRef inConnectionParams, 
    MIDIThruConnectionRef *outConnection ) ; 
Parameter Descriptions
inPersistentOwnerID
If null, then the connection is marked as owned by the client and will be automatically disposed with the client. if it is non-null, then it should be a unique identifier, e.g. "com.mycompany.MyCoolProgram".
inConnectionParams
A MIDIThruConnectionParams contained in a CFDataRef.
outConnection
On successful return, a reference to the newly-create connection.
function result
An OSStatus result code.
Availability
Introduced in Mac OS X 10.2

MIDIThruConnectionDispose


Disposes a thru connection.

extern OSStatus MIDIThruConnectionDispose(
    MIDIThruConnectionRef connection ) ; 
Parameter Descriptions
connection
The connection to be disposed
function result
An OSStatus result code.
Availability
Introduced in Mac OS X 10.2

MIDIThruConnectionGetParams


Obtains a thru connection's MIDIThruConnectionParams.

extern OSStatus MIDIThruConnectionGetParams(
    MIDIThruConnectionRef connection, 
    CFDataRef *outConnectionParams ) ; 
Parameter Descriptions
connection
The connection to be disposed.
outConnectionParams
On successful return, the connection's MIDIThruConnectionParams in a CFDataRef
function result
An OSStatus result code.
Discussion

The returned CFDataRef contains a MIDIThruConnectionParams structure. The caller is responsible for releasing it.

Availability
Introduced in Mac OS X 10.2

MIDIThruConnectionSetParams


Alters a thru connection's MIDIThruConnectionParams.

extern OSStatus MIDIThruConnectionSetParams(
    MIDIThruConnectionRef connection, 
    CFDataRef inConnectionParams ) ; 
Parameter Descriptions
connection
The connection to be modified.
inConnectionParams
The connection's new MIDIThruConnectionParams in a CFDataRef
function result
An OSStatus result code.
Availability
Introduced in Mac OS X 10.2

MIDIThruConnectionFind


Returns all of the persistent thru connections created by a client.

extern OSStatus MIDIThruConnectionFind(
    CFStringRef inPersistentOwnerID, 
    CFDataRef *outConnectionList ) ; 
Parameter Descriptions
inPersistentOwnerID
The ID of the owner whose connections are to be returned.
outConnectionList
On successful return, a CFDataRef containing an array of MIDIThruConnectionRef's.
function result
An OSStatus result code.
Availability
Introduced in Mac OS X 10.2

(Last Updated February 25, 2005)