Contents

ambientSound

An entity schema for an ambient sound.

Declaration

var ambientSound: some AppSchemaEntity { get }

Discussion

To make your app’s content available to Apple Intelligence, conform your AppEntity to a schema that describes your content to the system. If your app’s functionality aligns with the audio domain and its content matches the ambientSound schema, you can generate the properties and protocol conformance the schema requires for your app entity implementation with the @AppEntity( .audio.ambientSound) Swift macro. To make your app work with Siri, see Apple Intelligence and Siri AI.

The following example shows an app entity that conforms to the ambientSound schema:

@AppEntity(schema: .audio.ambientSound)
struct AmbientSoundEntity {
    // MARK: Static

    static let defaultQuery = AmbientSoundEntityQuery()

    // MARK: Properties

    let id: <#Identifiable.ID#>

    var title: String

    var displayRepresentation: DisplayRepresentation {
        <#DisplayRepresentation#>
    }

    // MARK: Query

    struct AmbientSoundEntityQuery: EntityQuery {
        func entities(for identifiers: [AmbientSoundEntity.ID]) async throws -> [AmbientSoundEntity] {
            <#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.

See Also

Content and parameter types