Mac OS X Reference Library Apple Developer
Search

IOAudioToggleControl

Inherits from:
Declared In:

Overview

Use the links in the table of contents to the left to access the documentation.



Functions

create

Allocates a new mute control with the given attributes

createPassThruMuteControl

Allocates a new pass through mute control with the given attributes

init

Initializes a newly allocated IOAudioToggleControl with the given attributes


create


Allocates a new mute control with the given attributes

public

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


createPassThruMuteControl


Allocates a new pass through mute control with the given attributes

public

static IOAudioToggleControl *createPassThruMuteControl ( bool initialValue, UInt32 channelID, const char *channelName, UInt32 cntrlID);
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


init


Initializes a newly allocated IOAudioToggleControl with the given attributes

public

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

 

Did this document help you? Yes It's good, but... Not helpful...

Last Updated: 2010-07-29