VoiceDSP

Methods

addEventListener

Adds a handler for Agentic.VoiceDSPEvents. Use only functions as handlers; anything except a function leads to the error and scenario termination when a handler is called.

1
addEventListener(event: Agentic.VoiceDSPEvents | T, callback: (event: Agentic._VoiceDSPEvents[T]) => any): void

Parameters

close

Closes the VoiceDSP WebSocket connection.

1
close(): void

id

Returns the VoiceDSP id.

1
id(): string

removeEventListener

Removes a handler for the specified event.

1
removeEventListener(event: Agentic.VoiceDSPEvents | T, callback?: (event: Agentic._VoiceDSPEvents[T]) => any): void

Parameters

reset

Reset the VoiceDSP context (sends a Reset message to the connector).

1
reset(): void

signalAssistantTurnEnded

Signals that the assistant has finished speaking. Clears the assistant-speaking state used for Agentic.VoiceDSPEvents.TurnStarted interrupted and starts the Agentic.VoiceDSPParameters.userTurnIdleTimeout idle timer when no user turn is in progress (mirrors Pipecat BotStoppedSpeakingFrame).

1
signalAssistantTurnEnded(): void

signalAssistantTurnStarted

Signals that the assistant has started speaking. Marks the assistant as speaking for Agentic.VoiceDSPEvents.TurnStarted interrupted and cancels the Agentic.VoiceDSPParameters.userTurnIdleTimeout idle timer (mirrors Pipecat BotStartedSpeakingFrame).

1
signalAssistantTurnStarted(): void

stop

Stops the VoiceDSP (sends Stop to the connector, then closes the WebSocket).

1
stop(): void

webSocketId

Returns the VoiceDSP WebSocket id.

1
webSocketId(): string