Mac Developer Library

Developer

IOAudioDevice.h Reference

Options
Deployment Target:

On This Page

IOAudioDevice.h Reference

Inheritance


Not Applicable

Conforms To


Not Applicable

Import Statement


Not Applicable

Objective-C

@import Kernel;

Included Headers

  • <IOKit/IOService.h>

  • <IOKit/audio/IOAudioTypes.h>

  • <IOKit/audio/IOAudioStream.h>

  • "IOAudioTypes.h"

  • "IOAudioStream.h"

Data Types

See the Overview section above for header-level documentation.

  • Identifies the power state of the audio device

    Declaration

    Objective-C

    typedef enum _IOAudioDevicePowerState { kIOAudioDeviceSleep = 0, // When sleeping kIOAudioDeviceIdle = 1, // When no audio engines running kIOAudioDeviceActive = 2 // audio engines running } IOAudioDevicePowerState;

    Constants

    • kIOAudioDeviceSleep

      kIOAudioDeviceSleep

      State set when the system is going to sleep

      Available in OS X v10.1 and later.

    • kIOAudioDeviceIdle

      kIOAudioDeviceIdle

      State when the system is awake but none of the IOAudioEngines are in use

      Available in OS X v10.1 and later.

    • kIOAudioDeviceActive

      kIOAudioDeviceActive

      State when one ore more IOAudioEngines are in use. This state transition must complete before the system will begin playing audio.

      Available in OS X v10.1 and later.

    Discussion

    A newly created IOAudioDevices defaults to the idle state.

    Import Statement

    Objective-C

    #include <IOAudioDevice.h>;

    Availability

    Available in OS X v10.1 and later.