Speakerインターフェース(v1.0)

Speakerインターフェースは、クライアントのスピーカーの音量調整とミュート/ミュート解除に使用されるディレクティブとイベントを提供します。Alexaは音量調整にSetVolumeディレクティブとAdjustVolumeディレクティブによる、2つの方法がサポートされています。

機能API

Speakerインターフェースのバージョン1.0を使用するには、機能APIの呼び出し内で宣言する必要があります。詳細については、機能APIを参照してください。

オブジェクトのサンプル

{
    "type": "AlexaInterface",
    "interface": "Speaker",
    "version": "1.0"
}

Speakerのコンテキスト

Alexaは、コンテキストが必要な各イベントで、Speakerインターフェースのvolume状態とmuted状態の情報がクライアントからレポートされることを想定しています。

コンテキストのレポートの詳細については、コンテキストの概要を参照してください。

サンプルメッセージ

{
    "header": {
        "namespace": "Speaker",
        "name": "VolumeState"
    },
    "payload": {
        "volume": {{LONG}},
        "muted": {{BOOLEAN}}
    }
}

ペイロードのパラメーター

パラメーター 説明
volume 現在のスピーカーの音量を示します。
有効な値:0~100
long
muted クライアントのスピーカーのミュート状態を示します。 ブール値

SetVolumeディレクティブ

このディレクティブは、クライアントに絶対値で音量調整するよう指示します。volumeの値は、0(最小)以上、100(最大)以下の値で指定されます。

サンプルメッセージ


{
    "directive": {
        "header": {
            "namespace": "Speaker",
            "name": "SetVolume",
            "messageId": "{{STRING}}",
            "dialogRequestId": "{{STRING}}"
        },
        "payload": {
            "volume": {{LONG}}
        }
    }
}

ヘッダーのパラメーター

パラメーター 説明
messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列
dialogRequestId 特定のRecognizeイベントの応答として送信されるディレクティブの関連付けに使用する一意のID 文字列

ペイロードのパラメーター

パラメーター 説明
volume 0(最小)から100(最大)までの絶対音量レベル。
有効な値:0以上100以下の任意の値。
long

AdjustVolumeディレクティブ

このディレクティブは、クライアントに相対値で音量調整するよう指示します。volumeの値は、-100以上、100以下の値で指定されます。

AdjustVolumeディレクティブは、現在の音量設定に対して常に相対的であり、音量を上げるには正の値、音量を下げるには負の値が指定されます。

サンプルメッセージ

{
    "directive": {
        "header": {
            "namespace": "Speaker",
            "name": "AdjustVolume",
            "messageId": "{{STRING}}",
            "dialogRequestId": "{{STRING}}"
        },
        "payload": {
            "volume": {{LONG}}
        }
    }
}

ヘッダーのパラメーター

パラメーター 説明
messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列
dialogRequestId 特定のRecognizeイベントの応答として送信されるディレクティブの関連付けに使用する一意のID 文字列

ペイロードのパラメーター

パラメーター 説明
volume 相対的な音量調整。現在の音量設定に対して、音量を上げる/下げるために使用する正または負のlong値です。
有効な値:-100以上100以下の任意の値。
long

VolumeChangedイベント

VolumeChangedイベントは、以下の場合にAVSに送信される必要があります。

  • SetVolumeディレクティブまたはAdjustVolumeディレクティブを受信し、製品のスピーカーの音量を調整/変更するよう処理したとき。
  • 音量が、製品のスピーカーの音量を調整/変更するよう、ローカルで調整されたとき。
    重要volume は、0(最小)以上、100(最大)以下の値で指定されます。製品がローカルで0~10の音量調整をサポートしている場合、ユーザーが音量を8に上げると、AVSはのvolume値が80に設定されると想定します。

サンプルメッセージ

{
    "event": {
        "header": {
            "namespace": "Speaker",
            "name": "VolumeChanged",
            "messageId": "{{STRING}}"
        },
        "payload": {
            "volume": {{LONG}},
            "muted": {{BOOLEAN}}
        }
    }
}

ヘッダーのパラメーター

パラメーター 説明
messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列

ペイロードのパラメーター

パラメーター 説明
volume 0(最小)から100(最大)までの絶対音量レベル。
有効な値:0以上100以下の任意のlong値。
long
mute 製品のスピーカーのミュート/ミュート解除に使用されるブール値。値は、スピーカーがミュートのときtrueで、ミュート解除のときfalseが指定されます。 ブール値

SetMuteディレクティブ

このディレクティブは、製品のスピーカーをミュートする際にAVSからクライアントに送信されます。

サンプルメッセージ

{
    "directive": {
        "header": {
            "namespace": "Speaker",
            "name": "SetMute",
            "messageId": "{{STRING}}",
            "dialogRequestId": "{{STRING}}"
        },
        "payload": {
            "mute": {{BOOLEAN}}
        }
    }
}

ヘッダーのパラメーター

パラメーター 説明
messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列
dialogRequestId 特定のRecognizeイベントの応答として送信されるディレクティブの関連付けに使用する一意のID 文字列

ペイロードのパラメーター

パラメーター 説明
mute 製品のスピーカーのミュート/ミュート解除に使用されるブール値。値は、スピーカーがミュートのときtrueで、ミュート解除のときfalseが指定されます。 ブール値

MuteChangedイベント

MuteChangedイベントは、以下の場合にAVSに送信される必要があります。

  • SetMuteディレクティブを受信し、製品のスピーカーの音量を調整/変更するよう処理したとき。
  • 製品が、スピーカーのミュート状態を変更するよう、ローカルでミュート/ミュート解除されたとき。

サンプルメッセージ

{
    "event": {
        "header": {
            "namespace": "Speaker",
            "name": "MuteChanged",
            "messageId": "{{STRING}}"
        },
        "payload": {
            "volume": {{LONG}},
            "muted": {{BOOLEAN}}
        }
    }
}

ヘッダーのパラメーター

パラメーター 説明
messageId 特定のメッセージを表すのに使用する一意のIDです。 文字列

ペイロードのパラメーター


有効な値: TRUEまたはFALSE</td>
パラメーター 説明
volume 0(最小)から100(最大)までの絶対音量レベル。
有効な値:0以上100以下の任意のlong値。
long
mute 製品のスピーカーのミュート/ミュート解除に使用されるブール値。値は、スピーカーがミュートのときtrueで、ミュート解除のときfalseが指定されます。ブール値

s