イベントハンドリング

クライアントアプリケーションをより細かく制御し、デジタルヒューマンの状態とウェブサイトを同期させたい場合があるかもしれません。そのために、デジタルヒューマン・アプリケーションからのメッセージ・イベントを提供し、あなたのウェブクライアントがそれを消費できるようにします。

これを行うには、ウィンドウイベントUneeqMessageをリッスンしてください。

例

ホステッドエクスペリエンスで詳細なログを出力する

以下のコードでより詳細なログを取得することができます。任意の場所に挿入してください。

# ホステッドエクスペリエンスで詳細なログを出力する

<script>
    window.addEventListener('UneeqMessage', (event) => {
        const msg = event.detail;
        console.log('UneeQ Message: ', msg);

    })
</script>

以下のコード例では、メッセージを受信し、セッションがアクティブになったときに body 要素のクラスリストを更新する方法を示しています。さらに、リスニングできる他のメッセージイベントもあります。

window.addEventListener( 'UneeqMessage', (event) => {
    const msg = event.detail;
    console.log('UneeQ Message: ', msg);

    switch( msg.uneeqMessageType ){

        case 'uneeqSessionStateUpdate':
            if( msg.live ) {
                document.body.classList.add('uneeq-session-live');
            } else {
                document.body.classList.remove('uneeq-session-live');
            }
            break;

        // Add additional event handlers here...

        default:
            break;

    }
});

メッセージリスト

Event Name	Description
ReadyToStart	アプリケーションがロードされ、設定が検証されました。セッションは、`uneeqStartSession()`を呼び出すことで開始することができます。
SessionStateUpdate	セッションの状態が更新されました (`Initial`, `WaitingToStart`, `AvatarUnavailable`, `MajorError`, `Live`, `Paused`, `Ended`)
LayoutModeUpdate	レイアウトモードが更新されました：`LayoutModeUpdate.layoutMode`
SessionId	デジタルヒューマンのセッションID
AvatarAvailable	少なくとも1人のデジタルヒューマンを起動することができます
AvatarUnavailable	利用可能なデジタルヒューマンがありません
AvatarQuestionText	デジタルヒューマンに質問された文字列
AvatarAnswer	デジタルヒューマンからの回答
AvatarAnswerContent	NLPシステムからレンダリングされるコンテンツが提供されました
CustomData	NLPシステムの'`instructions`'フィールドによって提供されたJSONデータ。このデータを使用して、フロントエンドアプリケーションにNLPシステムからカスタム指示を渡すことができます。例えば、ウェブサイトに表示したい商品の`customData`を設定することができます。
StartedSpeaking	デジタルヒューマンが話し始めました
FinishedSpeaking	デジタルヒューマンからの話が終わりました
DeviceEnabled	ユーザーから録音機器の使用が許可されました
RecordingStarted	音声認識のための録音が開始されました
RecordingStopped	音声認識のための録音が終了しました
DigitalHumanPlayedInMutedModeSuccess	ブラウザの自動再生ポリシーにより、デジタルヒューマンの音声を再生することができませんでした。デジタルヒューマンは、音声がミュートされた状態で起動しました。ユーザークリック・キーイベントの後に`uneeqUnmuteDigitalHuman()`を呼び出すと、デジタルヒューマンのミュートが解除される場合があります。
DigitalHumanUnmuted	デジタルヒューマンのミュートが解除されました
DigitalHumanVideoError	デジタルヒューマンのビデオでエラーが発生しました。詳細はメッセージの内容を参照してください。
DigitalHumanFailedToPlay	何らかの理由でデジタルヒューマンのビデオを再生できませんでした。最も可能性が高いのはブラウザの自動再生ポリシーによるブロックです（ユーザーがオーディオを再生しようとする前にページとの対話がない場合）。
ServiceUnavailable	何か問題が発生しました。詳細については含まれているメッセージを参照してください。
SpeechTranscription	ユーザーの音声の暫定的または最終的な音声書き起こしが受信されました。`Speech Recognition`モードのみ。
CustomMetadataUpdated	チャットメタデータが成功裏に更新されました。メッセージは新しく設定されたメタデータの値を提供します。
DevicePermissionAllowed	[非推奨・廃止予定]
AvatarTextInputFinished	[非推奨・廃止予定]
Instructions	[非推奨・廃止予定]

お役に立ちましたか？

😞

😐

🤩

最終更新日 June 17, 2023