Esquema do traço de volume da casa inteligente

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

ATRIBUTOS do dispositivo

Dispositivos com essa característica podem informar os seguintes atributos como parte da operação SYNC. Para saber mais sobre o gerenciamento de intents SYNC, consulte fulfillment de intents.

Atributos Tipo Descrição
volumeMaxLevel Número inteiro

Obrigatório.

O nível de volume máximo, presumindo um valor de referência de 0 (mudo). O Google Assistente ajustará os comandos adverbiais (por exemplo, "deixar a TV um pouco mais alta") conforme necessário.

volumeCanMuteAndUnmute Booleano

Obrigatório.

Indica se o dispositivo pode ativar e desativar o som. Essa opção é separada, já que essa opção muda o volume para 0 sem perder o volume anterior. Dessa forma, ele é restaurado. Isso é refletido no estado de volume: se o volume for 5 e o usuário desativar o som, ele permanecerá como 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 em <device_name>".

commandOnlyVolume Booleano

Padrão: false.

Indica se o dispositivo opera usando comunicação unidirecional (verdadeiro) ou bidirecional (falso). Por exemplo, se o controlador puder confirmar o novo estado do dispositivo após enviar a solicitação, esse campo será falso. Se não for possível confirmar se a solicitação foi executada com êxito ou obter o estado do dispositivo (por exemplo, se o dispositivo for um controle remoto infravermelho tradicional), defina esse campo como verdadeiro.

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 informar os seguintes estados como parte da operação QUERY. Para saber mais sobre o gerenciamento de intents QUERY, consulte fulfillment de intents.

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 dispositivo estiver silenciado. Caso contrário, será falso. Se isMuted for verdadeira, o dispositivo ainda vai 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 aos seguintes comandos como parte da operação EXECUTE. Para saber mais sobre o gerenciamento de intents EXECUTE, consulte fulfillment de intents.

action.devices.commands.mute

Desativa ou ativa 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 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

Aumentar ou diminuir o volume em n etapas, com base em volumeMaxLevel. Para comandos que usam uma escala relativa, o Assistente selecionará n da forma apropriada para dimensioná-lo de acordo com os passos disponíveis. Por exemplo, Aumentar o volume da TV definirá um número de passos maior 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
  }
}

ERROS DO Dispositivo

Veja a lista completa de erros e exceções.
  • volumeAlreadyMax: o dispositivo recebe o comando VolumeUp quando já está no volume mais alto.
  • volumeAlreadyMin: o dispositivo recebe o comando VolumeDown quando já está no volume mais baixo.