<!--
{
  "availability" : [
    "iOS: 18.0.0 -",
    "iPadOS: 18.0.0 -",
    "macCatalyst: 18.0.0 -",
    "macOS: 15.0.0 -",
    "tvOS: 26.0.0 -",
    "visionOS: 2.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "RealityKit",
  "identifier" : "/documentation/RealityKit/Entity/playAudio(configuration:_:)",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Method",
  "symbol" : {
    "kind" : "Instance Method",
    "modules" : [
      "RealityKit"
    ],
    "preciseIdentifier" : "s:17RealityFoundation6EntityC9playAudio13configuration_AA0E19GeneratorControllerCAA0eG13ConfigurationV_s5Int32VSpy10ObjectiveC8ObjCBoolVG_SPySo0E9TimeStampVGs6UInt32VSpySo0E10BufferListVGtctKF"
  },
  "title" : "playAudio(configuration:_:)"
}
-->

# playAudio(configuration:_:)

Prepares and plays a real-time audio playback instance.

```
@MainActor @preconcurrency func playAudio(configuration: AudioGeneratorConfiguration = .init(), _ generatorRenderHandler: @escaping Audio.GeneratorRenderHandler) throws -> AudioGeneratorController
```

## Parameters

`configuration`

A set of configuration parameters necessary for initializing and rendering the `generatorRenderHandler`.

`generatorRenderHandler`

The audio render handler to play. The system runs this handler to generate real-time audio.

## Return Value

An [`AudioGeneratorController`](/documentation/RealityKit/AudioGeneratorController) instance that you use to manage audio
playback. Use the controller to set the volume and start or stop playback.

## Discussion

Maintain playback by keeping a reference to the generator controller.

> Note: See ``Audio.GeneratorRenderHandler`` for compliance with Swift 6 concurrency.

---

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)