Esquema de traços de volume de casas inteligentes

action.devices.traits.Volume: essa característica pertence a dispositivos que podem mudar o volume (por exemplo, definir o volume para um determinado nível, desativar ou ativar o som).

ATRIBUTOS DO dispositivo

Dispositivos com essa característica podem relatar o seguinte atributos como parte da operação SYNC. Para saber mais sobre como lidar com intents SYNC, consulte Fulfillment da intent.

Atributos Tipo Descrição
volumeMaxLevel Número inteiro

Obrigatório.

O nível de volume máximo, supondo um valor de referência de 0 (silenciado). O Google Assistente vai ajustar os comandos adverbiais, por exemplo, "Aumentar o volume da TV".

volumeCanMuteAndUnmute Booleano

Obrigatório.

Indica se o dispositivo pode desativar e ativar o volume. "Desativar som" é uma opção separada. leva o volume para 0 enquanto memoriza o volume anterior. Assim, ativar o som o restaura. Isso é refletido no estado do volume: se o volume for 5 e o usuário desativar o som, o volume permanecerá 5 e isMuted será verdadeiro.

volumeDefaultPercentage Número inteiro

Padrão: 40.

O volume (em porcentagem) do volume padrão definido pelo usuário ou fabricante. A escala precisa ser de 0 a 100.

levelStepSize Número inteiro

Padrão: 1.

A taxa de aprendizado padrão para consultas de volume relativo, como "aumentar volume no <device_name>".

commandOnlyVolume Booleano

Padrão: false.

Indica se o dispositivo funciona usando comunicação unidirecional (verdadeiro) ou bidirecional (falso). Por exemplo, se o controlador puder confirmar o novo estado do dispositivo depois de enviar a solicitação, esse campo será "false". Se não for possível confirmar se a solicitação foi executada ou saber o estado do dispositivo (por exemplo, se o dispositivo for um controle remoto infravermelho tradicional), defina esse campo como "true".

Exemplos

Alto-falante que pode ser silenciado e informa o estado atual

{
  "volumeMaxLevel": 11,
  "volumeCanMuteAndUnmute": true,
  "levelStepSize": 2,
  "commandOnlyVolume": false,
  "volumeDefaultPercentage": 6
}

STATES do dispositivo

Entidades com essa característica podem relatar o seguinte como parte da operação QUERY. Para saber mais sobre como lidar com intents QUERY, consulte Fulfillment da intent.

Estados Tipo Descrição
currentVolume Número inteiro

Obrigatório.

A porcentagem do volume atual. Precisa estar entre >0 e volumeMaxLevel.

isMuted Booleano

Obrigatório se o atributo volumeCanMuteAndUnmute estiver definido como verdadeiro. Verdadeiro se o som do dispositivo estiver desativado. falso, do contrário. Se isMuted for verdadeiro, o dispositivo ainda retornará currentVolume para o ponto memorizado.

Exemplos

Alto-falante que pode ser silenciado e informa o estado atual

{
  "currentVolume": 5,
  "isMuted": false
}

COMANDOS DO dispositivo

Dispositivos com essa característica podem responder ao seguinte como parte da operação EXECUTE. Para saber mais sobre como lidar com intents EXECUTE, consulte Fulfillment da intent.

action.devices.commands.mute

Desativa ou ativa o som do dispositivo.

Parâmetros

Parâmetros Tipo Descrição
mute Booleano

Obrigatório.

Se o som de um dispositivo deve ser desativado ou ativado.

Exemplos

Desativar som do alto-falante

{
  "command": "action.devices.commands.mute",
  "params": {
    "mute": true
  }
}

action.devices.commands.setVolume

Definir o volume para o nível solicitado, com base em volumeMaxLevel.

Parâmetros

Parâmetros Tipo Descrição
volumeLevel Número inteiro

Obrigatório.

Novo volume, de 0 a volumeMaxLevel.

Exemplos

Definir o volume absoluto do alto-falante

{
  "command": "action.devices.commands.setVolume",
  "params": {
    "volumeLevel": 6
  }
}

action.devices.commands.volumeRelative

Definir volume para cima ou para baixo em n etapas, com base em volumeMaxLevel. No caso de comandos que usam uma escala relativa, o Assistente seleciona n corretamente para dimensionar as etapas disponíveis. Por exemplo, Aumentar muito o volume da TV definirá um número de etapas maior do que Aumentar o volume da TV um pouco mais.

Parâmetros

Parâmetros Tipo Descrição
relativeSteps Número inteiro

Obrigatório.

um negativo para "diminuir".

Exemplos

Definir o volume relativo do alto-falante no modo somente comando

{
  "command": "action.devices.commands.volumeRelative",
  "params": {
    "relativeSteps": -1
  }
}

ERROS no dispositivo

Veja a lista completa de erros e exceções.
  • volumeAlreadyMax: o dispositivo recebe o comando VolumeUp quando é já está no volume máximo.
  • volumeAlreadyMin: o dispositivo recebe o comando VolumeDown quando é o volume já está no mínimo.