Schema trattino del volume per la smart home

action.devices.traits.Volume: questa caratteristica appartiene ai dispositivi che possono regolare il volume, ad esempio impostando il volume su un determinato livello, disattivando l'audio o riattivando l'audio.

ATTRIBUTE del dispositivo

I dispositivi con questa caratteristica potrebbero segnalare i seguenti attributi come parte dell'operazione SYNC. Per scoprire di più sulla gestione degli intent SYNC, consulta Soddisfazione degli intent.

Attributi	Tipo	Descrizione
volumeMaxLevel	Intero	Obbligatorio. Il livello massimo del volume, ipotizzando un valore di riferimento pari a 0 (disattivazione audio). L'assistente regolerà i comandi pubblicitari in modo appropriato (ad esempio "Alza la TV un po' più forte").
volumeCanMuteAndUnmute	Booleano	Obbligatorio. Indica se il dispositivo può disattivare e riattivare l'audio del dispositivo. "Disattiva" è un'opzione separata poiché il comportamento "Disattiva" porta il volume a 0 mentre viene memorizzato il volume precedente, in modo che l'audio venga ripristinato. Ciò si riflette nello stato del volume: se il volume è 5 e l'utente disattiva l'audio, il volume rimane 5 e isMuted è vero.
volumeDefaultPercentage	Intero	(Valore predefinito: 40) Il volume (in percentuale) del volume predefinito definito dall'utente o dal produttore. La scala deve essere 0-100.
levelStepSize	Intero	(Valore predefinito: 1) La dimensione predefinita del passaggio per le query relative al volume relativo, ad esempio "Alza il volume su <nome_dispositivo>.
commandOnlyVolume	Booleano	(Valore predefinito: false) Indica se il dispositivo utilizza la comunicazione unidirezionale (vero) o bidirezionale (falso). Ad esempio, se il controller può confermare lo stato del nuovo dispositivo dopo aver inviato la richiesta, questo campo sarà falso. Se non è possibile verificare se la richiesta viene eseguita correttamente o conoscere lo stato del dispositivo (ad esempio, se il dispositivo è un telecomando a infrarossi tradizionale), imposta questo campo su true.

Esempi

Dispositivo con altoparlante che può essere disattivato e segnala lo stato attuale

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

STATEs dispositivo

Le entità con questa caratteristica possono segnalare i seguenti stati nell'ambito dell'operazione QUERY. Per scoprire di più sulla gestione degli intent QUERY, consulta Soddisfazione degli intent.

Stati	Tipo	Descrizione
currentVolume	Intero	Obbligatorio. La percentuale attuale del volume. Deve essere un valore compreso tra >0 e volumeMaxLevel.
isMuted	Booleano	Obbligatorio se l'attributo volumeCanMuteAndUnmute è impostato su true. Vero se l'audio del dispositivo è disattivato; altrimenti falso. Se isMuted è vero, il dispositivo restituisce comunque currentVolume per il punto memorizzato.

Esempi

Dispositivo con altoparlante che può essere disattivato e segnala lo stato attuale

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

comandi del dispositivo

I dispositivi con questa caratteristica possono rispondere ai seguenti comandi nell'ambito dell'operazione EXECUTE. Per scoprire di più sulla gestione degli intent EXECUTE, consulta Soddisfazione degli intent.

action.devices.commands.mute

Disattiva o riattiva l'audio del dispositivo.

Parametri

Parametri	Tipo	Descrizione
mute	Booleano	Obbligatorio. Consente di indicare se disattivare o riattivare l'audio di un dispositivo.

Esempi

Disattivare l'audio dello speaker

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

action.devices.commands.setVolume

Imposta il volume sul livello richiesto in base a volumeMaxLevel.

Parametri

Parametri	Tipo	Descrizione
volumeLevel	Intero	Obbligatorio. Nuovo volume, da 0 a volumeMaxLevel.

Esempi

Impostare il volume assoluto del dispositivo altoparlante

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

action.devices.commands.volumeRelative

Imposta il volume su n passi, in base a volumeMaxLevel. Per i comandi che utilizzano una bilancia relativa, l'assistente seleziona n in modo appropriato per scalare i passaggi disponibili. Ad esempio, l'impostazione Alza la TV molto più forte imposta un numero di passaggi superiore rispetto a Alza la TV un po' più forte.

Parametri

Parametri	Tipo	Descrizione
relativeSteps	Intero	Obbligatorio. negativo per "ridurre".

Esempi

Impostare il volume relativo del dispositivo altoparlante in modalità solo comando

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

ERRORI del dispositivo

Consulta l'elenco completo degli errori e delle eccezioni.

• volumeAlreadyMax: il dispositivo riceve il comando VolumeUp quando ha già raggiunto il volume massimo.
• volumeAlreadyMin: il dispositivo riceve il comando VolumeDown quando si trova già al volume più basso.