<!--
{
  "availability" : [
    "DriverKit: 21.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "AudioDriverKit",
  "identifier" : "/documentation/AudioDriverKit/IOUserAudioStream/HandleChangeCurrentStreamFormat",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Method",
  "symbol" : {
    "kind" : "Instance Method",
    "modules" : [
      "AudioDriverKit"
    ],
    "preciseIdentifier" : "c:@S@IOUserAudioStream@F@HandleChangeCurrentStreamFormat#*1$@N@AudioDriverKit@S@IOUserAudioStreamBasicDescription#"
  },
  "title" : "HandleChangeCurrentStreamFormat"
}
-->

# HandleChangeCurrentStreamFormat

Tells the stream the format is changing.

```
virtual kern_return_t HandleChangeCurrentStreamFormat(const IOUserAudioStreamBasicDescription *in_format);
```

## Parameters

`in_format`

The stream format to set, if possible, as an `IOUserAudioStreamBasicDescription`.

## Return Value

<doc://com.apple.documentation/documentation/DriverKit/kIOReturnSuccess> on success, or another value if an error occurs. For a list of error codes, see <doc://com.apple.documentation/documentation/DriverKit/error-codes>.

## Discussion

The default implementation calls [`SetCurrentStreamFormat`](/documentation/AudioDriverKit/IOUserAudioStream/SetCurrentStreamFormat) and returns <doc://com.apple.documentation/documentation/DriverKit/kIOReturnSuccess>. Subclass and override this method to handle changes to the stream format and return <doc://com.apple.documentation/documentation/DriverKit/kIOReturnSuccess> upon success.

---

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)