Class

INStartPhotoPlaybackIntent

Requests a search for photos and the initiation of a slideshow containing the results.

Overview

The system creates an 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 that were provided and ignore any that have no values.

To handle this intent, the handler object in your Intents extension must adopt the INStartPhotoPlaybackIntentHandling protocol. Your handler should confirm the request and create an 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.

Additional Intent Attributes

Table 1 lists additional attributes of this intent object.

Table 1

Start photo playback intent attributes

Attribute

Description

Supported by

Siri

Always requires unlocked device

Yes

Example Phrases

There are many ways in which users can ask Siri to start a slideshow. Table 2 provides a few sample phrases in different languages. You can use these phrases during testing to trigger your intents. This list is not exhaustive and Siri may recognize many other phrases.

Table 2

Siri phrases that trigger the starting of a slideshow

Locale

Example 1

Example 2

en

Start a slideshow in <appName>

zh_CN

<appName>搜索相册

zh_HK

<appName>搵吓上個禮拜影嘅相

去微信搵吓上個禮拜影嘅相

zh_TW

yue_CN

去<appName>揾吓上个礼拜影嘅相

去微信揾吓上个礼拜影嘅相

ar

بدء عرض الشرائح في <appName>

da

de

Zeige eine Diashow mit <appName>

Starte eine Diavorführung mit <appName>

es

Inicia una presentación de diapositivas con <appName>

Pon una secuencia de diapositivas de mis fotos de <appName>

fi

Aloita kuvaesitys <appName>ssa

Aloita <appName> kuvaesitys

fr

Lance un diaporama avec <appName>

Démarre un diaporama sur <appName>

he

תתחיל מצגת של אלבום המועדפים שלי באמצעות <appName>

תתחיל מצגת באמצעות <appName>

it

Fai partire uno slideshow con <appName>

ja

<appName>でスライドショーを開始

<appName>のスライドショーを開始

ko

<appName>에서 슬라이드 쇼 시작해

<appName>에서 슬라이드 쇼 해

ms

Mulakan tayangan slaid album kucing saya dengan <appName>

Tayangkan slaid percutian dengan <appName>

nb

Start et slideshow med <appName>

nl

Start een diavoorstelling in<appName>

pt

Começar uma apresentação de slides no <appName>

Inicie uma apresentação de slides no <appName>

ru

Сделай результаты как слайдшоу в <appName>

Покажи как слайдшоу в <appName>

sv

starta ett bildspel av mina favoritalbum i <appName>

th

เล่นสไลด์โชว์ใน <appName>

tr

<appName> kullanarak fovoriler albümümü slayt sunusu yap

Favoriler albümümü <appName> slayt sunusu yap

In the preceding examples, <appName> represents the name of the app whose Intents extension performs the search and initiates the slideshow. If your app uses custom photo album names, photo tags, or contact names, you can tell Siri about those names using the INVocabulary class.

Topics

Getting the People in the Photos

var peopleInPhoto: [INPerson]?

The users in the photos.

var peopleInPhotoOperator: INConditionalOperator

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

Getting the Search Terms

var searchTerms: [String]?

An array of terms to look for in the photos.

var searchTermsOperator: INConditionalOperator

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

Getting the Search Attributes

var dateCreated: INDateComponentsRange?

The range of dates during which the photos were taken.

var locationCreated: CLPlacemark?

The location where the photos were taken.

var albumName: String?

The name of the album that contains the photos.

var includedAttributes: INPhotoAttributeOptions

The attributes that must be present in the photos.

var excludedAttributes: INPhotoAttributeOptions

The attributes that must not be present in the photos.

Relationships

Inherits From

Conforms To

See Also

Start Photo Playback

protocol INStartPhotoPlaybackIntentHandling

Handles the searching of the user’s photos and the playback of the results.

class INStartPhotoPlaybackIntentResponse

Contains your app’s response to a start photo playback intent.