MKDeviceStatus.h File Reference

Go to the source code of this file.

Typedefs
typedef enum _MKDeviceStatus	MKDeviceStatus
	Status for MKMidi/MKOrchestra MusicKit classes.
Enumerations
enum	_MKDeviceStatus { MK_devClosed = 0, MK_devOpen, MK_devRunning, MK_devStopped }
	Status for MKMidi/MKOrchestra MusicKit classes. More...

---

Detailed Description

---

Typedef Documentation

typedef enum _MKDeviceStatus MKDeviceStatus

Status for MKMidi/MKOrchestra MusicKit classes.

MKDeviceStatus enum values define the status of objects that represent devices, such as MKMidi and the MKOrchestra. Such classes are called device classes. The values for MKDeviceStatus are defined below.

There are five methods for changing the state, defined in all MusicKit device classes:

• open Opens Mach device if not already open. Resets object if needed. Sets status to MK_devOpen. Returns nil if some problem occurs, else self.
• run If not open, does a [self open]. If not already running, starts device clock. Sets status to MK_devRunning.
• stop If not open, does a [self open]. Otherwise, stops device clock and sets status to MK_devStopped.
• close Closes the device after waiting for all enqueued events to finish. Returns self and sets status to MK_devClosed unless there's some problem closing the device, in which case, returns nil.
• abort Like close, but doesn't wait for enqueued events to finish.

---

Enumeration Type Documentation

enum _MKDeviceStatus

Status for MKMidi/MKOrchestra MusicKit classes.

MKDeviceStatus enum values define the status of objects that represent devices, such as MKMidi and the MKOrchestra. Such classes are called device classes. The values for MKDeviceStatus are defined below.

There are five methods for changing the state, defined in all MusicKit device classes:

• open Opens Mach device if not already open. Resets object if needed. Sets status to MK_devOpen. Returns nil if some problem occurs, else self.
• run If not open, does a [self open]. If not already running, starts device clock. Sets status to MK_devRunning.
• stop If not open, does a [self open]. Otherwise, stops device clock and sets status to MK_devStopped.
• close Closes the device after waiting for all enqueued events to finish. Returns self and sets status to MK_devClosed unless there's some problem closing the device, in which case, returns nil.
• abort Like close, but doesn't wait for enqueued events to finish.

Enumerator:

MK_devClosed	Device is closed.
MK_devOpen	Device is open but its clock has not yet begun to run. It's clock is in a reset state.
MK_devRunning	Device is open and its clock is running.
MK_devStopped	Device is open, its clock has run, but it has been temporarily stopped.