Mac Developer Library

Developer

IOAudioToggleControl Class Reference

Options
Deployment Target:

On This Page
Language:

IOAudioToggleControl

Inheritance


Not Applicable

Conforms To


Not Applicable

Import Statement


Not Applicable @import Kernel;

Availability


Available in OS X v10.1 and later.
  • Allocates a new mute control with the given attributes

    Declaration

    C++

    static IOAudioToggleControl *create( bool initialValue, UInt32 channelID, const char *channelName = 0, UInt32 cntrlID = 0, UInt32 subType = 0, UInt32 usage = 0);

    Parameters

    initialValue

    The initial value of the control

    channelID

    The ID of the channel(s) that the control acts on. Common IDs are located in IOAudioTypes.h.

    channelName

    An optional name for the channel. Common names are located in IOAudioPort.h.

    cntrlID

    An optional ID for the control that can be used to uniquely identify controls

    Return Value

    Returns a newly allocated and initialized mute IOAudioControl

    Import Statement

  • Allocates a new pass through mute control with the given attributes

    Declaration

    C++

    static IOAudioToggleControl *createPassThruMuteControl ( boolinitialValue, UInt32channelID, const char *channelName, UInt32cntrlID);

    Parameters

    initialValue

    The initial value of the control

    channelID

    The ID of the channel(s) that the control acts on. Common IDs are located in IOAudioTypes.h.

    channelName

    An optional name for the channel. Common names are located in IOAudioPort.h.

    cntrlID

    An optional ID for the control that can be used to uniquely identify controls

    Return Value

    Returns a newly allocated and initialized mute IOAudioControl

    Import Statement

  • Initializes a newly allocated IOAudioToggleControl with the given attributes

    Declaration

    C++

    virtual bool init( bool initialValue, UInt32 channelID, const char *channelName = 0, UInt32 cntrlID = 0, UInt32 subType = 0, UInt32 usage = 0, OSDictionary *properties = 0);

    Parameters

    initialValue

    The initial value of the control

    channelID

    The ID of the channel(s) that the control acts on. Common IDs are located in IOAudioTypes.h.

    channelName

    An optional name for the channel. Common names are located in IOAudioPort.h.

    cntrlID

    An optional ID for the control that can be used to uniquely identify controls

    Return Value

    Returns truen on success

    Import Statement