Schemat cechy głośności inteligentnego domu

action.devices.traits.Volume – ta cecha należy do urządzeń, które mogą zmieniać głośność (np. ustawiać ją na określony poziom, wyciszać lub wyłączać wyciszenie).

ATRYBUTY urządzenia

Urządzenia z tą cechą mogą zgłaszać te atrybuty w ramach operacji SYNC. Więcej informacji o obsłudze intencji SYNC znajdziesz w artykule Realizacja intencji.

Atrybuty Typ Opis
volumeMaxLevel Liczba całkowita

Wymagane.

Maksymalny poziom głośności, przy założeniu, że poziom bazowy to 0 (wyciszenie). Asystent odpowiednio dostosuje polecenia przysłówkowe (np. „zwiększ trochę głośność telewizora”).
volumeCanMuteAndUnmute Wartość logiczna

Wymagane.

Wskazuje, czy urządzenie może wyciszać i wyłączać wyciszenie. Wyciszenie to osobna opcja, ponieważ wyciszenie ustawia głośność na 0, ale zapamiętuje poprzednią głośność, aby można było ją przywrócić po wyłączeniu wyciszenia. Odzwierciedla to stan głośności – jeśli głośność wynosi 5, a użytkownik wyciszy dźwięk, głośność pozostanie na poziomie 5, a wartość isMuted będzie mieć ustawienie „true” (prawda).
volumeDefaultPercentage Liczba całkowita

(Domyślnie: 40)

Głośność (w procentach) domyślnej głośności zdefiniowanej przez użytkownika lub producenta. Skala musi wynosić 0–100.

Wartość musi znajdować się w zakresie od 0 do 100.
levelStepSize Liczba całkowita

(Domyślnie: 1)

Domyślny rozmiar kroku w przypadku zapytań dotyczących względnej głośności, np. „zwiększ głośność na urządzeniu <device_name>”.
commandOnlyVolume Wartość logiczna

(Domyślnie: false)

Wskazuje, czy urządzenie działa w trybie komunikacji jednokierunkowej (wartość „true”) czy dwukierunkowej (wartość „false”). Jeśli np. kontroler może potwierdzić nowy stan urządzenia po wysłaniu żądania, to pole będzie miało wartość „false”. Jeśli nie można potwierdzić, czy żądanie zostało wykonane, lub uzyskać stanu urządzenia (np. jeśli jest to tradycyjny pilot na podczerwień), ustaw to pole na wartość „true”.

Przykłady

Głośnik, który można wyciszyć i który raportuje bieżący stan

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

Stany urządzenia

Podmioty z tą cechą mogą zgłaszać te stany w ramach operacji QUERY. Więcej informacji o obsłudze intencji QUERY znajdziesz w artykule Realizacja intencji.

Stany Typ Opis
currentVolume Liczba całkowita

Wymagane.

Obecny procent głośności. Musi mieścić się w przedziale od >0 do volumeMaxLevel.

Wartość minimalna: 0.
isMuted Wartość logiczna

Wymagane, jeśli atrybut volumeCanMuteAndUnmute ma wartość „true”. Wartość true, jeśli urządzenie jest wyciszone. W przeciwnym razie wartość false. Jeśli isMuted ma wartość prawda, urządzenie nadal zwraca currentVolume dla zapamiętanego punktu.

Przykłady

Głośnik, który można wyciszyć i który raportuje bieżący stan

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

Polecenia dotyczące urządzenia

Urządzenia z tą cechą mogą odpowiadać na te polecenia w ramach operacji EXECUTE. Więcej informacji o obsłudze intencji EXECUTE znajdziesz w artykule Realizacja intencji.

action.devices.commands.mute

Wycisza lub włącza urządzenie.

Parametry

Parametry Typ Opis
mute Wartość logiczna

Wymagane.

wyciszanie lub włączanie dźwięku na urządzeniu;

Przykłady

Wyciszanie głośnika

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

action.devices.commands.setVolume

Ustaw głośność na żądany poziom na podstawie volumeMaxLevel.

Parametry

Parametry Typ Opis
volumeLevel Liczba całkowita

Wymagane.

Nowa głośność: od 0 do volumeMaxLevel.

Wartość minimalna: 0.

Przykłady

Ustawianie bezwzględnej głośności głośnika

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

action.devices.commands.volumeRelative

Zwiększ lub zmniejsz głośność o n kroków na podstawie volumeMaxLevel. W przypadku poleceń, które korzystają ze skali względnej, Asystent wybierze odpowiednią wartość n, aby dopasować ją do dostępnych kroków. Na przykład polecenie Zwiększ głośność telewizora spowoduje ustawienie większej liczby kroków niż Zwiększ głośność telewizora o niewielką wartość.

Parametry

Parametry Typ Opis
relativeSteps Liczba całkowita

Wymagane.

ujemna w przypadku „spadku”.

Przykłady

Ustawianie względnej głośności urządzenia głośnikowego w trybie tylko poleceń

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

BŁĘDY urządzenia

Zobacz pełną listę błędów i wyjątków.
  • volumeAlreadyMax: urządzenie otrzymuje polecenie VolumeUp, gdy jest już ustawione na najwyższy poziom głośności.
  • volumeAlreadyMin: urządzenie otrzymuje polecenie VolumeDown, gdy ma już ustawioną minimalną głośność.