Developer Console
Merci de votre visite. Cette page est disponible en anglais uniquement.

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

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 Complete
Search for <title>
Required for certification

Search for breaking bad

such nach? <VideoName> such/zeig/find film? <VideoName> auf <AppName>

zeig mir film? <VideoName> auf <DeviceBrand>

such trailer von <VideoName>

trouve / cherche / montre <VideoName> sur <AppName>

trouve / cherche / montre <VideoName> sur <AppName>

trova / cerca / mostra / dammi + VideoName (+ da/su ServiceName)?

muestra juego de tronos

enséña me el efecto mariposa

<VideoName>を探して<VideoName>を<AppName>で探して

procurar/buscar/mostrar <VideoName> no/na <AppName>

 

<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

Search for sean connery

such <ActorNameName> filme

zeig filme mit <ActorNameName>

cherche des films avec <ActorName>

recherche des films avec <ActorName>

cherche des films avec <ActorName>

cerca film con <ActorName>

trova un film con <ActorName>

busca películas con antonio banderas

<ActorNameName>が出ている<MediaType>を探して

procurar por <ActorName>

<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

Search for comedy

zeig <GenreNameName> filme auf <AppName>

such nach <GenreName> <MediaType>

cherche une comédie

recherche un/une <GenreName>

cherche un/une <GenreName>

cerca <GenreName>

trova <GenreName>

busca comedias románticas

<GenreNameName>の<MediaType>を見つけて

procurar por <GenreName>

<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

Search for star trek

such nach? <VideoName> such/zeig/find film? <VideoName> auf <AppName>

zeig mir film? <VideoName> auf <DeviceBrand>

such trailer von <VideoName>

cherche star trek

recherche <VideoName>

cherche <VideoName>

cerca <VideoName>

trova <VideoName>

busca shrek

procurar<VideoName>

start trek के लिए ढूँढ़ो/ढूँढ़ना/खोजो/खोजना/search करना

The user is presented with a list of matching results for the franchise.

 

Search by media type
Optional

Search movies

find <MediaType>

such/zeig/empfiehl <MediaType>

Cherche <mediatype>

recherche <mediatype>

cherche <mediatype>

cerca <mediatype>

trova mi un <mediatye>

busca películas

enséña me las películas

busca películas en netflix

<MediaType>を探して

<AppName>で<MediaType>を探して

<ChannelName>を検索

procurar <MediaType>

<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

Search breaking bad season two

spiel <VideoName> <Season> <Season_Numer>

spiel <VideoName>

<Season> <Season_Numer> auf <AppName>

cherche la saison <number> de <title>

recherche la saison <number> de <title>

cherche la saison <number> de <title>

cerca la stagione due di <VideoName>

trova la stagione due di <VideoName>

enséña me la segunda temporada de friends

procurar <VideoName> temporada <SeasonNumber>

breaking bad season दो ढूँढ़ो/ढूँढ़ना/खोजो/खोजना/search करना

All episodes for the matching season are presented to the user.

 

Search <title> with episode number
Optional

Search for breaking bad episode five

spiel die <Episode_Number> <Episode> von <VideoName>

spiel <VideoName> <Episode_Number>

spiel von <VideoName> <Episode> <Episode_Number>

cherche l'épisode <number> de <title>

recherche la saison <number> de <title>

cherche la saison <number> de <title>

cerca <VideoName> Episodio cinque

trova <VideoName> Episodio cinque

busca el capítulo final de los serrano*

procurar por <title> episódio <EpisodeNumber>

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

Search for breaking bad season two episode five

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

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>

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>

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>

busca el segundo episodio de la primera temporada de anabel*

<title> シーズン<SeasonNumber> エピソード<EpisodeNumber> を探して

procurar por <VideoName>episódio <EpisodeNumber>procurar por

<VideoName>temporada <SeasonNumber>procurar por <VideoNumber>temporada

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

Search for james bond

Not supported

cherche un film avec <charactername>

recherche un film avec <charactername>

cherche un film avec <charactername>

