<!--
{
  "availability" : [
    "DriverKit: 21.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "AudioDriverKit",
  "identifier" : "/documentation/AudioDriverKit/IOUserAudioBooleanControl",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "AudioDriverKit"
    ],
    "preciseIdentifier" : "c:@S@IOUserAudioBooleanControl"
  },
  "title" : "IOUserAudioBooleanControl"
}
-->

# IOUserAudioBooleanControl

A control object that supports setting a Boolean value.

```
class IOUserAudioBooleanControl;
```

## Topics

### Creating a Boolean Control

[`static OSSharedPtr<IOUserAudioBooleanControl> Create(IOUserAudioDriver *in_driver, bool in_is_settable, bool in_control_value, IOUserAudioObjectPropertyElement in_control_element, IOUserAudioObjectPropertyScope in_control_scope, IOUserAudioClassID in_control_class_id);`](/documentation/AudioDriverKit/IOUserAudioBooleanControl/Create)

Allocates and initializes an instance of the Boolean control class.

[`virtual bool init(IOUserAudioDriver *in_driver, bool in_is_settable, bool in_control_value, IOUserAudioObjectPropertyElement in_control_element, IOUserAudioObjectPropertyScope in_control_scope, IOUserAudioClassID in_control_class_id);`](/documentation/AudioDriverKit/IOUserAudioBooleanControl/init)

Initializes an instance of a Boolean control.

[`typedef uint32_t IOUserAudioObjectPropertyElement;`](/documentation/AudioDriverKit/AudioDriverKit/IOUserAudioObjectPropertyElement)

A four character code which, along with the selector and scope, identify a specific piece of information about an audio object.

[`enum IOUserAudioObjectPropertyScope : uint32_t;`](/documentation/AudioDriverKit/AudioDriverKit/IOUserAudioObjectPropertyScope)

A four character code which, along with the selector and element, identify a specific piece of information about an audio object.

### Freeing a Boolean Control

[`virtual void free();`](/documentation/AudioDriverKit/IOUserAudioBooleanControl/free)

Frees the audio Boolean control.

### Getting Information About the Class

[`virtual IOUserAudioClassID GetClassID();`](/documentation/AudioDriverKit/IOUserAudioBooleanControl/GetClassID)

Gets the audio class identifier of the object.

[`virtual IOUserAudioClassID GetBaseClassID();`](/documentation/AudioDriverKit/IOUserAudioBooleanControl/GetBaseClassID)

Gets the audio class identifier of the base class object.

[`enum IOUserAudioClassID : uint32_t;`](/documentation/AudioDriverKit/AudioDriverKit/IOUserAudioClassID)

An identifier for the type of audio object.

### Supporting Value Changes

[`virtual kern_return_t HandleChangeControlValue(bool in_control_value);`](/documentation/AudioDriverKit/IOUserAudioBooleanControl/HandleChangeControlValue)

Tells the Boolean control the value is changing.

### Accessing the Value

[`kern_return_t SetControlValue(bool in_control_value);`](/documentation/AudioDriverKit/IOUserAudioBooleanControl/SetControlValue)

Sets the Boolean value of the control.

[`bool GetControlValue();`](/documentation/AudioDriverKit/IOUserAudioBooleanControl/GetControlValue)

Gets the Boolean value of the control.

## Relationships

### Inherits From

[`IOUserAudioControl`](/documentation/AudioDriverKit/IOUserAudioControl)

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)