VoiceAgentWebSocketTransport interface

Un transporte WebSocket enchufable utilizado por VoiceAgentRealtimeClient. Implementa esta interfaz para personalizar cómo se establece la conexión en tiempo real, por ejemplo, para enrutarla a través de un relé autenticado.

Métodos

close(number, string)

Cierra la conexión.

connect(VoiceAgentWebSocketConnectOptions)

Establece la conexión WebSocket.

send(string, AbortSignalLike)

Envía un mensaje por la conexión.

setHandlers(VoiceAgentWebSocketHandlers)

Registra a los manejadores invocados a medida que ocurren eventos de conexión.

Detalles del método

close(number, string)

Cierra la conexión.

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

Parámetros

code

number

reason

string

Devoluciones

Promise<void>

connect(VoiceAgentWebSocketConnectOptions)

Establece la conexión WebSocket.

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

Parámetros

Devoluciones

Promise<void>

send(string, AbortSignalLike)

Envía un mensaje por la conexión.

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

Parámetros

data

string

abortSignal
AbortSignalLike

Devoluciones

Promise<void>

setHandlers(VoiceAgentWebSocketHandlers)

Registra a los manejadores invocados a medida que ocurren eventos de conexión.

function setHandlers(handlers: VoiceAgentWebSocketHandlers)

Parámetros