VoiceAgentWebSocketTransport interface

VoiceAgentRealtimeClientで使用されるプラグイン可能なWebSocketトランスポートです。 このインターフェースを実装して、リアルタイム接続の確立方法をカスタマイズし、例えば認証済みリレー経由でルーティングするなど。

メソッド

close(number, string)

接続を閉じます。

connect(VoiceAgentWebSocketConnectOptions)

WebSocket接続を確立します。

send(string, AbortSignalLike)

接続を通じてメッセージを送信します。

setHandlers(VoiceAgentWebSocketHandlers)

接続イベントが発生する際に呼び出されるハンドラをレジスタします。

メソッドの詳細

close(number, string)

接続を閉じます。

function close(code: number, reason: string): Promise<void>

パラメーター

code

number

reason

string

返品

Promise<void>

connect(VoiceAgentWebSocketConnectOptions)

WebSocket接続を確立します。

function connect(options: VoiceAgentWebSocketConnectOptions): Promise<void>

パラメーター

返品

Promise<void>

send(string, AbortSignalLike)

接続を通じてメッセージを送信します。

function send(data: string, abortSignal?: AbortSignalLike): Promise<void>

パラメーター

data

string

abortSignal
AbortSignalLike

返品

Promise<void>

setHandlers(VoiceAgentWebSocketHandlers)

接続イベントが発生する際に呼び出されるハンドラをレジスタします。

function setHandlers(handlers: VoiceAgentWebSocketHandlers)

パラメーター