VoiceAgentWebSocketTransport interface

Paket:

@azure/ai-projects

Ein ansteckbarer WebSocket-Transport, der von VoiceAgentRealtimeClient verwendet wird. Implementiere diese Schnittstelle, um die Echtzeitverbindung anzupassen, zum Beispiel um sie über ein authentifiziertes Relais zu routen.

Methoden

close(number, string)	Schließen der Verbindung.
connect(VoiceAgentWebSocketConnectOptions)	Stellt die WebSocket-Verbindung her.
send(string, AbortSignalLike)	Sendet eine Nachricht über die Verbindung.
setHandlers(VoiceAgentWebSocketHandlers)	Registriert die aufgerufenen Handler, wenn Verbindungsereignisse auftreten.

Details zur Methode

close(number, string)

Schließen der Verbindung.

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

Parameter

code

number

reason

string

Gibt zurück

Promise<void>

connect(VoiceAgentWebSocketConnectOptions)

Stellt die WebSocket-Verbindung her.

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

Parameter

options

VoiceAgentWebSocketConnectOptions

Gibt zurück

Promise<void>

send(string, AbortSignalLike)

Sendet eine Nachricht über die Verbindung.

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

Parameter

data

string

abortSignal

AbortSignalLike

Gibt zurück

Promise<void>

setHandlers(VoiceAgentWebSocketHandlers)

Registriert die aufgerufenen Handler, wenn Verbindungsereignisse auftreten.

function setHandlers(handlers: VoiceAgentWebSocketHandlers)

Parameter

handlers

VoiceAgentWebSocketHandlers