Alexa.RemoteVideoPlayer Interface: SearchAndDisplayResults (VSK Fire TV)
When users say utterances to find media, such as "Search for [X]," the Alexa.RemoteVideoPlayer
interface sends SearchAndDisplayResults
directives to your app or Lambda. For this directive, your app's logic should take users to search results pages rather than going directly to media playback.
- Utterances for SearchAndDisplayResults Directives
- SearchAndDisplayResults Directive Example
- Payload Definitions
- Handling SearchAndDisplayResults Directives
- Response Example
- Declaring Capability Support for this Interface
Utterances for SearchAndDisplayResults Directives
Alexa sends a SearchAndDisplayResults
directive to your app (for app-only integrations) or to your Lambda (for cloudside integrations) when users say the following utterances.
Feature | Sample Utterances | Expected Response |
---|---|---|
Search for [title] Required for certification |
Search for breaking bad |
A list of matches for the title is presented to the user. |
Search by actor Required for certification |
Search for sean connery |
A list of matches featuring the actor is presented to the user. |
Search by genre name Required for certification |
Search for comedy |
The user is presented with a list of matching results for media from the requested genre (personalized through an algorithm that selects recommended media for the user). |
Search by franchise [title] Required for certification |
Search for star trek |
The user is presented with a list of matching results for the franchise. |
Search by media type Optional |
Search movies |
A list of matches for the desired media type is presented to the user. |
Search [title] with season number Optional |
Search breaking bad season two |
All episodes for the matching season are presented to the user. |
Search [title] with episode number Optional |
Search for breaking bad episode five |
A list of available episodes within the season the user recently watched appears. For example, if the user's viewing progress is within Season 2, a list of episodes from Season 2 appears. |
Search [title] with season and episode number Optional |
Search for breaking bad season two episode five |
A list of available episodes for the season the user requested appears, including the episode the user specifically asked for. |
Search by character name Optional |
Search for james bond |
The user is presented with a list of matching results for media featuring the character name. |
Search by director name Optional |
Search for quentin tarantino |
The user is presented with a list of matching results for media produced by the requested director. |
Search by production company Optional |
Search for disney |
The user is presented with a list of matching results for media from the production company. |
Search by sports team Optional |
Search seahawks |
The user is presented with a list of matching results for the sports team. |
Search by sports type Optional |
Search for soccer |
The user is presented with a list of matching results for the sports type (preferably based on recommendations for the user). |
Search by sports league Optional |
Search for n. b. a. league |
The user is presented with a list of matching results for the sports league (preferably based on recommendations for the user). |
Search by sports event Optional |
Search for soccer game |
The user is presented with a list of matching results for the sports event (preferably based on recommendations for the user). |
Launch [partner] app Required for certification |
Launch netflix app |
The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories. |
Launch special character title Required for certification |
Launch a. t. and t. u-verse app |
The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories. |
Feature | Sample Utterances | Expected Response |
---|---|---|
Search for [title] Required for certification |
trouve / cherche / montre [VideoName] sur [AppName] |
A list of matches for the title is presented to the user. |
Search by actor Required for certification |
recherche des films avec [ActorName] cherche des films avec [ActorName] |
A list of matches featuring the actor is presented to the user. |
Search by genre name Required for certification |
recherche un/une [GenreName] cherche un/une [GenreName] |
The user is presented with a list of matching results for media from the requested genre (personalized through an algorithm that selects recommended media for the user). |
Search by franchise [title] Required for certification |
recherche [VideoName] cherche [VideoName] |
The user is presented with a list of matching results for the franchise. |
Search by media type Optional |
recherche [mediatype] cherche [mediatype] |
A list of matches for the desired media type is presented to the user. |
Search [title] with season number Optional |
recherche la saison [number] de [title] cherche la saison [number] de [title] |
All episodes for the matching season are presented to the user. |
Search [title] with episode number Optional |
recherche la saison [number] de [title] cherche la saison [number] de [title] |
A list of available episodes within the season the user recently watched appears. For example, if the user's viewing progress is within Season 2, a list of episodes from Season 2 appears. |
Search [title] with season and episode number Optional |
recherche/cherche la saison [SeasonNumber] de [VideoName] recherche/cherchel'épisode [EpisodeNumber] de [VideoName] recherche/cherchel'épisode [EpisodeNumber] de la saison [SeasonNumber] de [VideoName] recherche/cherchela saison [SeasonNumber] de [VideoName] recherche/cherchel'épisode [EpisodeNumber] de [VideoName] recherche/cherchel'épisode [EpisodeNumber] de la saison [SeasonNumber] de [VideoName] |
A list of available episodes for the season the user requested appears, including the episode the user specifically asked for. |
Search by character name Optional |
recherche un film avec [charactername] cherche un film avec [charactername] |
The user is presented with a list of matching results for media featuring the character name. |
Search by director name Optional |
recherche un film de [DirectorName] cherche un film de [DirectorName] |
The user is presented with a list of matching results for media produced by the requested director. |
Search by production company Optional |
recherche des films de disney cherche des films de disney |
The user is presented with a list of matching results for media from the production company. |
Search by sports team Optional |
Not supported |
The user is presented with a list of matching results for the sports team. |
Search by sports type Optional |
Not supported |
The user is presented with a list of matching results for the sports type (preferably based on recommendations for the user). |
Search by sports league Optional |
recherche [league] cherche [league] |
The user is presented with a list of matching results for the sports league (preferably based on recommendations for the user). |
Search by sports event Optional |
Not supported |
The user is presented with a list of matching results for the sports event (preferably based on recommendations for the user). |
Launch [partner] app Required for certification |
pars [AppName] |
The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories. |
Launch special character title Required for certification |
pars [AppName] |
The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories. |
Feature | Sample Utterances | Expected Response |
---|---|---|
Search for [title] Required for certification |
trouve / cherche / montre [VideoName] sur [AppName] |
A list of matches for the title is presented to the user. |
Search by actor Required for certification |
cherche des films avec [ActorName] |
A list of matches featuring the actor is presented to the user. |
Search by genre name Required for certification |
cherche une comédie |
The user is presented with a list of matching results for media from the requested genre (personalized through an algorithm that selects recommended media for the user). |
Search by franchise [title] Required for certification |
cherche star trek |
The user is presented with a list of matching results for the franchise. |
Search by media type Optional |
Cherche [mediatype] |
A list of matches for the desired media type is presented to the user. |
Search [title] with season number Optional |
cherche la saison [number] de [title] |
All episodes for the matching season are presented to the user. |
Search [title] with episode number Optional |
cherche l'épisode [number] de [title] |
A list of available episodes within the season the user recently watched appears. For example, if the user's viewing progress is within Season 2, a list of episodes from Season 2 appears. |
Search [title] with season and episode number Optional |
cherche la saison [SeasonNumber] de [VideoName] cherche l'épisode [EpisodeNumber] de [VideoName] cherche l'épisode [EpisodeNumber] de la saison [SeasonNumber] de [VideoName] cherche la saison [SeasonNumber] de [VideoName] cherche l'épisode [EpisodeNumber] de [VideoName] cherche l'épisode [EpisodeNumber] de la saison [SeasonNumber] de [VideoName] |
A list of available episodes for the season the user requested appears, including the episode the user specifically asked for. |
Search by character name Optional |
cherche un film avec [charactername] |
The user is presented with a list of matching results for media featuring the character name. |
Search by director name Optional |
cherche un film de quentin tarantino |
The user is presented with a list of matching results for media produced by the requested director. |
Search by production company Optional |
cherche des films de disney |
The user is presented with a list of matching results for media from the production company. |
Search by sports team Optional |
Not supported |
The user is presented with a list of matching results for the sports team. |
Search by sports type Optional |
Not supported |
The user is presented with a list of matching results for the sports type (preferably based on recommendations for the user). |
Search by sports league Optional |
cherche [league] |
The user is presented with a list of matching results for the sports league (preferably based on recommendations for the user). |
Search by sports event Optional |
Not supported |
The user is presented with a list of matching results for the sports event (preferably based on recommendations for the user). |
Launch [partner] app Required for certification |
lance [AppName] |
The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories. |
Launch special character title Required for certification |
lance [AppName] |
The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories. |
Feature | Sample Utterances | Expected Response |
---|---|---|
Search for [title] Required for certification |
such nach? [VideoName] such/zeig/find film? [VideoName] auf [AppName] zeig mir film? [VideoName] auf [DeviceBrand] such trailer von [VideoName] |
A list of matches for the title is presented to the user. |
Search by actor Required for certification |
such [ActorNameName] filme zeig filme mit [ActorNameName] |
A list of matches featuring the actor is presented to the user. |
Search by genre name Required for certification |
zeig [GenreNameName] filme auf [AppName] such nach [GenreName] [MediaType] |
The user is presented with a list of matching results for media from the requested genre (personalized through an algorithm that selects recommended media for the user). |
Search by franchise [title] Required for certification |
such nach? [VideoName] such/zeig/find film? [VideoName] auf [AppName] zeig mir film? [VideoName] auf [DeviceBrand] such trailer von [VideoName] |
The user is presented with a list of matching results for the franchise. |
Search by media type Optional |
find [MediaType] such/zeig/empfiehl [MediaType] |
A list of matches for the desired media type is presented to the user. |
Search [title] with season number Optional |
spiel [VideoName] [Season] [Season_Numer] spiel [VideoName] [Season] [Season_Numer] auf [AppName] |
All episodes for the matching season are presented to the user. |
Search [title] with episode number Optional |
spiel die [Episode_Number] [Episode] von [VideoName] spiel [VideoName] [Episode_Number] spiel von [VideoName] [Episode] [Episode_Number] |
A list of available episodes within the season the user recently watched appears. For example, if the user's viewing progress is within Season 2, a list of episodes from Season 2 appears. |
Search [title] with season and episode number Optional |
spiel [Season] [Season_Numer] [Episode] [Episode_Number] von [VideoName] spiel [VideoName] [Season] [Season_Numer] [Episode] [Episode_Number] spiel die [VideoName] [Season] [Season_Numer] [Episode] [Episode_Number] auf [AppName] ab |
A list of available episodes for the season the user requested appears, including the episode the user specifically asked for. |
Search by character name Optional |
Not supported |
The user is presented with a list of matching results for media featuring the character name. |
Search by director name Optional |
such nach [MediaType] mit [ActorName] such [ActorName] [MediaType] zeig [MediaType] mit [ActorName] |
The user is presented with a list of matching results for media produced by the requested director. |
Search by production company Optional |
suche nach [ProductionCompany] filmenzeige mir [ProductionCompany] filme |
The user is presented with a list of matching results for media from the production company. |
Search by sports team Optional |
|
The user is presented with a list of matching results for the sports team. |
Search by sports type Optional |
such [Sport] [Event] find [Sport] [Event] |
The user is presented with a list of matching results for the sports type (preferably based on recommendations for the user). |
Search by sports league Optional |
Not supported |
The user is presented with a list of matching results for the sports league (preferably based on recommendations for the user). |
Search by sports event Optional |
such [Sport] [Event] find [Sport] [Event] |
The user is presented with a list of matching results for the sports event (preferably based on recommendations for the user). |
Launch [partner] app Required for certification |
starte [AppName] spiel/öffne [AppName] app starte [AppName] auf [DeviceBrand] |
The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories. |
Launch special character title Required for certification |
starte [AppName] spiel/öffne [AppName] app starte AppName auf [DeviceBrand] |
The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories. |
Feature | Sample Utterances | Expected Response |
---|---|---|
Search for [title] Required for certification |
[VideoName] खोजो/ढूँढो [AppName] पे/पर/में [VideoName] दिखा/खोज दो मुझे [VideoName] दिखाओ/खोजो/ढूँढो मुझे [AppName] पे/पर/में [VideoName] दिखाओ/खोजो/ढूँढो मुझे [VideoName] को [AppName] पे पर में दिखाओ/खोजो/ढूँढो खोजो [VideoName] |
A list of matches for the title is presented to the user. |
Search by actor Required for certification |
[ActorName] के/का/की/वाला movies दिखाओ/ढूँढो [ActorName] के/का/की/वाला [GenreName] movies दिखाओ/खोजो/ढूँढो [ActorName] के/का/की/वाला [GenreName] movie [VideoName] दिखाओ/खोजो/ढूँढो दिखाओ/खोजो [ActorName] के/का/की/वाला [GenreName] movies |
A list of matches featuring the actor is presented to the user. |
Search by genre name Required for certification |
[GenreName] movies दिखाओ/ढूँढो [ActorName] के/का/की/वाला [GenreName] movies दिखाओ/खोजो/ढूँढो |
The user is presented with a list of matching results for media from the requested genre (personalized through an algorithm that selects recommended media for the user). |
Search by franchise [title] Required for certification |
start trek के लिए ढूँढ़ो/ढूँढ़ना/खोजो/खोजना/search करना |
The user is presented with a list of matching results for the franchise. |
Search by media type Optional |
[VideoName] movie दिखाओ/ढूँढो [AppName] पे/पर/में [MediaType] को खोजो [ChannelName] को खोजो/ढूँढो |
A list of matches for the desired media type is presented to the user. |
Search [title] with season number Optional |
breaking bad season दो ढूँढ़ो/ढूँढ़ना/खोजो/खोजना/search करना |
All episodes for the matching season are presented to the user. |
Search [title] with episode number Optional |
breaking bad episode पाँच के लिए ढूँढ़ो/ढूँढ़ना/खोजो/खोजना/search करना |
A list of available episodes within the season the user recently watched appears. For example, if the user's viewing progress is within Season 2, a list of episodes from Season 2 appears. |
Search [title] with season and episode number Optional |
breaking bad season दो episode five के लिये ढूँढ़ो/ढूँढ़ना/खोजो/खोजना/search करना |
A list of available episodes for the season the user requested appears, including the episode the user specifically asked for. |
Search by character name Optional |
[CharacterName] movie दिखाओ/खोजो [CharacterName] के/का/की/वाला movie [VideoName] दिखाओ/खोजो/ढूँढो |
The user is presented with a list of matching results for media featuring the character name. |
Search by director name Optional |
quentin tarantino के लिए ढूँढ़ो/ढूँढ़ना/खोजो/खोजना/search करना |
The user is presented with a list of matching results for media produced by the requested director. |
Search by production company Optional |
disney के लिए ढूँढ़ो/ढूँढ़ना/खोजो/खोजना/search करना |
The user is presented with a list of matching results for media from the production company. |
Search by sports team Optional |
[Sport/League/Seam] games दिखाओ/खोजो/ढूँढो [Sport] के [Event] को दिखाओ/खोजो [Sport] के [Event] को दिखाओ/खोजो |
The user is presented with a list of matching results for the sports team. |
Search by sports type Optional |
[Sport/League/Seam] games दिखाओ/खोजो/ढूँढो [Sport] के [Event] को दिखाओ/खोजो |
The user is presented with a list of matching results for the sports type (preferably based on recommendations for the user). |
Search by sports league Optional |
[Sport/League/Seam] games दिखाओ/खोजो/ढूँढो [Sport] के [Event] को दिखाओ/खोजो |
The user is presented with a list of matching results for the sports league (preferably based on recommendations for the user). |
Search by sports event Optional |
[Sport/League/Seam] games दिखाओ/खोजो/ढूँढो [Sport] के [Event] को दिखाओ/खोजो |
The user is presented with a list of matching results for the sports event (preferably based on recommendations for the user). |
Launch [partner] app Required for certification |
netflix launch करो/करना/कीजिए/करिएगा |
The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories. |
Launch special character title Required for certification |
facebook app launch करो/करना/कीजिए/करिएगा |
The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories. |
Feature | Sample Utterances | Expected Response |
---|---|---|
Search for [title] Required for certification |
trova / cerca / mostra / dammi + VideoName (+ da/su ServiceName)? |
A list of matches for the title is presented to the user. |
Search by actor Required for certification |
cerca film con [ActorName] trova un film con [ActorName] |
A list of matches featuring the actor is presented to the user. |
Search by genre name Required for certification |
cerca [GenreName] trova [GenreName] |
The user is presented with a list of matching results for media from the requested genre (personalized through an algorithm that selects recommended media for the user). |
Search by franchise [title] Required for certification |
cerca [VideoName] trova [VideoName] |
The user is presented with a list of matching results for the franchise. |
Search by media type Optional |
cerca [mediatype] trova mi un [mediatye] |
A list of matches for the desired media type is presented to the user. |
Search [title] with season number Optional |
cerca la stagione due di [VideoName] trova la stagione due di [VideoName] |
All episodes for the matching season are presented to the user. |
Search [title] with episode number Optional |
cerca [VideoName] Episodio cinque trova [VideoName] Episodio cinque |
A list of available episodes within the season the user recently watched appears. For example, if the user's viewing progress is within Season 2, a list of episodes from Season 2 appears. |
Search [title] with season and episode number Optional |
cerca [VideoName] episodio [EpisodeNumber] trova [VideoName] episodio [EpisodeNumber] cerca [VideoName] stagione [SeasonNumber] trova [VideoName] stagione [SeasonNumber] cerca [VideoName] stagione [SeasonNumber] episodio [EpisodeNumber] trova [VideoName] stagione [SeasonNumber] episodio [EpisodeNumber] |
A list of available episodes for the season the user requested appears, including the episode the user specifically asked for. |
Search by character name Optional |
cerca un film con [CharacterName] trova un film con [CharacterName] |
The user is presented with a list of matching results for media featuring the character name. |
Search by director name Optional |
cerca [DirectorName] |
The user is presented with a list of matching results for media produced by the requested director. |
Search by production company Optional |
cerca disney |
The user is presented with a list of matching results for media from the production company. |
Search by sports team Optional |
not supported |
The user is presented with a list of matching results for the sports team. |
Search by sports type Optional |
cerca [Sport] trova [Sport] |
The user is presented with a list of matching results for the sports type (preferably based on recommendations for the user). |
Search by sports league Optional |
not supported |
The user is presented with a list of matching results for the sports league (preferably based on recommendations for the user). |
Search by sports event Optional |
cerca partite di [SportName] trova partite di calcio |
The user is presented with a list of matching results for the sports event (preferably based on recommendations for the user). |
Launch [partner] app Required for certification |
lancia [AppName] apri [AppName] |
The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories. |
Launch special character title Required for certification |
apri [special character AppName] |
The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories. |
Feature | Sample Utterances | Expected Response |
---|---|---|
Search for [title] Required for certification |
[VideoName]を探して[VideoName]を<AppName]で探して |
A list of matches for the title is presented to the user. |
Search by actor Required for certification |
[ActorNameName]が出ている[MediaType]を探して |
A list of matches featuring the actor is presented to the user. |
Search by genre name Required for certification |
[GenreNameName]の[MediaType]を見つけて |
The user is presented with a list of matching results for media from the requested genre (personalized through an algorithm that selects recommended media for the user). |
Search by franchise [title] Required for certification |
|
The user is presented with a list of matching results for the franchise. |
Search by media type Optional |
[MediaType]を探して [AppName]で[MediaType]を探して [ChannelName]を検索 |
A list of matches for the desired media type is presented to the user. |
Search [title] with season number Optional |
|
All episodes for the matching season are presented to the user. |
Search [title] with episode number Optional |
|
A list of available episodes within the season the user recently watched appears. For example, if the user's viewing progress is within Season 2, a list of episodes from Season 2 appears. |
Search [title] with season and episode number Optional |
[title] シーズン[SeasonNumber] エピソード[EpisodeNumber] を探して |
A list of available episodes for the season the user requested appears, including the episode the user specifically asked for. |
Search by character name Optional |
[CharacterNameName]が主人公の[MediaType]を探して |
The user is presented with a list of matching results for media featuring the character name. |
Search by director name Optional |
|
The user is presented with a list of matching results for media produced by the requested director. |
Search by production company Optional |
[ProductionCompany]を検索 |
The user is presented with a list of matching results for media from the production company. |
Search by sports team Optional |
[Sport]の[Event]を見つけて[SportTeam]の[Event]を見つけて |
The user is presented with a list of matching results for the sports team. |
Search by sports type Optional |
[Sport]の[Event]を見つけて[SportTeam]の[Event]を見つけて |
The user is presented with a list of matching results for the sports type (preferably based on recommendations for the user). |
Search by sports league Optional |
[Sport]の[Event]を見つけて[SportTeam]の[Event]を見つけて |
The user is presented with a list of matching results for the sports league (preferably based on recommendations for the user). |
Search by sports event Optional |
[Sport]の[Event]を見つけて[SportTeam]の[Event]を見つけて |
The user is presented with a list of matching results for the sports event (preferably based on recommendations for the user). |
Launch [partner] app Required for certification |
|
The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories. |
Launch special character title Required for certification |
|
The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories. |
Feature | Sample Utterances | Expected Response |
---|---|---|
Search for [title] Required for certification |
procurar/buscar/mostrar [VideoName] no/na [AppName] |
A list of matches for the title is presented to the user. |
Search by actor Required for certification |
procurar por [ActorName] |
A list of matches featuring the actor is presented to the user. |
Search by genre name Required for certification |
procurar por [GenreName] |
The user is presented with a list of matching results for media from the requested genre (personalized through an algorithm that selects recommended media for the user). |
Search by franchise [title] Required for certification |
procurar[VideoName] |
The user is presented with a list of matching results for the franchise. |
Search by media type Optional |
procurar [MediaType] |
A list of matches for the desired media type is presented to the user. |
Search [title] with season number Optional |
procurar [VideoName] temporada [SeasonNumber] |
All episodes for the matching season are presented to the user. |
Search [title] with episode number Optional |
procurar por [title] episódio [EpisodeNumber] |
A list of available episodes within the season the user recently watched appears. For example, if the user's viewing progress is within Season 2, a list of episodes from Season 2 appears. |
Search [title] with season and episode number Optional |
procurar por [VideoName]episódio [EpisodeNumber]procurar por [VideoName]temporada [SeasonNumber]procurar por [VideoNumber]temporada |
A list of available episodes for the season the user requested appears, including the episode the user specifically asked for. |
Search by character name Optional |
not supported |
The user is presented with a list of matching results for media featuring the character name. |
Search by director name Optional |
not supported |
The user is presented with a list of matching results for media produced by the requested director. |
Search by production company Optional |
Procurar/procura/procure por [ProductionCompany] |
The user is presented with a list of matching results for media from the production company. |
Search by sports team Optional |
procurar por[SportTeam] |
The user is presented with a list of matching results for the sports team. |
Search by sports type Optional |
procurar por [Sport] |
The user is presented with a list of matching results for the sports type (preferably based on recommendations for the user). |
Search by sports league Optional |
procurar por [League] |
The user is presented with a list of matching results for the sports league (preferably based on recommendations for the user). |
Search by sports event Optional |
procurar por [SportName] |
The user is presented with a list of matching results for the sports event (preferably based on recommendations for the user). |
Launch [partner] app Required for certification |
abrir [AppName] |
The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories. |
Launch special character title Required for certification |
abrir [special character AppName] |
The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories. |
Feature | Sample Utterances | Expected Response |
---|---|---|
Search for [title] Required for certification |
muestra juego de tronos enséña me el efecto mariposa |
A list of matches for the title is presented to the user. |
Search by actor Required for certification |
busca películas con antonio banderas |
A list of matches featuring the actor is presented to the user. |
Search by genre name Required for certification |
busca comedias románticas |
The user is presented with a list of matching results for media from the requested genre (personalized through an algorithm that selects recommended media for the user). |
Search by franchise [title] Required for certification |
busca shrek |
The user is presented with a list of matching results for the franchise. |
Search by media type Optional |
busca películas enséña me las películas busca películas en netflix |
A list of matches for the desired media type is presented to the user. |
Search [title] with season number Optional |
enséña me la segunda temporada de friends |
All episodes for the matching season are presented to the user. |
Search [title] with episode number Optional |
busca el capítulo final de los serrano* |
A list of available episodes within the season the user recently watched appears. For example, if the user's viewing progress is within Season 2, a list of episodes from Season 2 appears. |
Search [title] with season and episode number Optional |
busca el segundo episodio de la primera temporada de anabel* |
A list of available episodes for the season the user requested appears, including the episode the user specifically asked for. |
Search by character name Optional |
busca películas de la pantera negra |
The user is presented with a list of matching results for media featuring the character name. |
Search by director name Optional |
busca las películas de alejandro lozano |
The user is presented with a list of matching results for media produced by the requested director. |
Search by production company Optional |
busca películas de disney |
The user is presented with a list of matching results for media from the production company. |
Search by sports team Optional |
busca el partido del real madrid |
The user is presented with a list of matching results for the sports team. |
Search by sports type Optional |
enséña nos un vídeo de fútbol |
The user is presented with a list of matching results for the sports type (preferably based on recommendations for the user). |
Search by sports league Optional |
busca el partido de la n. b. a. |
The user is presented with a list of matching results for the sports league (preferably based on recommendations for the user). |
Search by sports event Optional |
busca el partido de fútbol |
The user is presented with a list of matching results for the sports event (preferably based on recommendations for the user). |
Launch [partner] app Required for certification |
lanza la app de netflix lanza netflix |
The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories. |
Launch special character title Required for certification |
lanza i. b. e. x. treinta y cinco |
The requested app launches and shows a list of available media to play. Multimodal devices have a homepage template that gets populated with media potentially grouped in different categories. |
SearchAndDisplayResults Directive Example
The following is an example SearchAndDisplayResults
directive. This is a directive Alexa might send in response to a user's request to search for "Alexa, show me UW Husky games."
EXTRA_DIRECTIVE_NAMESPACE: Alexa.RemoteVideoPlayer EXTRA_DIRECTIVE_NAME: SearchAndDisplayResults EXTRA_DIRECTIVE_PAYLOAD_VERSION: 3 EXTRA_DIRECTIVE_PAYLOAD: payload
payload
contains the following:
{
"payload": {
"experience": {
"mode": "VOICE_OPTIMIZED",
},
"entities": [
{
"externalIds": {
"key name": "event external id"
},
"type": "Event",
"uri": "entity://provider/event/games",
"value": "games"
},
{
"externaIds": {
"key name": "sports team id"
},
"type": "SportsTeam",
"uri": "entity://provider/sportsteam/someURI",
"value": "UW Huskies"
}
],
"searchText": [
{
"transcribed": "UW Huskies games"
}
],
"timeWindow": {
"end": "2016-09-07T23:59:00+00:00",
"start": "2016-09-01T00:00:00+00:00"
}
}
}
{
"directive": {
"endpoint": {
"cookie": {},
"endpointId": "<the identifier of the target endpoint>",
"scope": {
"token": "<an OAuth2 bearer token>",
"type": "BearerToken"
}
},
"header": {
"correlationToken": "dFMb0z+PgpgdDmluhJ1LddFvSqZ/jCc8ptlAKulUj90jSqg==",
"messageId": "5b77aa06-3bc6-4ab1-8e10-a7f41c208a0a",
"name": "SearchAndDisplayResults",
"namespace": "Alexa.RemoteVideoPlayer",
"payloadVersion": "3"
},
"payload": {
"experience": {
"mode": "VOICE_OPTIMIZED",
},
"entities": [
{
"externalIds": {
"key name": "event external id"
},
"type": "Event",
"uri": "entity://provider/event/games",
"value": "games"
},
{
"externaIds": {
"key name": "sports team id"
},
"type": "SportsTeam",
"uri": "entity://provider/sportsteam/someURI",
"value": "UW Huskies"
}
],
"searchText": [
{
"transcribed": "UW Huskies games"
}
],
"timeWindow": {
"end": "2016-09-07T23:59:00+00:00",
"start": "2016-09-01T00:00:00+00:00"
}
}
}
}
Payload Definitions
Field | Description | Data Type |
---|---|---|
entities optional |
An array of entity objects to play, such as a Title, Franchise, Actor, Team, or MediaType. See Entity Types for more details about entity types and values. | array |
experience optional |
An object that optimizes the display of search results. With the experience object, you can change the search results based on the device your customer used to search. See Experience Types for more details about the experience object and its values.
|
Object containing mode |
searchText optional |
Contains a transcribed version of the user's search query as a string value in the transcribed field. See Viewing the Customer's Actual Request for details.
|
Object containing transcribe |
transcribed optional |
Provides the transcribed version of the user's utterance. See The searchText Object for details.
Examples: |
String |
timeWindow optional |
Provides the time window for the content the customer wants to play. For example if a customer wants to play an episode from last week, time window would indicate the preceding week.
|
Object containing start and end times. |
end optional |
The end time of the time window. Examples: |
A string in ISO 8601 format. |
start optional |
The start time of the time window. Examples: |
A string in ISO 8601 format. |
Entity Types
The entities
object consists of a list of objects, each of which contains a type
and a value along with other possible data such as external IDs. The following values are possible for the type
value: Actor
, App
, Channel
, Character
, Director
, Episode
, Event
, Franchise
, Genre
, League
, MediaType
, ProductionCompany
, Season
, Sport
, SportsTeam
, Video
, Popularity
, Recency
, and VideoResolution
. Details about the payloads for each entity type are provided in the sections below.
Actor
Actor
represents an actor credited in video media content; for example, Casey Affleck might contain the following:
Actor Payload Fields | Description | Type | Example |
---|---|---|---|
externalIds |
A map of external identifiers for this entity. Key is the provider, value is the id. | Object | — |
└─ ASIN |
The external ASIN of this entity | String | B01LTHZVKG |
└─ imdb |
The IMDB identifier for the actor. | String | tt4034228 |
uri |
URI mapping to the actor/actress | URI | entity://provider/actor/caseyaffleck |
value |
The name of the actor | String | Casey Affleck |
App
App
represents the explicit app name specified by the user in utterance; for example, "Manchester by the Sea on Prime" might contain the following:
App Payload Fields | Description | Type | Example |
---|---|---|---|
externalIds |
A map of external identifiers for this entity. Key is the provider, value is the id. | Object | — |
└─ ENTITY_ID |
An application identifier from a list of apps. | String | amzn1.alexa-ask-target.app.72095 |
value |
The name of the application | String | Prime Video |
Channel
Channel
represents the identifying data for a television channel; for example, "PBS" might contain the following:
Channel Payload Fields | Description | Type | Example |
---|---|---|---|
externalIds |
A map of external identifiers for this entity. Key is the provider, value is the id. | Object | — |
└─ imdb |
The external IMDB identifier | String | tt4034228 |
entityMetadata |
A map of meta data associated with the channel | Object | — |
└─ channelNumber |
The channel number | Integer | 1234 |
└─ channelCallSign |
The call sign for the channel | String | KBTC |
uri |
The URI of the channel | URI | entity://provider/channel/1234 |
value |
The name of the channel | String | PBS |
Character
A Character
represented in video media content.
Character Payload Fields | Description | Type | Example |
---|---|---|---|
externalIds |
A map of external identifiers for this entity. Key is the provider, value is the id. | Object | — |
└─ ASIN |
The Amazon Standard Identification Number (ASIN) for this entity | String | B00DT55P3K |
└─ imdb |
The IMDB identifier for the character. | String | character id |
uri |
URI mapping to the character | URI | entity://provider/character/snowwhite |
value |
The name of the character | String | Snow White |
Director
Director
represents the director name for the video media content; for example, "Kenneth Lonergan" might contain the following:
Director Payload Fields | Description | Type | Example |
---|---|---|---|
externalIds |
A map of external identifiers for this entity. Key is the provider, value is the id. | Object | — |
└─ imdb |
The external IMDB identifier | String | tt4034228 |
uri |
URI mapping to the director | URI | entity://provider/director/kennethlonergan |
value |
The name of the director | String | Kenneth Lonergan |
Episode
Episode
represents the episode number for serial content like TV Shows; for example, the eighth episode of "Transparent" would have episode number 8.
Episode Payload Fields | Description | Type | Example |
---|---|---|---|
value |
The episode number | Integer | 8 |
Event
An Event
is a reference to a type of event; examples would include sports, music, or other types of events. For example, searching for "Football games" would search for a game
event entity and a football
sport entity.
Event Payload Fields | Description | Type | Example |
---|---|---|---|
externalIds |
A map of external identifiers for this entity. Key is the provider, value is the id. | Object | — |
└─ imdb |
The IMDB identifier for the event. | String | tt4034228 |
uri |
URI mapping to the event | URI | entity://amazon/events/games |
value |
The name of the event type | String | Games |
Franchise
A Franchise
is a video entity which can represent a number of video entities, like movies or TV shows. For example, take the fictional franchise "Intergalactic Wars" which represents a collection of movie trilogies, as well as animated and live action TV shows. This entity type was introduced to account for requests by customers such as "Find Intergalactic Wars movies", which would search for all "Intergalactic Wars" programs of the MOVIE
value for MediaType
, rather than attempting to match to a single title.
Franchise Payload Fields | Description | Type | Example |
---|---|---|---|
externalIds |
A map of external identifiers for this entity. Key is the provider, value is the id. | Object | — |
└─ imdb |
The external IMDB identifier | String | tt4034228 |
uri |
URI mapping to the franchise | URI mapping to the event | entity://amazon/franchise/intergalacticwars |
value |
The name of the genre | String | Intergalactic Wars |
Genre
Genre
represents the genre of video media content such as action, drama or comedy. For example, the Action
genre might contain the following:
Genre Payload Fields | Description | Type | Example |
---|---|---|---|
externalIds |
A map of external identifiers for this entity. Key is the provider, value is the id. | Object | — |
└─ imdb |
The external IMDB identifier | String | tt4034228 |
uri |
URI mapping to the genre | URI | entity://provider/genre/action |
value |
The name of the genre | String | Action |
League
League
represents the categorical information for a sporting league; for example, NCAA
is a league that might contain the following:
League Payload Fields | Description | Type | Example |
---|---|---|---|
externalIds |
A map of external identifiers for this entity. Key is the provider, value is the id. | Object | — |
└─ imdb |
The IMDB identifier for the league | String | tt4034228 |
uri |
URI mapping to the league | URI | entity://amazon/league/ncaa |
value |
The name of the league | String | NCAA |
MediaType
MediaType
represents the media type category of a particular piece of content; for example, the MediaType
for "Manchester by the Sea" would be MOVIE
.
MediaType Payload Fields | Description | Type | Example |
---|---|---|---|
value |
The media type; possible values are MOVIE , VIDEO , TV_SHOW |
Enum | MOVIE |
ProductionCompany
ProductionCompany
represents the production company name for the video media content; for example, Marvels, Disney.
ProductionCompany Payload Fields | Description | Type | Example |
---|---|---|---|
value |
Production company name | String | Marvel |
Season
Season
represents the season number for serial content like TV Shows; for example, the season two of "Transparent" would have season number 2.
Season Payload Fields | Description | Type | Example |
---|---|---|---|
value |
The season number | Integer | 2 |
Sport
Sport
represents the categorical information of a sport; for example, football is a sport that might contain the following:
Sport Payload Fields | Description | Type | Example |
---|---|---|---|
externalIds |
A map of external identifiers for this entity. Key is the provider, value is the id. | Object | — |
└─ imdb |
The IMDB identifier for the sport | String | tt4034228 |
uri |
URI mapping to the sports | URI | entity://amazon/sport/football |
value |
The name of the sport | String | Football |
SportsTeam
SportsTeam
represents the categorical information of a professional sports team; for example, "University of Washington Huskies" is a sports team that might contain the following:
SportsTeam Payload Fields | Description | Type | Example |
---|---|---|---|
externalIds |
A map of external identifiers for this entity. Key is the provider, value is the id. | Object | — |
└─ imdb |
The IMDB identifier for this team. | String | tt4034228 |
uri |
URI mapping to the sports team | URI | entity://amazon/sportsteam/huskies |
value |
The name of the sports team | String | University of Washington Huskies |
Video
Video
represents the identifying data for the piece of video content; for example, "Manchester by the Sea" might contain the following:
Video Payload Fields | Description | Type | Example |
---|---|---|---|
externalIds |
A map of external identifiers for this entity. Key is the provider, value is the id. | Object | — |
ASIN |
The external ASIN of this entity | String | B01LTHZVKG |
└─ imdb |
The IMDB identifier | String | tt4034228 |
userConfirmations |
Object containing information about user confirmations for the item | Object | |
└─ entitlementVoiceActivation |
Flag to inform partner if voice enablement of viewing period or entitlement is successful. Possible values - CONFIRMED (optional). |
Enum; Default policy - unrecognized values are ignored | CONFIRMED |
uri |
URI mapping to the video | URI | entity://provider/movie/manchesterbythesea |
value |
The name of the video | String | Manchester by the Sea |
Popularity
Popularity
indicates whether the user asks for popular content.
Popularity Payload Fields | Description | Type | Example |
---|---|---|---|
value |
Indicates to provider that the user searches for popular content | String | TRUE |
Recency
The resolved values for Recency
indicate whether the user asks for new or old content.
Recency Payload Fields | Description | Type | Example |
---|---|---|---|
value |
Indicates whether the user searches for new or old content; possible values are NEW , OLD |
Enum | NEW |
VideoResolution
VideoResolution
represents the requested video resolution in one of the following standards:
- SD (480p)
- HD (720p-1080p)
- 4k (2160p)
- 8k (4320p)
VideoResolution Payload Fields | Description | Type | Example |
---|---|---|---|
value |
Video resolution; possible values are SD , HD , 4k , 8k |
Enum | HD |
Experience Types
Use the experience
object to optimize the display of search results based on the device used to perform the search. For example, if a customers searches from a Fire TV remote, the experience
object shows a large number of search results that the customer can browse through with a remote. However, if the search request is from an Echo paired to Fire TV, the experience
object limits the number of results shown, and how they are displayed, allowing the customer to see results without using the remote.
The experience
object consists of a mode
object, which determines how to display the search results. The mode
object takes two values: VOICE_OPTIMIZED
and DEFAULT
.
-
VOICE_OPTIMIZED
: The optimized display of search results for voice-only devices. Provides a list of results that customers can navigate via voice, without the need for a remote. -
DEFAULT
: The default displays of all search results list format, regardless of the device used for the search.
To ensure forward compatibility, fallback to DEFAULT
instead of failing if you receive an unknown value in mode
.
Handling SearchAndDisplayResults Directives
SearchAndDisplayResults
directives contain instructions to search for media and then display the results of a search in a way that is appropriate for your application. The SearchAndDisplayResults
directive contains an array of entities that specifies what to search for.
(The SearchAndDisplayResults
directive is similar to GetDisplayableItems
in the video skills for multimodal implementations.)
The following sections provide guidance for handling SearchAndDisplayResults
directives for different types of requests.
Search by Title
Use the same logic as Watch by Title in SearchAndPlay
directives but show the user search results instead of going into playback.
Search by Title, Episode, and Season
Use the same logic as Watch by Title, Episode, and Season in SearchAndPlay
directives but show the user search results instead of going into playback.
Search by Franchise
Use the same logic as Watch by Franchise in SearchAndPlay
directives but show the user search results instead of going into playback.
Search by Genre, Sport, Team, League, and Other Ambiguous Search Directives
Use the same logic as Watch by Genre, Sport, Team, League, and Other Ambiguous Play Directives in SearchAndPlay
directives but show the user search results instead of going into playback.
Handling Ambiguous Requests
Use the same logic as Handling Ambiguous Play Requests in SearchAndPlay
directives but show the user search results instead of going into playback.
Artwork
In your list of results that you present to the user, include relevant artwork applicable to the titles. The artwork should make it easier for the user to identify the content you are recommending in the search.
Viewing the Customer's Actual Request
See Viewing the Customer's Actual Request for instructions and recommendations related to the searchText
object.
Response Example
If your app handled the directive successfully, your BroadcastReceiver class should send a success intent back with a success status, like this:
if (response != null && sendResponse) {
Intent success = new Intent().putExtra(VSKIntentConstants.EXTRA_DIRECTIVE_STATUS, didSucceed);
try {
response.send(context, 0, success);
} catch(PendingIntent.CanceledException e) {
//we probably took too long to respond, log error
}
}
For more details, see Step 7: Add a Broadcast Receiver. Also see the AlexaDirectiveReceiver
class in the sample app for a more specific code example.
When a SearchAndDisplayResults
directive successfully completes, your app or Lambda should respond with an Alexa.Response
message.
{
"context": {
"properties": []
},
"event": {
"header": {
"correlationToken": "dFMb0z+PgpgdDmluhJ1LddFvSqZ/jCc8ptlAKulUj90jSqg==",
"messageId": "1d8749ce-2805-4781-bb34-c5c59ce71f6a",
"name": "Response",
"namespace": "Alexa",
"payloadVersion": "3"
},
"payload": {}
}
}
No payload
content is required. With video skills on Fire TV apps, the response back to Alexa is minimal, with an empty payload
. This is because you sent the needed instruction to your Fire TV app through ADM.
If you cannot complete the customer request for some reason, reply with an error. See Error Handling for more details.
Declaring Capability Support for this Interface
To receive SearchAndDisplay
directives to your app from the RemoteVideoPlayer
interface, you must indicate support for this interface when you declare your capabilities. See the following for more information on declaring capabilities with app-only integrations:
To indicate that your video skill supports SearchAndDisplayResults
directives from the Alexa.RemoteVideoPlayer
interface, you must indicate support for it in your response to the Discover
directive sent through the Alexa.Discovery
interface. More details are provided in Alexa.Discovery
.
Last updated: Jun 09, 2021