Contents

playTrailer

An intent schema that plays a trailer for a piece of supported video content.

Declaration

var playTrailer: 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 video domain and one of your app’s actions matches the playTrailer schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the @AppIntent( .video.playTrailer) 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 playTrailer schema:

@AppIntent(schema: .video.playTrailer)
struct PlayTrailerIntent {
    /// Content to preview.
    var content: <#TrailerContent#>

    func perform() async throws -> some IntentResult {
        <#code#>
    }
}

Define a @UnionValue enumeration for the content parameter, as in the following example, by typing the first few characters of video_trailerContent in Xcode and selecting it from the code-completion suggestions.

@UnionValue
enum TrailerContent {
    case movie(<#MovieEntity#>)
    case tvShow(<#TVShowEntity#>)
    case tvSeason(<#TVSeasonEntity#>)
}

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

Actions