扬声器_v1.0

扬声器接口包含调整音量、设置/取消静音的指令和事件。

SetVolume 指令

设备端接收该指令后,应该按要求将设备音量设为一个最大音量的一定百分比。

消息样式

{
  "directive": {
    "header": {
      "namespace": "Speaker",
      "name": "SetVolume",
      "messageId": "e52e7a4c...",
      "dialogRequestId": "49687be..."
    },
    "payload": {
      "volume": 78
    }
  }
}

Header参数

参数名 说明 类型
messageId 代表一条message的唯一ID String
dialogRequestId 客户端必须为recognize请求创建的唯一ID,此参数用于关联响应特定Recognize事件发送的指令 String

Payload参数

参数名 说明 类型 必须出现
volume 将要设置的音量的绝对数值百分比
取值: 0到100之间
Long

AdjustVolume 指令

设备端接收该指令后,应该按要求将设备音量做一个最大音量的-100%到100%之间的相对调整。

消息样式

{
  "directive": {
    "header": {
      "namespace": "Speaker",
      "name": "AdjustVolume",
      "messageId": "e52e7a4c...",
      "dialogRequestId": "49687be..."
    },
    "payload": {
      "volume": 10
    }
  }
}

Header参数

参数名 说明 类型
messageId 代表一条message的唯一ID String
dialogRequestId 客户端必须为recognize请求创建的唯一ID,此参数用于关联响应特定Recognize事件发送的指令 String

Payload参数

参数名 说明 类型 必须出现
volume 将要设置的音量的相对数值,在当前音量的基础上增大或减小
取值: -100到100之间
Long

VolumeChanged 事件

以下情况设备端必须上报该事件至服务端:

  • 收到SetVolumeAdjustVolume指令并在设备端完成了音量的设置/调整。
  • 设备本地通过按键完成了音量的调整。

注意

volume必须是0到100之间的值。若本地的音量是0到10,则上传至服务端时需要换算成0-100的数值。

消息样式

{
  "event": {
    "header": {
      "namespace": "Speaker",
      "name": "VolumeChanged",
      "messageId": "e52e7a4c..."
    },
    "payload": {
      "volume": 10,
      "muted": false
    }
  }
}

Header参数

参数名 说明 类型
messageId 代表一条message的唯一ID String

Payload参数

参数名 说明 类型 必须出现
volume 设备音量的绝对数值。
取值: 0到100之间
Long
mute 静音的布尔值,静音取值TRUE,取消静音取值FALSE Boolean

SetMute 指令

设备端接收该指令后,应该按要求将设备设为静音/非静音

消息样式

{
  "directive": {
    "header": {
      "namespace": "Speaker",
      "name": "SetMute",
      "messageId": "e52e7a4c...",
      "dialogRequestId": "49687be..."
    },
    "payload": {
      "mute": false
    }
  }
}

Header参数

参数名 说明 类型
messageId 代表一条message的唯一ID String
dialogRequestId 客户端必须为recognize请求创建的唯一ID,此参数用于关联响应特定Recognize事件发送的指令 String

Payload参数

参数名 说明 类型 必须出现
mute 静音的布尔值,静音取值TRUE,取消静音取值FALSE Boolean

MuteChanged 事件

以下情况设备端必须上报该事件至服务端:

  • 收到SetMute指令并在设备端完成了静音/非静音的设置。
  • 设备本地通过按键完成了静音/非静音的设置。

消息样式

{
  "event": {
    "header": {
      "namespace": "Speaker",
      "name": "MuteChanged",
      "messageId": "e52e7a4c..."
    },
    "payload": {
      "volume": 78,
      "muted": false
    }
  }
}

Header参数

参数名 说明 类型
messageId 代表一条message的唯一ID String

Payload参数

参数名 说明 类型 必须出现
volume 设备音量的绝对数值。
取值: 0到100之间
Long
mute 静音的布尔值,静音取值TRUE,取消静音取值FALSE Boolean