VoiceAgentWebSocketTransport interface

Pakket:

@azure/ai-projects

Een plug-able WebSocket-transport gebruikt door VoiceAgentRealtimeClient. Implementeer deze interface om aan te passen hoe de realtime verbinding tot stand komt, bijvoorbeeld om deze via een geauthenticeerd relais te routeren.

Methoden

close(number, string)	De verbinding wordt gesloten.
connect(VoiceAgentWebSocketConnectOptions)	Stelt de WebSocket-verbinding tot stand.
send(string, AbortSignalLike)	Stuurt een bericht via de verbinding.
setHandlers(VoiceAgentWebSocketHandlers)	Registreert de handlers die worden aangeroepen terwijl verbindingsgebeurtenissen plaatsvinden.

Methodedetails

close(number, string)

De verbinding wordt gesloten.

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

Parameters

code

number

reason

string

Retouren

Promise<void>

connect(VoiceAgentWebSocketConnectOptions)

Stelt de WebSocket-verbinding tot stand.

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

Parameters

options

VoiceAgentWebSocketConnectOptions

Retouren

Promise<void>

send(string, AbortSignalLike)

Stuurt een bericht via de verbinding.

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

Parameters

data

string

abortSignal

AbortSignalLike

Retouren

Promise<void>

setHandlers(VoiceAgentWebSocketHandlers)

Registreert de handlers die worden aangeroepen terwijl verbindingsgebeurtenissen plaatsvinden.

function setHandlers(handlers: VoiceAgentWebSocketHandlers)

Parameters

handlers

VoiceAgentWebSocketHandlers