Esquema de traço de volume da casa inteligente

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, 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 máximo de volume, considerando um valor padrão de 0 (silenciar). O Google Assistente ajustará os comandos adverbiais (por exemplo, "aumente um pouco o volume da TV") de acordo com isso.
volumeCanMuteAndUnmute Booleano

Obrigatório.

Indica se o dispositivo pode ativar e desativar o som. O mudo é uma opção separada, já que o comportamento "mudo" leva o volume a 0, mas se lembra do volume anterior para que o som seja restaurado. Isso se reflete no estado do volume. Se o volume for 5 e o usuário silenciar, o volume vai 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.

O valor precisa estar entre 0 e 100.
levelStepSize Número inteiro

Padrão: 1.

O tamanho da etapa padrão para consultas de volume relativo, como "aumentar o volume no <device_name>".
commandOnlyVolume Booleano

Padrão: false.

Indica se o dispositivo opera usando comunicação unidirecional (true) ou bidirecional (false). Por exemplo, se o controlador puder confirmar o novo estado do dispositivo após o envio da solicitação, esse campo será "false". Se não for possível confirmar se a solicitação foi executada ou receber o estado do dispositivo (por exemplo, se o dispositivo for um controle remoto infravermelho tradicional), defina esse campo como "true".

Exemplos

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

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

ESTADOS DO DISPOSITIVO

Entidades com essa característica podem informar os seguintes estados como parte da operação QUERY. Para saber mais sobre como processar intents QUERY, consulte Execução de intents.

Estados Tipo Descrição
currentVolume Número inteiro

Obrigatório.

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

Valor mínimo: 0.
isMuted Booleano

Obrigatório se o atributo volumeCanMuteAndUnmute estiver definido como "true". Verdadeiro se o dispositivo estiver no modo silencioso. Caso contrário, será falso. Se isMuted for verdadeiro, o dispositivo ainda vai retornar currentVolume para o ponto lembrado.

Exemplos

Dispositivo de 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 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.

Se um dispositivo deve ser silenciado ou não.

Exemplos

Desativar o som do dispositivo de 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 para volumeMaxLevel.

Valor mínimo: 0.

Exemplos

Definir o volume absoluto do dispositivo de alto-falante

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

action.devices.commands.volumeRelative

Aumente ou diminua o volume n etapas, com base em volumeMaxLevel. Para comandos que usam uma escala relativa, o Google Assistente seleciona n de acordo com as etapas disponíveis. Por exemplo, Aumente muito o volume da TV vai definir um número maior de etapas do que Aumente um pouco o volume da TV.

Parâmetros

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

Obrigatório.

negativa para "diminuir".

Exemplos

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

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

ERROS do dispositivo

Confira 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 mínimo.