playAudio
An intent schema that plays an audio item.
Declaration
var playAudio: some AppSchemaIntent { get }Discussion
To make your app’s actions available to Apple Intelligence, conform your AppIntent to a schema that describes your action to the system. If your app’s functionality aligns with the audio domain and one of your app’s actions matches the playAudio schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the @AppIntent( .audio.playAudio) Swift macro. To make your app work with Siri, see Apple Intelligence and Siri AI.
The following example shows an intent that conforms to the playAudio schema:
@AppIntent(schema: .audio.playAudio)
struct PlayAudioIntent: AudioStartingIntent {
var audioEntity: <#AudioItem#>
var playbackAttributes: Set<<#PlaybackAttributes#>>
var warmupAudioQueueResult: <#WarmupAudioQueueResult#>?
var queueLocation: <#QueueInsertionLocation#>?
func perform() async throws -> some IntentResult {
<#code#>
}
}The schema supports the following system experiences:
Siri
Shortcuts
For more information about the App Intents framework and the experiences it supports, see Getting started with the App Intents framework.