Alexa.KeypadController接口 (VSK Fire TV)
当用户请求选择或滚动浏览屏幕上的元素时，Alexa.KeypadController接口会向您的应用或Lambda发送带有keystroke值（例如，UP、DOWN）的SendKeystroke指令。
KeypadController与内置滚动和选择功能
Fire TV已经提供了应用内语音滚动和选择作为内置功能，大多数应用（无论是否集成了VSK）都可以在Fire TV上免费获得。借助此内置功能，当用户说出滚动命令时（例如，“Alexa, scroll right” [Alexa，向右滚动] 或“Alexa, select this” [Alexa，选择此项]），Fire TV会尝试猜测它应该滚动多长距离。
应用内语音滚动和选择的工作方式是将方向键导航事件映射到您的语音命令。方向键是指遥控器的方向键盘（“选择”按钮周围的“导航”环），用于向右、向左、向上和向下滚动。Alexa将这些语音命令转换为发送到应用的方向键导航事件。
KeypadController提供类似的功能，但可让您控制滚动和选择。如果您为应用声明KeypadController功能，则内置的语音滚动和选择将处于非活动状态，KeypadController优先级更高。您将直接在您的应用或Lambda中收到滚动和选择指令，并且您可以履行请求。但是，通常没有充分的理由在Fire TV已经提供的内置功能上实现KeypadController。
SendKeystroke指令的表述
用户可以说出与以下内容相关的表述：
- 沿方向键方向移动
- 选择有焦点的元素
- 滚动浏览元素，例如列表、菜单项、标题和描述等
- 显示当前在屏幕外的信息
当用户说出以下表述时，Alexa会向您的应用（用于仅限应用的集成）或您的Lambda（用于云端集成）发送SendKeystroke指令。
| 功能 | 表述示例 | 预期回应 |
|---|---|---|
| 定向导航 - 跳转 需要认证 |
Go up go down go left go right |
应用向左、向右、向上或向下跳转，和按下方向键控制器上的方向相似。 |
| 定向导航 - 移动 需要认证 |
Move up move down move left move right |
应用向左、向右、向上或向下移动，和按下方向键控制器上的方向相似。 |
| 定向滚动 需要认证 |
Scroll up scroll down scroll left scroll right |
应用向左、向右、向上或向下滚动，和按下方向键控制器上的方向相似。 |
| 定向分页 需要认证 |
Page up page down page left page right |
应用向左、向右、向上或向下分页，和按下方向键控制器上的方向相似。 |
| 无动词定向导航 需要认证 |
Up Down Left Right |
应用向左、向右、向上或向下切换，和按下方向键控制器上的方向相似。 |
| 选择此项（该项） 需要认证 |
Select this |
选中聚焦的任何内容。 |
| 显示/查看更多 可选 |
Show more |
显示更多项目。例如，如果列表仅显示有限数量的项目，则将检索并显示更多项目。 |
| 显示/查看详情（信息） 可选 |
Show details |
显示了更多详情。例如，如果信息被截断，则会显示更多信息。 |
| 功能 | 表述示例 | 预期回应 |
|---|---|---|
| 定向导航 - 跳转 需要认证 |
va vers le haut monte vers le haut remonte va en bas descends faire défiler vers le bas va à gauche aller à gauche va à droite aller à droite |
应用向左、向右、向上或向下跳转，和按下方向键控制器上的方向相似。 |
| 定向导航 - 移动 需要认证 |
va vers le haut monte vers le haut remonte navigue en bas navigue vers le bas Naviguer à gauche Naviguer vers la gauche Naviguer à droite Naviguer vers la droite |
应用向左、向右、向上或向下移动，和按下方向键控制器上的方向相似。 |
| 定向滚动 需要认证 |
fais défiler vers le haut fais défiler en haut faire défiler vers le bas défiler vers le bas se déplacer vers le bas fais défiler à gauche faire défiler à gauche défiler à gauche se déplacer à droite fais défiler à droite faire défiler à droite défiler à droite se déplacer à droite |
应用向左、向右、向上或向下滚动，和按下方向键控制器上的方向相似。 |
| 定向分页 需要认证 |
page vers le haut Page vers le bas Page vers la gauche Page vers la droite |
应用向左、向右、向上或向下分页，和按下方向键控制器上的方向相似。 |
| 无动词定向导航 需要认证 |
va en haut monte faire défiler vers le haut va en bas descends faire défiler vers le bas fais défiler à gauche va à gauche faire défiler à gauche se déplacer à gauche aller à gauche défiler à gauche fais défiler à droite va vers la droite fais défiler vers la droite déplace-toi vers la droite aller à droite défile à droite |
应用向左、向右、向上或向下切换，和按下方向键控制器上的方向相似。 |
| 选择此项（该项） 需要认证 |
sélectionne ça choisis ça |
选中聚焦的任何内容。 |
| 显示/查看更多 可选 |
montre moi en plus montre en plus encore |
显示更多项目。例如，如果列表仅显示有限数量的项目，则将检索并显示更多项目。 |
| 显示/查看详情（信息） 可选 |
montre des détails montre moi des détails voir plus d'infos |
显示了更多详情。例如，如果信息被截断，则会显示更多信息。 |
| 功能 | 表述示例 | 预期回应 |
|---|---|---|
| 定向导航 - 跳转 需要认证 |
va vers le haut monte vers le haut remonte va en bas descends faire défiler vers le bas va à gauche aller à gauche va à droite aller à droite |
应用向左、向右、向上或向下跳转，和按下方向键控制器上的方向相似。 |
| 定向导航 - 移动 需要认证 |
va vers le haut monte vers le haut remonte navigue en bas navigue vers le bas Naviguer à gauche Naviguer vers la gauche Naviguer à droite Naviguer vers la droite |
应用向左、向右、向上或向下移动，和按下方向键控制器上的方向相似。 |
| 定向滚动 需要认证 |
fais défiler vers le haut fais défiler en haut faire défiler vers le bas défiler vers le bas se déplacer vers le bas fais défiler à gauche faire défiler à gauche défiler à gauche se déplacer à droite fais défiler à droite faire défiler à droite défiler à droite se déplacer à droite |
应用向左、向右、向上或向下滚动，和按下方向键控制器上的方向相似。 |
| 定向分页 需要认证 |
page vers le haut Page vers le bas Page vers la gauche Page vers la droite |
应用向左、向右、向上或向下分页，和按下方向键控制器上的方向相似。 |
| 无动词定向导航 需要认证 |
va en haut monte faire défiler vers le haut va en bas descends faire défiler vers le bas fais défiler à gauche va à gauche faire défiler à gauche se déplacer à gauche aller à gauche défiler à gauche fais défiler à droite va vers la droite fais défiler vers la droite déplace-toi vers la droite aller à droite défile à droite |
应用向左、向右、向上或向下切换，和按下方向键控制器上的方向相似。 |
| 选择此项（该项） 需要认证 |
sélectionne ça choisis ça |
选中聚焦的任何内容。 |
| 显示/查看更多 可选 |
montre moi en plus montre en plus encore |
显示更多项目。例如，如果列表仅显示有限数量的项目，则将检索并显示更多项目。 |
| 显示/查看详情（信息） 可选 |
montre des détails montre moi des détails voir plus d'infos |
显示了更多详情。例如，如果信息被截断，则会显示更多信息。 |
| 功能 | 表述示例 | 预期回应 |
|---|---|---|
| 定向导航 - 跳转 需要认证 |
geh/e nach oben nach oben/rauf/hinauf/hoch gehen gehe hoch geh rauf/hinauf nach unten/runter/hinunter gehen geh runter/nach unten/hinunter geh nach links geh nach rechts |
应用向左、向右、向上或向下跳转，和按下方向键控制器上的方向相似。 |
| 定向导航 - 移动 需要认证 |
nach oben bewegen nach unten bewegen nach links bewegen nach rechts bewegen |
应用向左、向右、向上或向下移动，和按下方向键控制器上的方向相似。 |
| 定向滚动 需要认证 |
scroll hoch scroll nach oben scroll rauf scrolle hinauf scrolle hoch scroll hier/dahin/dorthin runter scroll zum letzten runter scroll runter/hinunter/nach unten runter/hinunter/nach unten scrollen scroll nach links scroll links scroll nach rechts scroll rechts |
应用向左、向右、向上或向下滚动，和按下方向键控制器上的方向相似。 |
| 定向分页 需要认证 |
seite nach oben seite rauf seite hinauf seite hoch blätter hoch blätter runter seite runter/hinunter/nach unten blätter links seite nach links seite links blätter rechts seite nach rechts seite rechts |
应用向左、向右、向上或向下分页，和按下方向键控制器上的方向相似。 |
| 无动词定向导航 需要认证 |
nach oben bewegen bätter hoch geh hoch scroll hoch scroll nach oben nach unten bewegen blätter runter scroll hier/dahin/dorthin runter geh runter/nach unten scroll hinunter/nach unten runter/hinunter gehen seite runter/hinunter/nach unten nach links bewegen blätter links seite nach? links scroll nach? links geh nach links nach rechts bewegen blätter rechts seite nach? rechts scroll nach? rechts geh nach rechts |
应用向左、向右、向上或向下切换，和按下方向键控制器上的方向相似。 |
| 选择此项（该项） 需要认证 |
nimm das wähl das aus? klick die an diese |
选中聚焦的任何内容。 |
| 显示/查看更多 可选 |
mehr ansehen/sehen zeig mir mehr zeig mir mehr davon zeig mir mehr auf [AppName] zeig mir mehr filme an? |
显示更多项目。例如，如果列表仅显示有限数量的项目，则将检索并显示更多项目。 |
| 显示/查看详情（信息） 可选 |
details ansehen/sehen zeig details an liefere/gib mir mehr details mehr details |
显示了更多详情。例如，如果信息被截断，则会显示更多信息。 |
| 功能 | 表述示例 | 预期回应 |
|---|---|---|
| 定向导航 - 跳转 需要认证 |
ऊपर जाओ ऊपर करो नीचे जाओ * नीचे जाना * *ambiguity with "move down" left जाना * बाएं जाओ * left पे जाओ * *ambiguity with "move left" right जाना right पे जाओ दायें जाओ *ambiguity with "move right" |
应用向左、向右、向上或向下跳转，和按下方向键控制器上的方向相似。 |
| 定向导航 - 移动 需要认证 |
ऊपर जाओ ऊपर करो नीचे जाओ * नीचे जाना * *ambiguity with "move down" left जाना * बाएं जाओ * left पे जाओ * *ambiguity with "move left" right जाना right पे जाओ दायें जाओ *ambiguity with "move right" |
应用向左、向右、向上或向下移动，和按下方向键控制器上的方向相似。 |
| 定向滚动 需要认证 |
उपर चलो ऊपर scroll ऊपर करो नीचे scroll करें नीचे की तरफ scroll करो scroll down करो left scroll करो left की तरफ scroll करो बायें की तरफ scroll करो right scroll करो right की तरफ scroll करो दाएँ की तरफ scroll करो |
应用向左、向右、向上或向下滚动，和按下方向键控制器上的方向相似。 |
| 定向分页 需要认证 |
पेज ऊपर करो पेज नीचे करो पेज को left पे ले जाओ पेज को right पे ले जाओ पेज को बाएँ ले जाओ पेज को दाएँ ले जाओ page नीचे करो page down करो page को बाएँ कर दो page left करो page को दाएँ करो page right करो |
应用向左、向右、向上或向下分页，和按下方向键控制器上的方向相似。 |
| 无动词定向导航 需要认证 |
ऊपर ऊपर जाओ उपर चलो ऊपर करो नीचे नीचे जाओ नीचे चलो नीचे करो left बाएँ जाओ बाएँ बाएँ करो Right दाएँ जाओ दाएँ दाएँ करो |
应用向左、向右、向上或向下切换，和按下方向键控制器上的方向相似。 |
| 选择此项（该项） 需要认证 |
इसे चुनो इसको select करो |
选中聚焦的任何内容。 |
| 显示/查看更多 可选 |
और दिखाओ |
显示更多项目。例如，如果列表仅显示有限数量的项目，则将检索并显示更多项目。 |
| 显示/查看详情（信息） 可选 |
details दिखाओ जानकारी दिखाओ |
显示了更多详情。例如，如果信息被截断，则会显示更多信息。 |
| 功能 | 表述示例 | 预期回应 |
|---|---|---|
| 定向导航 - 跳转 需要认证 |
vai su Vai giù / scendi voglio andare verso sinistra voglio andare verso destra |
应用向左、向右、向上或向下跳转，和按下方向键控制器上的方向相似。 |
| 定向导航 - 移动 需要认证 |
salta su Passa giù /passa in giù/salta giù / scendi/ salta verso il basso voglio andare verso sinistra voglio andare verso destra |
应用向左、向右、向上或向下移动，和按下方向键控制器上的方向相似。 |
| 定向滚动 需要认证 |
scorri verso l'alto scorri giù / scorri verso il basso /scrolla giù scorri verso sinistra scorri verso destra |
应用向左、向右、向上或向下滚动，和按下方向键控制器上的方向相似。 |
| 定向分页 需要认证 |
pagina in su pagina di sotto pagina sinistra/pagina di sinistra pagina destra/pagina di destra |
应用向左、向右、向上或向下分页，和按下方向键控制器上的方向相似。 |
| 无动词定向导航 需要认证 |
su giù verso sinistra verso destra |
应用向左、向右、向上或向下切换，和按下方向键控制器上的方向相似。 |
| 选择此项（该项） 需要认证 |
seleziona questo scegli questo |
选中聚焦的任何内容。 |
| 显示/查看更多 可选 |
mostra mi di più |
显示更多项目。例如，如果列表仅显示有限数量的项目，则将检索并显示更多项目。 |
| 显示/查看详情（信息） 可选 |
fornisci dettagli mostra più dettagli mostra i dettagli |
显示了更多详情。例如，如果信息被截断，则会显示更多信息。 |
| 功能 | 表述示例 | 预期回应 |
|---|---|---|
| 定向导航 - 跳转 需要认证 |
上に行って 下に行って 左側に行って 右の方へ行って |
应用向左、向右、向上或向下跳转，和按下方向键控制器上的方向相似。 |
| 定向导航 - 移动 需要认证 |
上に移動して 下の方へ移動して 左の方へ移動して 右側に移動して |
应用向左、向右、向上或向下移动，和按下方向键控制器上的方向相似。 |
| 定向滚动 需要认证 |
上にスクロールして 下にスクロールして 左の方にスクロールして 右側へスクロールして |
应用向左、向右、向上或向下滚动，和按下方向键控制器上的方向相似。 |
| 定向分页 需要认证 |
画面の上部へ ページの下へ 画面の左へ ページの右の方へ |
应用向左、向右、向上或向下分页，和按下方向键控制器上的方向相似。 |
| 无动词定向导航 需要认证 |
上* 下 左* 右* |
应用向左、向右、向上或向下切换，和按下方向键控制器上的方向相似。 |
| 选择此项（该项） 需要认证 |
これ選んで |
选中聚焦的任何内容。 |
| 显示/查看更多 可选 |
もっと見せて |
显示更多项目。例如，如果列表仅显示有限数量的项目，则将检索并显示更多项目。 |
| 显示/查看详情（信息） 可选 |
詳細を表示して |
显示了更多详情。例如，如果信息被截断，则会显示更多信息。 |
| 功能 | 表述示例 | 预期回应 |
|---|---|---|
| 定向导航 - 跳转 需要认证 |
Subir/suba/sobe Vá/vai/ir para baixo Vá/vai/ir para esquerda Vá/vai/ir para direita |
应用向左、向右、向上或向下跳转，和按下方向键控制器上的方向相似。 |
| 定向导航 - 移动 需要认证 |
Mover/mova/move pra cima Mova/move/mover para baixo Mova/move/mover para a esquerda Mova/move/mover para direita |
应用向左、向右、向上或向下移动，和按下方向键控制器上的方向相似。 |
| 定向滚动 需要认证 |
Rolar/rola/role para cima Rola/role/rolar para baixo Rola/role/rolar para a esquerda Rola/role/rolar para a direita |
应用向左、向右、向上或向下滚动，和按下方向键控制器上的方向相似。 |
| 定向分页 需要认证 |
página para cima/ ir para cima na página Página para baixo Pagina para esquerda Página para direita |
应用向左、向右、向上或向下分页，和按下方向键控制器上的方向相似。 |
| 无动词定向导航 需要认证 |
Ir/vai/vá pra cima Ir/vai/vá pra baixo Ir/vai/vá pra esquerda Ir/vai/vá pra direita |
应用向左、向右、向上或向下切换，和按下方向键控制器上的方向相似。 |
| 选择此项（该项） 需要认证 |
escolher isso/esse/essa selecionar isso/essa/ esse esse aqui / esse/ essa aqui/ essa/ isso aqui/ isso |
选中聚焦的任何内容。 |
| 显示/查看更多 可选 |
Mostrar/mostra/mostre mais |
显示更多项目。例如，如果列表仅显示有限数量的项目，则将检索并显示更多项目。 |
| 显示/查看详情（信息） 可选 |
ver todos os detalhes do progama/show |
显示了更多详情。例如，如果信息被截断，则会显示更多信息。 |
| 功能 | 表述示例 | 预期回应 |
|---|---|---|
| 定向导航 - 跳转 需要认证 |
ve te arriba ve te abajo ve te a la izquierda ve a la izquierda ve te a la derecha ve a la derecha |
应用向左、向右、向上或向下跳转，和按下方向键控制器上的方向相似。 |
| 定向导航 - 移动 需要认证 |
muéve te hacia arriba muéve te hacia abajo muéve te hacia izquierda muéve te hacia derecha |
应用向左、向右、向上或向下移动，和按下方向键控制器上的方向相似。 |
| 定向滚动 需要认证 |
despláza te hacia arriba despláza te para arriba despláza te hacia abajo despláza te para abajo despláza te hacia izquierda despláza te para izquierda despláza te hacia derecha despláza te para derecha |
应用向左、向右、向上或向下滚动，和按下方向键控制器上的方向相似。 |
| 定向分页 需要认证 |
arriba de la página abajo de la página izquierda de la página derecha de la página |
应用向左、向右、向上或向下分页，和按下方向键控制器上的方向相似。 |
| 无动词定向导航 需要认证 |
ve te arriba ve te abajo izquierda ve te a la derecha ve a la derecha |
应用向左、向右、向上或向下切换，和按下方向键控制器上的方向相似。 |
| 选择此项（该项） 需要认证 |
selecciona esto selecciona este selecciona aquel |
选中聚焦的任何内容。 |
| 显示/查看更多 可选 |
muestra más muestra qué más hay quiero ver algo más veamos un poco más veamos algo más |
显示更多项目。例如，如果列表仅显示有限数量的项目，则将检索并显示更多项目。 |
| 显示/查看详情（信息） 可选 |
muestra detalles enseña detalles ver detalles |
显示了更多详情。例如，如果信息被截断，则会显示更多信息。 |
SendKeystroke指令示例
以下是KeypadController接口发送的KeyStroke指令示例：
EXTRA_DIRECTIVE_NAMESPACE: Alexa.KeypadController
EXTRA_DIRECTIVE_NAME: KeyStroke
EXTRA_DIRECTIVE_PAYLOAD_VERSION: 3
EXTRA_DIRECTIVE_PAYLOAD: payload
payload包含以下内容：
{
"payload": {
"keystroke": "SELECT"
}
}
{
"directive": {
"header": {
"namespace": "Alexa.KeypadController",
"name": "SendKeystroke",
"messageId": "<message id>",
"correlationToken": "<an opaque correlation token>",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "<an OAuth2 bearer token>"
},
"endpointId": "<endpoint id>",
"cookie": {}
},
"payload": {
"keystroke": "SELECT"
}
}
}
有效负载描述
SendKeystroke指令使用payload中的keystroke属性来指定应采取的操作。
| 字段 | 描述 | 类型 |
|---|---|---|
keystroke |
用户请求的击键。 | 字符串 |
可能的keystroke值包括： UP、DOWN、LEFT、RIGHT、SELECT、PAGE_UP、PAGE_DOWN、PAGE_LEFT、PAGE_RIGHT、INFO、MORE。下表描述了这些值。
| 击键类型 | 击键值 | 描述 |
|---|---|---|
| 方向键 | UP, DOWN, LEFT, RIGHT, SELECT |
向上、向下、向左或向右移动一个单位，或移动至屏幕上的下一个元素，或选择具有焦点的元素或项目。 |
| 滚动 | PAGE_UP, PAGE_DOWN, PAGE_LEFT, PAGE_RIGHT |
按指定方向滚动。 |
| 信息 | INFO, MORE |
显示有关当前具有焦点的屏幕元素的更多信息。例如，显示屏幕外的内容或跳转到详情页面。 |
响应示例
如果您成功处理了SendKeystroke指令，则使用Alexa.Response事件进行响应。您可以同步或异步响应。如果进行异步响应，请纳入关联令牌和带有授权令牌的作用域。
SendKeystroke响应事件示例
{
"event": {
"header": {
"namespace": "Alexa",
"name": "Response",
"messageId": "<message id>",
"correlationToken": "<an opaque correlation token>",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "<an OAuth2 bearer token>"
},
"endpointId": "<endpoint id>"
},
"payload": {}
}
}
如果您由于某种原因无法完成客户请求，可以用错误来回应。有关更多详细信息，请参阅错误处理。
声明此接口的功能支持
要在应用中接收KeypadController指令，必须在声明功能时表示支持此接口。有关通过仅限应用的集成声明功能的更多信息，请参阅以下内容：
要指明您的视频技能支持Alexa.KeypadController接口，您必须在响应通过Alexa.Discovery接口发送的Discover指令时指明支持该接口。请参阅声明KeypadController接口的功能。请务必纳入keys属性并列出您支持的击键。此外请注意，KeypadController需要Alexa客户端库版本1.4.5或更高版本。Alexa.Discovery中提供了更多详细信息。
Last updated: 2020年10月30日