SDK Methods

new Uneeq(options: UneeqOptions)

新しい Uneeq オブジェクトを構築します。

コンストラクタのパラメータ詳細については UneeqOptions を参照してください。

パラメーター：options: UneeqOptions

戻り値：Uneeq

sessionId

アクティブなセッション ID を文字列で指定します。セッションがまだ開始されていない場合、値はnullとなります。これはメソッドではなく、アクセサ(accessor)であることに注意してください。Uneeq.sessionId のように Uneeqのプロパティとしてアクセスすることで値を取得することができます。

パラメーター：パラメーターなし

戻り値：string | null

enableMicrophone(enable?: , foo?: )

ユーザーのマイクを有効化または無効化する。

パラメーター : enable:boolean(optional)

デフォルトはtrue

foo:string(optional)

デフォルトはfalse

戻り値：void

endSession()

セッションを終了し、マイクとカメラを解放し、アバター処理を終了します。成功すると、SessionEndedMessage が送信されます。エラーの場合は、ErrorEndingSessionMessageが送信されます。

パラメーター：パラメーターなし

戻り値：void

initWithToken(tokenId: string)

セッションを初期化する。サードパーティの会話サービスを使用する場合は、init()の代わりに initWithTokenを使用する必要があります。

パラメーター : tokenId:string

戻り値：Promise<void>

Note: ブラウザの自動再生制限を避けるために、initWithTokenはマウスまたはキーボードのイベントチェーンの一部として呼び出す必要があります。ユーザーがページと対話する前にinitWithTokenを呼び出すと、デジタルヒューマンのオーディオがミュートされた状態でセッションが開始される可能性があります。このような状況が発生した場合、DigitalHumanPlayedInMutedModeSuccessというメッセージを受け取ります。ユーザーがページと対話した後で、デジタルヒューマンのミュートを解除するためにはunmuteDigitalHumanを呼び出す必要があります。または、ユーザーがデジタルヒューマンのビデオをクリックしてオーディオのミュートを解除することもできます。

unmuteDigitalHuman()

このメソッドを使用して、ミュートモードで開始された デジタルヒューマンのミュートを解除します。ブラウザの自動再生ポリシーにより、デジタルヒューマンがミュートモードで開始された場合、DigtalHumanPlayedInMutedModeSuccessというメッセージが表示されます。

パラメーター：パラメーターなし

戻り値：void

pauseSpeechRecognition()

SPEECH_RECOGNITION voiceInputModeを使用しているときに音声認識を一時停止します。ユーザーのマイクはミュートされ、オーディオデータは処理されません。

パラメーター：パラメーターなし

戻り値：boolean

pauseSession()

ライブセッションを一時停止します。ローカルビデオとオーディオの送信を停止し、リモートアバターのビデオオーディオを停止します。成功すると、SessionPausedMessage が送信されます。

パラメーター：パラメーターなし

戻り値：boolean

playWelcomeMessage()

この会話のウェルカムメッセージをトリガーします。

パラメーター：パラメーターなし

戻り値：Promise

resumeSpeechRecognition()

SPEECH_RECOGNITION voiceInputModeを使用しているときに音声認識を再開します。ユーザーのマイクのミュートが解除され、オーディオデータの処理が再開されます。

パラメーター：パラメーターなし

戻り値：boolean

resumeSession()

ライブセッションを再開します。ローカルビデオとオーディオの送信が再開され、リモートアバターのビデオオーディオが再開されます。成功すると、SessionResumedMessage が送信されます。

パラメーター：パラメーターなし

戻り値：boolean

sendTranscript(text: string)

デジタルヒューマンにテキストベースのメッセージを送信します。

パラメーター : text:string

戻り値：void

setAvatarDebug(enabled: boolean)

アバターデバッグを表示する。

パラメーター：enabled:boolean

戻り値：Promise<any>

setCamera(deviceId: string)

ライブセッションで使用する優先カメラを設定します。成功した場合は、SetCameraSuccessMessage が送信されます。

要求されたデバイスが見つからない場合は、DeviceNotFoundErrorMessageが送信されます。

パラメーター：deviceId:string

戻り値：void

setMic(deviceId: string)

ライブセッションで使用する優先マイクを設定します。成功すると、SetMicSuccessMessage が送信されます。要求されたデバイスが見つからない場合は、DeviceNotFoundErrorMessageが送信されます。

パラメーター：deviceId:string

戻り値：void

setSpeaker(deviceId: string)

ライブセッションで使用する優先スピーカーを設定します。成功すると、SetSpeakerSuccessMessage が送信される。要求されたデバイスが見つからない場合は、DeviceNotFoundErrorMessageが送信されます。

パラメーター：deviceId:string

戻り値：void

startRecording()

マイクを使った音声の録音を開始します。アバターに話しかける前にこのメソッドを呼び出します。

パラメーター：パラメーターなし

戻り値：void

stopRecording()

停止 マイクからの音声の録音を停止します。startRecordingが呼ばれた後に、このメソッドを呼び出します。

パラメーター：パラメーターなし

戻り値：void

stopSpeaking()

アバターの発言を停止します。これは、割り込みがオフになっている場合でも、アバターの発言を停止します。成功すると、対応する AvatarRequestCompleted を受信するはずです。

パラメーター：パラメーターなし

戻り値：Promise

uneeqSetCustomChatMetadata(string)

テキストまたは音声の質問と共に送信されるメタデータ（文字列化されたJSON）を設定します。チャットメタデータを設定すると、新しい値で上書きされるまで、将来のすべての質問に対してそれが維持されます。

例：すべての質問においてユーザーの名前をメタデータとしてNLPシステムに送信したい場合、チャットメタデータを次のように設定できます。 uneeqSetCustomChatMetadata( JSON.stringify({name: 'John'}) )

例：メタデータをクリアするには、uneeqSetCustomChatMetadata('')を呼び出します。このメソッドが呼び出された後、テキストまたは音声の質問はメタデータ{name: 'John'}を渡さなくなります。

パラメーター：deviceId:string

戻り値：void