Create and manipulate MKConductor message requests.


Functions

MKMsgStructMKNewMsgRequest (double timeOfMsg, SEL whichSelector, id destinationObject, int argCount,...)
 Creates and returns a new MKMsgStruct.
void MKScheduleMsgRequest (MKMsgStruct *aMsgStructPtr, id conductor)
 Create and manipulate MKConductor message requests.
MKMsgStructMKCancelMsgRequest (MKMsgStruct *aMsgStructPtr)
 Create and manipulate MKConductor message requests.
MKMsgStructMKRescheduleMsgRequest (MKMsgStruct *aMsgStructPtr, id conductor, double timeOfNewMsg, SEL whichSelector, id destinationObject, int argCount,...)
 Create and manipulate MKConductor message requests.
MKMsgStructMKRepositionMsgRequest (MKMsgStruct *aMsgStructPtr, double newTimeOfMsg)
 Create and manipulate MKConductor message requests.

Function Documentation

MKMsgStruct* MKCancelMsgRequest ( MKMsgStruct aMsgStructPtr  ) 

Create and manipulate MKConductor message requests.

These functions let you enqueue message requests with a MKConductor object. The MKMsgStruct structure encapulates a message request; it consists of a method selector and its arguments, the recipient of the message, and the time that the message should be sent. A selector can take a maximum of two 4-byte arguments. You should never modify the fields of a MKMsgStruct structure directly.

MKCancelMsgRequest() cancels the given message request and frees the structure pointed to by aMsgStructPtr. Be sure not to cancel an already-canceled request. To make sure you don't do that, you should assign the returned value of the function (NULL) to the value you pass. Example of use:

   aMsgReq = MKCancelMsgRequest(aMsgReq);
aMsgReq is now NULL
 

Parameters:
aMsgStructPtr is a MKMsgStruct *.
Returns:
Always returns NULL.
See also:
MKNewMsgRequest().

MKMsgStruct* MKNewMsgRequest ( double  timeOfMsg,
SEL  whichSelector,
id  destinationObject,
int  argCount,
  ... 
)

Creates and returns a new MKMsgStruct.

These functions let you enqueue message requests with a MKConductor object. The MKMsgStruct structure encapulates a message request; it consists of a method selector and its arguments, the recipient of the message, and the time that the message should be sent. A selector can take a maximum of two 4-byte arguments. You should never modify the fields of a MKMsgStruct structure directly.

After you've created a message request structure, you schedule it with a MKConductor by calling MKScheduleMsgRequest().

Parameters:
timeOfMsg is the time in beats from the beginning of the performance that the message will be sent.
whichSelector is the selector.
destinationObject is the recipient of the message.
argCount is the number of arguments to the selector followed by the arguments themselves separated by commas.
Returns:
Return NULL if argCount is greater than 2.

MKMsgStruct* MKRepositionMsgRequest ( MKMsgStruct aMsgStructPtr,
double  newTimeOfMsg 
)

Create and manipulate MKConductor message requests.

These functions let you enqueue message requests with a MKConductor object. The MKMsgStruct structure encapulates a message request; it consists of a method selector and its arguments, the recipient of the message, and the time that the message should be sent. A selector can take a maximum of two 4-byte arguments. You should never modify the fields of a MKMsgStruct structure directly.

If you want to move a message request within a MKConductor's queue you call the MKRepositionMsgRequest() function. The specified MKMsgStruct is moved to the time given by newTimeOfMsg. You should note that the MKMsgStruct that you pass as the aMsgStructPtr argument may be replaced with a new structure that's returned by the function. To make sure you don't keep around a pointer to an obsolete struct, call this function as follows:

	// Reposition and prime aMsgReq for additional functions calls.
   	aMsgReq = MKRepositionMsgRequest(aMsgReq, 3.0);

Parameters:
aMsgStructPtr is a MKMsgStruct *.
newTimeOfMsg is a double.
Returns:
Returns a MKMsgStruct *.
See also:
MKNewMsgRequest().

MKMsgStruct* MKRescheduleMsgRequest ( MKMsgStruct aMsgStructPtr,
id  conductor,
double  timeOfNewMsg,
SEL  whichSelector,
id  destinationObject,
int  argCount,
  ... 
)

Create and manipulate MKConductor message requests.

These functions let you enqueue message requests with a MKConductor object. The MKMsgStruct structure encapulates a message request; it consists of a method selector and its arguments, the recipient of the message, and the time that the message should be sent. A selector can take a maximum of two 4-byte arguments. You should never modify the fields of a MKMsgStruct structure directly.

MKRescheduleMsgRequest() is a convenience function that cancels the structure pointed to by aMsgStructPtr, and then creates and schedules a new request according to the arguments. The new MKMsgStruct is returned.

Parameters:
aMsgStructPtr is a MKMsgStruct.
conductor is an id.
timeOfNewMsg is an id.
whichSelector is a double.
destinationObject is a SEL.
argCount is an int.
Returns:
Returns NULL if argCount is greater than 2.
See also:
MKNewMsgRequest().

void MKScheduleMsgRequest ( MKMsgStruct aMsgStructPtr,
id  conductor 
)

Create and manipulate MKConductor message requests.

These functions let you enqueue message requests with a MKConductor object. The MKMsgStruct structure encapulates a message request; it consists of a method selector and its arguments, the recipient of the message, and the time that the message should be sent. A selector can take a maximum of two 4-byte arguments. You should never modify the fields of a MKMsgStruct structure directly.

MKNewMsgRequest() creates and returns a new MKMsgStruct. timeOfMsg is the time in beats from the beginning of the performance that the message will be sent, whichSelector is the selector, destinationObject is the recipient of the message, and argCount is the number of arguments to the selector followed by the arguments themselves separated by commas.

After you've created a message request structure, you schedule it with a MKConductor by calling MKScheduleMsgRequest().

Parameters:
aMsgStructPtr is a MKMsgStruct.
conductor is an id.
See also:
MKNewMsgRequest().


Generated on Sat Dec 5 17:01:14 2009 for MusicKit by  doxygen 1.5.6