cerca un film con <CharacterName>

trova un film con <CharacterName>

busca películas de la pantera negra

<CharacterNameName>が主人公の<MediaType>を探して

not supported

<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

Search for quentin tarantino

such nach <MediaType> mit <ActorName>

such <ActorName> <MediaType>

zeig <MediaType> mit <ActorName>

cherche un film de quentin tarantino

recherche un film de <DirectorName>

cherche un film de <DirectorName>

cerca <DirectorName>

busca las películas de alejandro lozano

not supported

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

Search for disney

suche nach <ProductionCompany> filmenzeige mir <ProductionCompany> filme

cherche des films de disney

recherche des films de disney

cherche des films de disney

cerca disney

busca películas de disney

<ProductionCompany>を検索

Procurar/procura/procure por <ProductionCompany>

disney के लिए ढूँढ़ो/ढूँढ़ना/खोजो/खोजना/search करना

The user is presented with a list of matching results for media from the production company.

 

Search by sports team
Optional

Search seahawks

Not supported

Not supported

not supported

busca el partido del real madrid

<Sport>の<Event>を見つけて<SportTeam>の<Event>を見つけて

procurar por<SportTeam>

<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

Search for soccer

such <Sport> <Event>

find <Sport> <Event>

Not supported

Not supported

cerca <Sport>

trova <Sport>

enséña nos un vídeo de fútbol

<Sport>の<Event>を見つけて<SportTeam>の<Event>を見つけて

procurar por <Sport>

<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

Search for n. b. a. league

Not supported

cherche <league>

recherche <league>

cherche <league>

not supported

busca el partido de la

n. b. a.

<Sport>の<Event>を見つけて<SportTeam>の<Event>を見つけて

procurar por <League>

<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

Search for soccer game

such <Sport> <Event>

find <Sport> <Event>

Not supported

Not supported

cerca partite di <SportName>

trova partite di calcio

busca el partido de fútbol

<Sport>の<Event>を見つけて<SportTeam>の<Event>を見つけて

procurar por <SportName>

<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

Launch netflix app

starte <AppName>

spiel/öffne <AppName> app

starte <AppName> auf <DeviceBrand>

lance <AppName>

pars <AppName>

lancia <AppName>

apri <AppName>

lanza la app de netflix

lanza netflix

abrir <AppName>

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

Launch a. t. and t. u-verse app

starte <AppName>

spiel/öffne <AppName> app

starte AppName auf <DeviceBrand>

lance <AppName>

pars <AppName>

apri <special character AppName>

lanza i. b. e. x. treinta y cinco

abrir <special character AppName>

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.

 

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": {
        "entities": [
            {
                "externalIds": {
                    "gracenote": 100
                },
                "type": "Event",
                "uri": "entity://provider/event/games",
                "value": "games"
            },
            {
                "externaIds": {
                    "gracenote": "ST0000000666661"
                },
                "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": {
            "entities": [
                {
                    "externalIds": {
                        "gracenote": 100
                    },
                    "type": "Event",
                    "uri": "entity://provider/event/games",
                    "value": "games"
                },
                {
                    "externaIds": {
                        "gracenote": "ST0000000666661"
                    },
                    "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

The following fields are supported.
Field Description Data Type
entities
An array of entity objects to play, such as a Title, Franchise, Actor, Team, or MediaType. See Entity Types for Video Content for more details about entity types and values. array
displayMode
Identifies if the request is a far field (VUI) or a near field request (GUI). enum values "VUI" or "GUI"
timeWindow
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

The end time of the time window.

Examples: 2016-09-07T23:59:00+00:00, 2018-01-24T02:30:00Z

A string in ISO 8601 format.
start

The start time of the time window.

Examples: 2016-09-07T23:59:00+00:00, 2018-01-24T02:30:00Z

A string in ISO 8601 format.
searchText
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
Provides the transcribed version of the user's utterance. See The searchText Object for details.

Examples: h.d. popular comedy tv shows

string

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 Watch 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: