唤醒词_v1.0

该接口用来管理设备端的唤醒词,只有设备接入的是讯飞唤醒模块时,才支持这个能力。

可以通过以下方式更新唤醒词:

  • 小飞在线app或者接入小飞在线SDK的定制应用中设置(即用户自定义)
  • ... ...

Capabilities API

要使用AudioActivityTracker接口,需要在设备能力上报接口中显示声明。

{
  "type": "iFLYOS.Interface",
  "interface": "iFLYTEK.WakeWord",
  "version": "1.0"
}

SetWakeWord 指令

当云端设置了唤醒词后,将会下发SetWakeWord指令,设备端应该根据云端返回的值,更新本地的唤醒资源。更新成功时,上报SetWakewordSucceeded事件;更新失败则上报SetWakewordFailed事件。

{
  "directive": {
    "header": {
      "namespace": "WakeWord",
      "name": "SetWakeWord",
      "messageId": "xxxx"
    },
    "payload": {
      "url": "https://wakeword.iflyos.cn/your_wakeword",
      "wakewordKey": "xxxx"
    }
  }
}

payload 参数

参数 说明 类型
url 唤醒词的资源链接 string
wakeWrodKey 唤醒词的唯一标识 string

SetWakeWordSucceeded 事件

设备端收到SetWakeWord指令,并下载替换唤醒词成功后,上报SetWakeWordSucceeded事件

{
  "event": {
    "header": {
      "namespace": "WakeWord",
      "name": "SetWakeWordSucceeded",
      "messageId": "xxxxx"
    },
    "payload": {
      "wakewordKey": "xxxx"
    }
  }
}

payload 参数

参数 说明 类型
wakeWordKey 唤醒词的唯一标识 string

SetWakewordFailed 事件

当设备端收到SetWakeWord指令时,在下载或者替换唤醒词资源失败,应该上报SetWakewordFailed事件

{
  "event": {
    "header": {
      "namespace": "WakeWord",
      "name": "SetWakeWordFailed",
      "messageId": "xxxx"
    },
    "payload": {
      "wakeWordKey": "xxxx",
      "error": "DOWNLOAD_ERROR"
    }
  }
}

payload 参数

参数 说明 类型
wakeWordKey 唤醒词的唯一标识 string
error 设置失败的原因:DOWNLOAD_ERRORCAE_ERROR string