すべてのカテゴリ
開発・設置
メソッド

メソッド

インスタンスを作成したら、それと対話して動的に動作を制御できます。以下のメソッドは、インスタンス（例：uneeqInstance）で利用可能です。

オプションについて詳しく知りたい場合は、設定オプションをご覧ください。

const uneeqInstance = new Uneeq(options)
// Now you can call methods on uneeqInstance, e.g.
// uneeqInstance.cameraAnchor('center', 500)
 

Methods

init()

オプションを検証し、メッセージイベントハンドラを設定することで、インスタンスを初期化します。

uneeqInstance.init()
 

cameraAnchorHorizontal(position, duration)

カメラに指定されたアンカーポジションへの移動を要求します。

パラメータ

  • position (string): 希望するカメラのアンカーポジション。left right center
  • duration (number): カメラ移動の所要時間をミリ秒で指定します。
uneeqInstance.cameraAnchor('center', 500);
 

cameraAnchorDistance(position, duration)

カメラに指定されたアンカーポジションへの移動を要求します。

パラメータ

  • position (string): 希望するカメラのアンカーポジション。 close_up loose_close_up tight_medium_shot medium_shot medium_full_shot full_shot
  • duration (number): カメラ移動の所要時間をミリ秒で指定します。
      • uneeqInstance.cameraAnchor('close_up', 500);
 

chatPrompt(prompt)

デジタルヒューマンにチャットプロンプトを送信します。

パラメータ

  • prompt (string): チャットプロンプトメッセージ。
uneeqInstance.chatPrompt('Hello, how are you?');
 

speak(speech)

デジタルヒューマンを喋らせるためのリクエストを送信します。

パラメータ

  • speech (string): デジタルヒューマンが話す発話文。
uneeqInstance.speak('Welcome to our service.');
 

enableMicrophone()

ユーザーのマイクを有効にして音声録音を行います。

uneeqInstance.enableMicrophone();
 

endSession()

現在のセッションを終了します。

uneeqInstance.endSession();
 

pauseSpeechRecognition()

音声認識処理を一時停止します。これはユーザーのマイクをミュートすることに相当します。

uneeqInstance.pauseSpeechRecognition();
 

resumeSpeechRecognition()

音声認識処理を再開します。これはユーザーのマイクをミュート解除することに相当します。

uneeqInstance.resumeSpeechRecognition();
 

setCustomPromptMetadata(customMetadata)

チャットプロンプトのカスタムメタデータを設定します。

パラメータ

  • customMetadata (Object): チャット用のカスタムメタデータ。
uneeqInstance.setCustomPromptMetadata({"key":"value"});
uneeqInstance.setCustomPromptMetadata({"name": "john"})
 

setLayoutMode(layoutMode)

インターフェースのレイアウトモードを設定します。

パラメータ

  • layoutMode (string): overlay fullScreen contained
uneeqInstance.setLayoutMode('fullScreen');
 

stopSpeaking()

デジタルヒューマンに発話を停止するよう指示します。

uneeqInstance.stopSpeaking();
 

unmuteDigitalHuman()

ブラウザの自動再生ポリシーによってミュートされている場合、デジタルヒューマンのミュートを解除します。

uneeqInstance.unmuteDigitalHuman();
 

muteDigitalHuman()

デジタルヒューマンをミュートします。音声を再び受け取るには、unmuteDigitalHuman()を呼び出す必要があります。このミュート状態の画面上のインジケーターはありません。

uneeqInstance.muteDigitalHuman();
 

updateDisplayContent(htmlContent)

コンテンツウィンドウに表示するHTMLコンテンツを設定します。

パラメータ

  • htmlContent (string): 表示するHTMLコンテンツ。
uneeqInstance.updateDisplayContent('<p>New Content</p>');
 

setShowClosedCaptions(show)

クローズドキャプションを表示するかどうかを設定します。

パラメータ

  • show (boolean): クローズドキャプションを表示する場合はtrue、そうでない場合はfalse。
uneeqInstance.setShowClosedCaptions(true);
 

setShowUserInputInterface(show)

ユーザー入力インターフェース（テキスト/音声入力UI）を表示するかどうかを設定します。

パラメータ

  • show (boolean): ユーザー入力インターフェースを表示する場合はtrue、表示しない場合はfalse。
uneeqInstance.setShowUserInputInterface(true);
 

startSession()

デジタルヒューマンとのセッションを開始します。

uneeqInstance.startSession();
お役に立ちましたか？
😞
😐
🤩

最終更新日 February 18, 2025

イベント スピーチイベント