このページは Cloud Translation API によって翻訳されました。

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

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

デバイスの属性

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

属性	タイプ	説明
`volumeMaxLevel`	Integer	必須。ベースラインを 0（ミュート）と仮定した場合の最大音量レベル。アシスタントは、副詞コマンドを調整します（例: 「テレビの音を大きくして」）。
`volumeCanMuteAndUnmute`	ブール値	必須。デバイスが音量をミュートおよびミュート解除できるかどうかを示します。ミュートは別のオプションです。「ミュート」動作では前の音量が記憶され、音量が 0 になるため、ミュート解除すると復元されます。これは音量状態に反映されます。音量が 5 でユーザーがミュートしても、音量は 5 のままで、`isMuted` は true です。
`volumeDefaultPercentage`	Integer	（デフォルト: `40`）ユーザーまたはメーカーによって定義されたデフォルトのボリュームの量（パーセント単位）。スケールは 0～100 にする必要があります。
`levelStepSize`	Integer	（デフォルト: `1`）相対ボリュームのクエリのデフォルトのステップサイズ。例: 「<デバイス名> の音量を上げて」。
`commandOnlyVolume`	ブール値	（デフォルト: `false`）デバイスが一方向（True）または双方向（False）の通信を使用して動作していることを示します。たとえば、コントローラがリクエストの送信後に新しいデバイスの状態を確認できた場合、このフィールドは false になります。リクエストが正常に実行されたかどうか確認できない、またはデバイスの状態を取得できる（デバイスが従来の赤外線リモコンであるなど）場合は、このフィールドを true に設定します。

例

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

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

デバイスのステータス

注: 状態は、属性 commandOnlyVolume が false の場合にのみ関連します。

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

状態タイプ説明

状態	タイプ	説明
`currentVolume`	Integer	必須。現在の音量のパーセンテージ。`>0`～`volumeMaxLevel` の範囲で指定してください。
`isMuted`	ブール値	`volumeCanMuteAndUnmute` 属性が true に設定されている場合は必須です。デバイスがミュートされている場合は true。そうでない場合は false。`isMuted` が true の場合、デバイスは保存されたポイントの `currentVolume` を返します。

currentVolume

Integer

必須。

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

isMuted

ブール値

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

例

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

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

デバイスのコマンド

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

`action.devices.commands.mute`

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

パラメータ

パラメータタイプ説明

パラメータ	タイプ	説明
`mute`	ブール値	必須。デバイスをミュートするかミュート解除するかを指定します。

mute

ブール値

必須。

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

例

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

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

`action.devices.commands.setVolume`

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

パラメータ

パラメータタイプ説明

パラメータ	タイプ	説明
`volumeLevel`	Integer	必須。新しいボリューム: `0`～`volumeMaxLevel`。

volumeLevel

Integer

必須。

新しいボリューム: 0～volumeMaxLevel。

例

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

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

`action.devices.commands.volumeRelative`

volumeMaxLevel に基づいて、音量を n ステップ上げるか、または下げます。相対スケールを使用するコマンドの場合、アシスタントは適切なステップにスケーリングするために n を適切に選択します。たとえば、「テレビを大きくして」では、テレビの音を大きくするよりも多くの手順をセットアップできます。

パラメータ

パラメータタイプ説明

パラメータ	タイプ	説明
`relativeSteps`	Integer	必須。「decrease」が負の値

relativeSteps

Integer

必須。

「decrease」が負の値

例

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

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

デバイスエラー

エラーと例外のリストをご覧ください。

volumeAlreadyMax: デバイスはすでに最大音量になっているときに、VolumeUp コマンドを受け取ります。
volumeAlreadyMin: デバイスはすでに音量が最小のときに VolumeDown コマンドを受け取ります。