SDK UneeqOptions

Uneeq() オブジェクトを構築する際には、UneeqOptions を渡す必要があります。これらのオプションは以下のように定義されています。

接続先サーバーのURL

タイプ：string

セッションに使用するセッションID

タイプ：string

アバタービデオを配置する div 要素を指定します。

タイプ：HTMLDivElement

ローカルビデオを配置する div 要素を指定します。

タイプ：string (オプション)

診断コールバックを有効にする。

タイプ：string (オプション)

デフォルト値：false

このオプションでは、セッション中にデジタルヒューマンの背後に表示される画像のURLを指定できます。

背景画像をURL使用するために、まず先に担当へ画像をお送りいただければ専用のURLを発行いたします。

タイプ：string (オプション)

テキストまたは音声の質問と共に送信されるカスタムメタデータを設定します。

タイプ：string (オプション)

このオプションでは、セッション中にデジタルヒューマンに表示される名札画像のURLを指定できます。背景画像を承認されたURLに追加してもらうためには、カスタマーサクセスチームに連絡する必要があります。

タイプ：string (オプション)

このオプションは、開発者コンソールでクライアント側のネットワークパフォーマンスメッセージの可視性を制御します。

これらのWebRTC統計（例：packetsLost、framesDropped、framesPerSec）は、セッション品質がクライアント側の条件によって影響を受けているかどうかを特定するのに役立ちます。

この可視性の設定に関係なく、UneeQのサーバーはこれらのメッセージを受信し、エンドユーザーのプラットフォームのパフォーマンスと安定性を測定するのに役立ちます。

タイプ：boolean (オプション)

デフォルト値：false

このオプションは、デジタルヒューマンを透明な背景でレンダリングし、あなたの体験の上にオーバーレイできるようにするかどうかを制御します。

trueの場合、デジタルヒューマンの設定された背景画像は透明な背景で置き換えられます。falseの場合、設定された背景画像が表示されます。

タイプ：boolean (オプション)

デフォルト値：false

音声認識入力モードを使用する場合、話し始めたときと話し終わったときに、あなたの声は自動的に検出されます。この挙動を無効にするためには、enableVadをfalseに設定できます。このオプションをfalseに設定すると、ユーザーのマイクが聞いているかどうかを管理する必要があります。

ユーザーのマイクの聞き取り状態を制御するためには、pauseSpeechRecognition() と resumeSpeechRecognition() を呼び出す必要があります。

ヒント：pause と resume の音声認識を呼び出す前に、ユーザーのマイクにアクセスするために enableMicrophone() を呼び出す必要があります。

タイプ：boolean (オプション)

デフォルト値：true

ロギングを有効にする。

タイプ：boolean (オプション)

デフォルト値：false

メッセージハンドラーコールバックに使用する関数を提供します。

タイプ：function (msg: ) (オプション)

デフォルト値：undefined

マイクのアクティビティメッセージを受信するかどうかを決定します。

タイプ：boolean (オプション)

デフォルト値：false

NLPウェルカムメッセージをトリガーするかどうか決定します。

タイプ：boolean (オプション)

デフォルト値：false

セッションを開始する優先カメラのデバイスID。

タイプ：string (オプション)

デフォルト値：undefined

タイプ：string (オプション)

デフォルト値：undefined

セッションを開始する優先話者のデバイスID。

タイプ：string (オプション)

デフォルト値：undefined

セッション開始時にユーザーのローカル音声ストリーム(マイク)を送信するかどうか決定します。

タイプ：boolean (オプション)

デフォルト値：true

セッション開始時に、ユーザーのローカルビデオストリーム（カメラ）を送信するかどうか決定します。

タイプ：boolean (オプション)

デフォルト値：true

音声認識システムに期待する単語についてヒントを与えるために使用されるべき、コンマ区切りのヒントフレーズの文字列です。ここにヒントフレーズを提供すると、それらが音声認識システムで検出されやすくなります。

タイプ：string (オプション)

デフォルト値 : "”

値の例: UneeQ, digital human, New Zealand

0から20の間の数値で、ヒントフレーズの単語が音声で検出される可能性を高めるために使用できます。

タイプ : number

デフォルト値 : 0

値の例: 15

のオプションでは、エンドユーザーが話すことができ、デジタルヒューマンが理解すべき言語について、最大4つのコロン区切りのロケールコード（言語タグ）を指定できます。

リストの最初のロケールがプライマリロケールとみなされます。例：en-US:ja-JP:de-DE

各ロケールは、言語と地域を示す4文字であるべきです。例：ja-JA、JPやJAではありません。

タイプ：string (オプション)

マイクを通じてユーザーの声をキャプチャするモードです。プッシュ・トゥ・トークモードの場合、声をキャプチャするためには startRecording と stopRecording メソッドを呼び出す必要があります。SPEECH_RECOGNITION モードの場合、startRecording や stopRecording を呼び出さずに、ユーザーの声が自動的にキャプチャされます。

タイプ：string

Values："PUSH_TO_TALK","SPEECH_RECOGNITION"

デフォルト値："PUSH_TO_TALK"