freeformVideo
An entity schema for a freeform video.
Declaration
var freeformVideo: 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 video domain and its content matches the freeformVideo schema, you can generate the properties and protocol conformance the schema requires for your app entity implementation with the @AppEntity( .video.freeformVideo) 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 freeformVideo schema:
@AppEntity(schema: .video.freeformVideo)
struct FreeformVideoEntity {
// MARK: Static
static let defaultQuery = FreeformVideoEntityQuery()
// MARK: Properties
let id: <#Identifiable.ID#>
var title: String
var creator: <#VideoContentCreator#>?
var images: [<#VideoImage#>]
var url: URL?
var collaborators: [<#VideoContentCreator#>]
var tags: [String]
var description: String?
var contentType: <#VideoContentType#>
var viewCount: Int?
var releaseDate: Date?
var duration: Duration?
var isExplicitContent: Bool
var displayRepresentation: DisplayRepresentation {
<#DisplayRepresentation#>
}
// MARK: Query
struct FreeformVideoEntityQuery: EntityQuery {
func entities(for identifiers: [FreeformVideoEntity.ID]) async throws -> [FreeformVideoEntity] {
<#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.