あなたのAlexaコンソール
?
サポート

Context



概要

コンテキストは、AVSにクライアントコンポーネントの状態を伝えるのに使用されるコンテナです。コンテキストは、イベントが発生する直前のクライアントコンポーネントの状態を反映する必要があります。たとえば、クライアントがオーディオストリームを再生中に、ユーザーが音声リクエストのためにそのストリームを中断したとすると、コンテキストは、RecognizeイベントがAVSに送信されるときに、AudioPlayerのplayerActivityが再生中だったことを示す必要があります。

以下の例は、すべてのコンテキストを含むSpeechRecognizer.Recognizeイベントを示しています。

クリックして拡大 +

SpeechRecognizer.RecognizerState

サンプルメッセージ


{
    "header": {
        "namespace": "SpeechRecognizer",
        "name": "RecognizerState"
    },
    "payload": {
        "wakeword": "ALEXA"
    }
}

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

パラメーター 説明
wakeword 現在のウェイクワードを示します。
有効な値: "ALEXA"
string

AudioPlayer.PlaybackState

サンプルメッセージ

{
    "header": {
        "namespace": "AudioPlayer",
        "name": "PlaybackState"
    },
    "payload": {
        "token": "{{STRING}}",
        "offsetInMilliseconds": {{LONG}},
        "playerActivity": "{{STRING}}"
    }
}

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

パラメーター 説明
token Playディレクティブで提供される参照トークン。 string
offsetInMilliseconds トラックの現在のオフセットをミリ秒で示します。 long
playerActivity AudioPlayerのコンポーネントの状態を示します。
有効な値: IDLE、PLAYING、STOPPED、PAUSED、BUFFER_UNDERRUN、FINISHED
string
プレーヤーのアクティビティ 説明
IDLE 再生中または待機中のオーディオなし。
PLAYING ストリーミング再生中。
PAUSED ストリーミングを一時停止中。
BUFFER_UNDERRUN バッファアンダーランが発生。
FINISHED ストリーミングの再生を終了。
STOPPED ストリーミングを中断。

Alerts.AlertsState

サンプルメッセージ

{
    "header": {
        "namespace": "Alerts",
        "name": "AlertsState"
    },
    "payload": {
        "allAlerts": [
                          {
                "token": "{{STRING}}",
                "type": "{{STRING}}",
                "scheduledTime": "{{STRING}}"
            }
        ],
        "activeAlerts": [
                          {
                "token": "{{STRING}}",
                "type": "{{STRING}}",
                "scheduledTime": "{{STRING}}"
            }
        ]
    }
}

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

パラメーター 説明
allAlerts allAlertsのキー/値ペア。 object
allAlerts. token アラートがセットされたときにAlexa Voice Serviceによって返されるアラートトークン。 string
allAlerts. type アラートの種類を示します。
有効な値: TIMERまたはALARM
string
allAlerts. scheduledTime ISO 8601形式のアラートの設定時刻。 string
activeAlerts activeAlertsのキー/値ペア。 object
activeAlerts. token 現在発生中のアラートのトークン。 string
activeAlerts. type アラートの種類を示します。
有効な値: TIMERまたはALARM
string
activeAlerts. scheduledTime ISO 8601形式のアラートの設定時刻。 string

Speaker.VolumeState

サンプルメッセージ

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

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

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

SpeechSynthesizer.SpeechState

サンプルメッセージ

{
    "header": {
        "namespace": "SpeechSynthesizer",
        "name": "SpeechState"
    },
    "payload": {
        "token": "{{STRING}}",
        "offsetInMilliseconds": {{LONG}},
        "playerActivity": "{{STRING}}"
    }
}

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

パラメーター 説明
token Speakディレクティブで提供される参照トークン。 string
offsetInMilliseconds TTSの現在のオフセットをミリ秒で示します。 long
playerActivity SpeechSynthesizerのコンポーネントの状態を示します。
有効な値: PLAYINGまたはFINISHED
string
プレーヤーのアクティビティ 説明
PLAYING 音声が再生中でした。
FINISHED 音声の再生が終了していました。

Notifications.IndicatorState

サンプルメッセージ

{
    "header": {
        "namespace": "Notifications",
        "name": "IndicatorState"
    },
    "payload": {
        "isEnabled": {{BOOLEAN}},
        "isVisualIndicatorPersisted": {{BOOLEAN}}
    }
}

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

パラメーター 説明
isEnabled ユーザーに伝えていない新規または保留中の通知があることを示します。

: 消去されていないインジケーターはすべて有効と見なされます。
ブール値
isVisualIndicatorPersisted 最後に受信したSetIndicatorディレクティブのpersistVisualIndicatorの値に対応します。最後に受信したディレクティブのpersistVisualIndicatortrueだった場合、isVisualIndicatorPersistedtrueである必要があります。 ブール値

その他のインターフェース

このドキュメントの最初に戻り、右側のサイドバーから、その他のインターフェースを参照してください。

リソース