Mac Developer Library

Developer

IOAudioTypes.h Reference

Options
Deployment Target:

On This Page

IOAudioTypes.h Reference

Included Headers

  • <libkern/OSTypes.h>

  • <mach/message.h>

Data Types

See the Overview section above for header-level documentation.

  • The set of constants passed to IOAudioControlUserClient::getExternalMethodForIndex() when making calls from the IOAudioFamily user client code.

    Declaration

    Objective-C

    typedef enum _IOAudioControlCalls { kIOAudioControlCallSetValue = 0, kIOAudioControlCallGetValue = 1 } IOAudioControlCalls;

    Constants

    • kIOAudioControlCallSetValue

      kIOAudioControlCallSetValue

      Used to set the value of an IOAudioControl.

      Available in OS X v10.1 and later.

    • kIOAudioControlCallGetValue

      kIOAudioControlCallGetValue

      Used to get the value of an IOAudioControl.

      Available in OS X v10.1 and later.

    Import Statement

    Objective-C

    #include <IOAudioTypes.h>;

    Availability

    Available in OS X v10.1 and later.

  • The set of constants passed in the type field of IOAudioControlUserClient::registerNotificaitonPort().

    Declaration

    Objective-C

    typedef enum _IOAudioControlNotifications { kIOAudioControlValueChangeNotification = 0, kIOAudioControlRangeChangeNotification = 1 } IOAudioControlNotifications;

    Constants

    • kIOAudioControlValueChangeNotification

      kIOAudioControlValueChangeNotification

      Used to request value change notifications.

      Available in OS X v10.1 and later.

    • kIOAudioControlRangeChangeNotification

      kIOAudioControlRangeChangeNotification

      Used to request range change notifications.

      Available in OS X v10.2 and later.

    Import Statement

    Objective-C

    #include <IOAudioTypes.h>;

    Availability

    Available in OS X v10.1 and later.

  • The set of constants passed to IOAudioEngineUserClient::getExternalMethodForIndex() when making calls from the IOAudioFamily user client code.

    Declaration

    Objective-C

    typedef enum _IOAudioEngineCalls { kIOAudioEngineCallRegisterClientBuffer = 0, kIOAudioEngineCallUnregisterClientBuffer = 1, kIOAudioEngineCallGetConnectionID = 2, kIOAudioEngineCallStart = 3, kIOAudioEngineCallStop = 4, kIOAudioEngineCallGetNearestStartTime = 5 } IOAudioEngineCalls;

    Import Statement

    Objective-C

    #include <IOAudioTypes.h>;

    Availability

    Available in OS X v10.1 and later.

  • Used to identify the type of memory requested by a client process to be mapped into its process space

    Declaration

    Objective-C

    typedef enum _IOAudioEngineMemory { kIOAudioStatusBuffer = 0, kIOAudioSampleBuffer = 1, kIOAudioMixBuffer = 2, kIOAudioBytesInInputBuffer = 3, kIOAudioBytesInOutputBuffer = 4 } IOAudioEngineMemory;

    Constants

    • kIOAudioSampleBuffer

      kIOAudioSampleBuffer

      This requests the IOAudioEngine's sample buffer

      Available in OS X v10.2 and later.

    • kIOAudioStatusBuffer

      kIOAudioStatusBuffer

      This requests the IOAudioEngine's status buffer. It's type is IOAudioEngineStatus.

      Available in OS X v10.2 and later.

    • kIOAudioMixBuffer

      kIOAudioMixBuffer

      This requests the IOAudioEngine's mix buffer

      Available in OS X v10.2 and later.

    Discussion

    This is the parameter to the type field of IOMapMemory when called on an IOAudioEngine. This is only intended for use by the Audio Device API library.

    Import Statement

    Objective-C

    #include <IOAudioTypes.h>;

    Availability

    Available in OS X v10.1 and later.

  • Represents the state of an IOAudioEngine

    Declaration

    Objective-C

    typedef enum _IOAudioEngineState { kIOAudioEngineStopped = 0, kIOAudioEngineRunning = 1, kIOAudioEnginePaused = 2, kIOAudioEngineResumed = 3 } IOAudioEngineState;

    Constants

    • kIOAudioEngineRunning

      kIOAudioEngineRunning

      The IOAudioEngine is currently running - it is transferring data to or from the device.

      Available in OS X v10.1 and later.

    • kIOAudioEngineStopped

      kIOAudioEngineStopped

      The IOAudioEngine is currently stopped - no activity is occurring.

      Available in OS X v10.1 and later.

    Import Statement

    Objective-C

    #include <IOAudioTypes.h>;

    Availability

    Available in OS X v10.1 and later.

  • Shared-memory structure giving audio engine status

    Declaration

    Objective-C

    typedef struct _IOAudioEngineStatus { UInt32 fVersion; volatile UInt32 fCurrentLoopCount; volatile AbsoluteTime fLastLoopTime; volatile UInt32 fEraseHeadSampleFrame; } IOAudioEngineStatus;

    Import Statement

    Objective-C

    #include <IOAudioTypes.h>;

    Availability

    Available in OS X v10.1 and later.

  • Used in the mach message for IOAudio notifications.

    Declaration

    Objective-C

    typedef struct _IOAudioNotificationMessage { mach_msg_header_t messageHeader; UInt32 type; UInt32 ref; void *sender; } IOAudioNotificationMessage;

    Import Statement

    Objective-C

    #include <IOAudioTypes.h>;

    Availability

    Available in OS X v10.1 and later.

  • A structure for holding a SMPTE time.

    Declaration

    Objective-C

    typedef struct _IOAudioSMPTETime { SInt16 fSubframes; SInt16 fSubframeDivisor; UInt32 fCounter; UInt32 fType; UInt32 fFlags; SInt16 fHours; SInt16 fMinutes; SInt16 fSeconds; SInt16 fFrames; } IOAudioSMPTETime;

    Import Statement

    Objective-C

    #include <IOAudioTypes.h>;

    Availability

    Available in OS X v10.3 and later.

  • Represents the direction of an IOAudioStream

    Declaration

    Objective-C

    typedef enum _IOAudioStreamDirection { kIOAudioStreamDirectionOutput = 0, kIOAudioStreamDirectionInput = 1 } IOAudioStreamDirection;

    Constants

    • kIOAudioStreamDirectionOutput

      kIOAudioStreamDirectionOutput

      Output buffer

      Available in OS X v10.1 and later.

    • kIOAudioStreamDirectionInput

      kIOAudioStreamDirectionInput

      Input buffer

      Available in OS X v10.1 and later.

    Import Statement

    Objective-C

    #include <IOAudioTypes.h>;

    Availability

    Available in OS X v10.1 and later.

  • A structure for holding a SMPTE time.

    Declaration

    Objective-C

    typedef struct _IOAudioSMPTETime { SInt16 fSubframes; SInt16 fSubframeDivisor; UInt32 fCounter; UInt32 fType; UInt32 fFlags; SInt16 fHours; SInt16 fMinutes; SInt16 fSeconds; SInt16 fFrames; } IOAudioSMPTETime;

    Import Statement

    Objective-C

    #include <IOAudioTypes.h>;

    Availability

    Available in OS X v10.3 and later.

Constants

See the Overview section above for header-level documentation.

  • Declaration

    Objective-C

    #define kIOAudioControlNumCalls 2 #define kIOAudioEngineDefaultMixBufferSampleSize sizeof(float) #define kIOAudioEngineNumCalls 6

    Constants

    • kIOAudioControlNumCalls

      kIOAudioControlNumCalls

      The number of elements in the IOAudioControlCalls enum.

      Available in OS X v10.1 and later.

    • kIOAudioEngineDefaultMixBufferSampleSize

      kIOAudioEngineDefaultMixBufferSampleSize

      Available in OS X v10.1 and later.

    • kIOAudioEngineNumCalls

      kIOAudioEngineNumCalls

      The number of elements in the IOAudioEngineCalls enum.

      Available in OS X v10.1 and later.