智能家居 Volume 特征架构
action.devices.traits.Volume
- 此特征属于能够调节音量(例如,将音量设为特定级别、静音或取消静音)的设备。
设备属性
具有此特征的设备可能会在 SYNC
操作过程中报告以下属性。如需详细了解如何处理 SYNC
intent,请参阅 intent 执行方式。
属性 | 类型 | 说明 |
---|---|---|
volumeMaxLevel |
整数 |
必填。 最大音量,假设基准值为 0(静音)。Google 助理会相应地调整副词指令(例如“把电视的音量调低一些”)。 |
volumeCanMuteAndUnmute |
Boolean |
必填。 指明设备是否可以静音和取消静音。静音是一个单独的选项,因为“静音”行为会在记住之前音量的同时将音量变为 0,这样取消静音可恢复音量。这反映在音量状态下:如果音量为 5,且用户静音,则音量保持为 5,并且 |
volumeDefaultPercentage |
整数 |
(默认值: 用户或制造商定义的默认音量的音量(以百分比表示)。范围必须为 0-100。 |
levelStepSize |
整数 |
(默认值: 相对音量查询(例如“<device_name>上的音量调高”)的默认步长。 |
commandOnlyVolume |
Boolean |
(默认值: 指示设备是采用单向 (true) 还是双向 (false) 通信来运行。例如,如果控制器可以在发送请求后确认新设备状态,则此字段为 false。如果无法确认请求是否成功执行或无法获取设备的状态(例如,如果设备是传统的红外遥控器),请将此字段设为 true。 |
示例
可设为静音并报告当前状态的扬声器设备
{ "volumeMaxLevel": 11, "volumeCanMuteAndUnmute": true, "levelStepSize": 2, "commandOnlyVolume": false, "volumeDefaultPercentage": 6 }
设备状态
具有此特征的实体可能会在 QUERY
操作过程中报告以下状态。如需详细了解如何处理 QUERY
intent,请参阅 intent 执行方式。
州 | 类型 | 说明 |
---|---|---|
currentVolume |
整数 |
必填。 当前音量百分比。该值必须介于 |
isMuted |
Boolean |
如果 |
示例
可设为静音并报告当前状态的扬声器设备
{ "currentVolume": 5, "isMuted": false }
设备命令
具有此特征的设备可能会在 EXECUTE
操作过程中响应以下命令。如需详细了解如何处理 EXECUTE
intent,请参阅 intent 执行方式。
action.devices.commands.mute
将设备静音或取消静音。
参数
参数 | 类型 | 说明 |
---|---|---|
mute |
Boolean |
必填。 是将设备静音还是取消静音。 |
示例
将扬声器设备设为静音
{ "command": "action.devices.commands.mute", "params": { "mute": true } }
action.devices.commands.setVolume
根据 volumeMaxLevel
将音量设置为所请求的音量。
参数
参数 | 类型 | 说明 |
---|---|---|
volumeLevel |
整数 |
必填。 新卷,从“ |
示例
设置扬声器设备的绝对音量
{ "command": "action.devices.commands.setVolume", "params": { "volumeLevel": 6 } }
action.devices.commands.volumeRelative
根据 volumeMaxLevel
设置音量调高或调低 n 步。对于使用相对比例的指令,Google 助理会相应地选择 n 来根据可用的步数进行缩放。例如,选择调高电视的音量所设置的步数比调大一点电视的步数。
参数
参数 | 类型 | 说明 |
---|---|---|
relativeSteps |
整数 |
必填。 为负数。 |
示例
在“仅限命令”模式下设置音响设备的相对音量
{ "command": "action.devices.commands.volumeRelative", "params": { "relativeSteps": -1 } }
设备出错
查看错误和异常的完整列表。volumeAlreadyMax
:当设备已调到最高音量时,会收到VolumeUp
命令。volumeAlreadyMin
:当设备已调至最低音量时,会收到VolumeDown
命令。