スマートホームの Volume トレイトのスキーマ

action.devices.traits.Volume - このトレイトは、音量を変更できるデバイス（音量を特定レベルに設定する、ミュートする、ミュート解除するなど）に属します。

デバイスの属性

このトレイトを持つデバイスは、次の 属性をSYNCオペレーションの一部として報告できます。SYNC インテントの処理について詳しくは、インテントのフルフィルメントをご覧ください。

属性 タイプ 説明
volumeMaxLevel 整数

必須。

ベースラインを 0（ミュート）とした場合の最大音量レベル。アシスタントはそれに応じて、副詞コマンド（「テレビをもう少し大きくして」など）を調整します。
volumeCanMuteAndUnmute ブール値

必須。

デバイスが音量をミュートおよびミュート解除できるかどうかを示します。ミュートは別のオプションです。ミュート動作では、音量が 0 になり、以前の音量が記憶されるため、ミュート解除すると元に戻ります。これは音量の状態に反映されます。音量が 5 でユーザーがミュートした場合、音量は 5 のままで、isMuted が true になります。
volumeDefaultPercentage 整数

（デフォルト: 40）

ユーザーまたはメーカーが定義したデフォルトの音量（パーセンテージ）。スケールは 0 ～ 100 にする必要があります。

値は 0～100 の範囲で指定してください
levelStepSize 整数

（デフォルト: 1）

「<device_name> の音量を上げて」のような相対的な音量のクエリのためのデフォルトのステップサイズ。
commandOnlyVolume ブール値

（デフォルト: false）

デバイスが一方向（true）通信と双方向（false）通信のどちらを使用しているかを示します。たとえば、リクエストの送信後にコントローラが新しいデバイスの状態を確認できる場合、このフィールドは false になります。リクエストが正常に実行されたかどうかを確認できない場合、またはデバイスの状態を取得できない場合（デバイスが従来の赤外線リモコンの場合など）は、このフィールドを true に設定します。

例

ミュート可能で現在の状態を報告するスピーカー デバイス 

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

デバイスのステータス

このトレイトを持つエンティティは、次の ステータスを QUERY オペレーションの一部として報告できます。`QUERY` インテントの処理について詳しくは、インテントのフルフィルメントをご覧ください。

州 タイプ 説明
currentVolume 整数

必須。

現在の音量のパーセンテージ。>0～volumeMaxLevel の範囲で指定してください。

最小値: 0。
isMuted ブール値

volumeCanMuteAndUnmute 属性が true に設定されている場合は必須。デバイスがミュートされている場合は true。そうでない場合は false。isMuted が true の場合でも、デバイスは記憶されたポイントの currentVolume を返します。

例

ミュート可能で現在の状態を報告するスピーカー デバイス 

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

デバイスのコマンド

このトレイトを持つデバイスは、次の コマンドにEXECUTE オペレーションの一部として応答できます。EXECUTE インテントの処理について詳しくは、インテントのフルフィルメントをご覧ください。

action.devices.commands.mute

デバイスをミュートまたはミュート解除します。

パラメータ

パラメータ タイプ 説明
mute ブール値

必須。

デバイスをミュートするかミュート解除するかを指定します。

例

スピーカー デバイスをミュートする 

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

action.devices.commands.setVolume

volumeMaxLevel に基づいて、音量を要求されたレベルに設定します。

パラメータ

パラメータ タイプ 説明
volumeLevel 整数

必須。

0～volumeMaxLevel の範囲の新しい音量。

最小値: 0。

例

スピーカー デバイスの絶対音量を設定する 

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

action.devices.commands.volumeRelative

volumeMaxLevel に基づいて、音量を n ステップ上げるか、または下げます。相対スケールを使用するコマンドの場合、アシスタントは利用可能なステップに合わせてスケールを調整するために、適切な n を選択します。たとえば、テレビをもっと大きくしては、テレビをほんの少し大きくしてよりも多くのステップを設定します。

パラメータ

パラメータ タイプ 説明
relativeSteps 整数

必須。

「下げる」の場合は負の値。

例

コマンド専用モードでスピーカー デバイスの相対音量を設定する 

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

デバイスエラー

エラーと例外の全リストをご覧ください。 .
  • volumeAlreadyMax: デバイスがすでに最大音量になっているときに VolumeUp コマンドを受信しました。
  • volumeAlreadyMin: デバイスがすでに最小音量になっているときに VolumeDown コマンドを受信しました。