Google Home デベロッパー センターにようこそ。スマートホーム アクションの開発方法を学ぶことができます。注: アクションの作成は、引き続き Actions Console で行います。
コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

スマートホームの 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
}

デバイスのステータス

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

状態 タイプ 説明
currentVolume Integer

必須。

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

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 Integer

必須。

新しいボリューム、0volumeMaxLevel

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

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

action.devices.commands.volumeRelative

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

パラメータ

パラメータ タイプ 説明
relativeSteps Integer

必須。

「減少」の場合は負の数になります。

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

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

デバイスエラー

エラーと例外の全リストをご覧ください。
  • volumeAlreadyMax: すでに最大音量になっている場合、デバイスは VolumeUp コマンドを受け取ります。
  • volumeAlreadyMin: すでに最小音量になっている場合、デバイスは VolumeDown コマンドを受け取ります。