VoiceAgentWebSocketTransport interface

Pacchetto:

@azure/ai-projects

Un trasporto WebSocket collegabile utilizzato da VoiceAgentRealtimeClient. Implementa questa interfaccia per personalizzare come viene stabilita la connessione in tempo reale, ad esempio per instradarla attraverso un relè autenticato.

Metodi

close(number, string)	Chiude la connessione.
connect(VoiceAgentWebSocketConnectOptions)	Stabilisce la connessione WebSocket.
send(string, AbortSignalLike)	Invia un messaggio tramite la connessione.
setHandlers(VoiceAgentWebSocketHandlers)	Registra i gestori invocati man mano che si verificano eventi di connessione.

Dettagli metodo

close(number, string)

Chiude la connessione.

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

Parametri

code

number

reason

string

Valori restituiti

Promise<void>

connect(VoiceAgentWebSocketConnectOptions)

Stabilisce la connessione WebSocket.

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

Parametri

options

VoiceAgentWebSocketConnectOptions

Valori restituiti

Promise<void>

send(string, AbortSignalLike)

Invia un messaggio tramite la connessione.

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

Parametri

data

string

abortSignal

AbortSignalLike

Valori restituiti

Promise<void>

setHandlers(VoiceAgentWebSocketHandlers)

Registra i gestori invocati man mano che si verificano eventi di connessione.

function setHandlers(handlers: VoiceAgentWebSocketHandlers)

Parametri

handlers

VoiceAgentWebSocketHandlers