Esquema de características de volume de casa inteligente

action.devices.traits.Volume: essa característica pertence a dispositivos que podem mudar o volume, como ativar ou desativar o som.

ATRIBUTOS DO DISPOSITIVO

Dispositivos com essa característica podem informar os seguintes atributos como parte da operação SYNC. Para saber mais sobre como processar intents SYNC, consulte fulfillment de 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 (desativar som). O Google Assistente vai ajustar os comandos adverbiais (por exemplo, "Aumentar o volume da TV").
volumeCanMuteAndUnmute	Booleano	Obrigatório. Indica se o dispositivo pode ativar e desativar o som do volume. A desativação do som é uma opção separada, já que o comportamento "Desativar som" leva o volume para 0 ao lembrar do volume anterior. Assim, a reativação do som o restaura. Isso é refletido no estado de volume: se o volume for 5 e o usuário desativar o som, o volume permanecerá 5 e o isMuted será verdadeiro.
volumeDefaultPercentage	Número inteiro	Padrão: 40. O volume (em porcentagem) para o volume padrão definido pelo usuário ou fabricante. A escala precisa ser de 0 a 100.
levelStepSize	Número inteiro	Padrão: 1. O tamanho padrão das etapas para consultas de volume relativo, como "aumentar volume em <device_name>".
commandOnlyVolume	Booleano	Padrão: false. Indica se o dispositivo funciona usando a comunicação unidirecional (verdadeiro) ou bidirecional (falso). Por exemplo, se o controlador puder confirmar o novo estado do dispositivo após o envio da solicitação, esse campo será falso. Se não for possível confirmar se a solicitação foi executada ou se o estado do dispositivo (por exemplo, se o dispositivo é um controle remoto infravermelho tradicional), defina esse campo como "true".

Exemplos

Dispositivo com alto-falante que pode ser silenciado e que informa o estado atual

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

STATES do dispositivo

Dispositivos com essa característica podem informar os estados a seguir como parte da operação QUERY. Para saber mais sobre como processar intents QUERY, consulte fulfillment de intent.

Estados	Tipo	Descrição
currentVolume	Número inteiro	Obrigatório. A porcentagem do volume atual. O valor 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. Caso contrário, será falso. Se isMuted for verdadeiro, o dispositivo ainda retornará currentVolume para o ponto lembrado.

Exemplos

Dispositivo com alto-falante que pode ser silenciado e que informa o estado atual

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

Comandos do dispositivo

Dispositivos com essa característica podem responder aos seguintes comandos como parte da operação EXECUTE. Para saber mais sobre como processar intents EXECUTE, consulte fulfillment de intent.

action.devices.commands.mute

Ativa ou desativa o som do dispositivo.

Parâmetros

Parâmetros	Tipo	Descrição
mute	Booleano	Obrigatório. Ativar ou desativar o som de um dispositivo.

Exemplos

Desativar o som do alto-falante

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

action.devices.commands.setVolume

Defina o volume no 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

Aumentar ou diminuir o volume em n passos, com base em volumeMaxLevel. Para comandos que usam uma escala relativa, o Assistente selecionará n corretamente para escalonar com as etapas disponíveis. Por exemplo, Aumentar o volume da TV definirá um número maior de etapas do que Aumentar o volume da TV.

Parâmetros

Parâmetros	Tipo	Descrição
relativeSteps	Número inteiro	Obrigatório. negativo para "diminuir".

Exemplos

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

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

Dispositivo ERRORS

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 já está no volume mais baixo.