你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。

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)

参数