<!--
{
  "availability" : [
    "iOS: 10.0.0 - 15.0.0",
    "iPadOS: 10.0.0 - 15.0.0",
    "macCatalyst: 13.1.0 - 15.0.0",
    "visionOS: 1.0.0 - 1.0.0",
    "watchOS: 3.2.0 - 8.0.0"
  ],
  "documentType" : "symbol",
  "framework" : "SiriKit",
  "identifier" : "/documentation/Intents/INStartPhotoPlaybackIntent",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "Intents"
    ],
    "preciseIdentifier" : "c:objc(cs)INStartPhotoPlaybackIntent"
  },
  "title" : "INStartPhotoPlaybackIntent"
}
-->

# INStartPhotoPlaybackIntent

A request to search for photos and initiate a slideshow with the results.

```
class INStartPhotoPlaybackIntent
```

## Overview

The system creates an [`INStartPhotoPlaybackIntent`](/documentation/Intents/INStartPhotoPlaybackIntent) object when the user asks to start a slideshow of a set of photos. This intent object contains the parameters to use when searching for the photos, including the possible name of a photo album, the people in the photos, or the location of the photos. Use this intent object to perform the search and initiate the slideshow in your app. When performing the search, use only the parameters provided and ignore any that have no values.

To handle this intent, the handler object in your Intents extension must adopt the [`INStartPhotoPlaybackIntentHandling`](/documentation/Intents/INStartPhotoPlaybackIntentHandling) protocol. Your handler should confirm the request and create an [`INStartPhotoPlaybackIntentResponse`](/documentation/Intents/INStartPhotoPlaybackIntentResponse) object with the results of the search. After a successful search, Siri launches your app so that it can begin the slideshow.

For a list of other intents in the photos domain, see [`INPhotosDomainHandling`](/documentation/Intents/INPhotosDomainHandling).

### Additional Intent Attributes

The following table lists additional attributes of this intent object:

|Attribute                      |Description |
|-------------------------------|------------|
|Supported by                   |Siri Intents|
|Always requires unlocked device|Yes         |

## Topics

### Creating the Intent Object

[`init(dateCreated:locationCreated:albumName:searchTerms:includedAttributes:excludedAttributes:peopleInPhoto:)`](/documentation/Intents/INStartPhotoPlaybackIntent/init(dateCreated:locationCreated:albumName:searchTerms:includedAttributes:excludedAttributes:peopleInPhoto:))

Initializes an intent object with the specified search parameters.

### Getting the People in the Photos

[`peopleInPhoto`](/documentation/Intents/INStartPhotoPlaybackIntent/peopleInPhoto)

The people in the photos.

[`peopleInPhotoOperator`](/documentation/Intents/INStartPhotoPlaybackIntent/peopleInPhotoOperator)

The operator that defines how to search for people in the photos.

### Getting the Search Terms

[`searchTerms`](/documentation/Intents/INStartPhotoPlaybackIntent/searchTerms)

An array of terms to look for in the photos.

[`searchTermsOperator`](/documentation/Intents/INStartPhotoPlaybackIntent/searchTermsOperator)

The operator that defines how to incorporate the search terms when performing the search.

### Getting the Search Attributes

[`dateCreated`](/documentation/Intents/INStartPhotoPlaybackIntent/dateCreated)

The range of dates during which someone took the pictures.

[`locationCreated`](/documentation/Intents/INStartPhotoPlaybackIntent/locationCreated)

The location where someone took the photos.

[`albumName`](/documentation/Intents/INStartPhotoPlaybackIntent/albumName)

The name of the album that contains the photos.

[`includedAttributes`](/documentation/Intents/INStartPhotoPlaybackIntent/includedAttributes)

The attributes that must be present in the photos.

[`excludedAttributes`](/documentation/Intents/INStartPhotoPlaybackIntent/excludedAttributes)

The attributes that must not be present in the photos.


---

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)