Rate this page:

VoiceDSP

Agentic voice DSP is a composite connector working with underlying Silero.VAD and Pipecat.TurnDetector.

Constructors

constructor
Copy URL

Methods

addEventListener
Copy URL
addEventListener(event: 

VoiceDSPEvents

,
callback:

Function

):

void

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.

Parameters

Returns

  • type:

    void

close
Copy URL
close(): 

void

Closes the VoiceDSP WebSocket connection.

Returns

  • type:

    void

id
Copy URL
id(): 

string

Returns the VoiceDSP id.

Returns

  • type:

    string

removeEventListener
Copy URL
removeEventListener(event: 

VoiceDSPEvents

,
callback:

Function

):

void

Removes a handler for the specified event.

Parameters

  • Event class

  • callback:

    Function

    Optional

    Optional. Handler function. If not specified, all handler functions are removed

Returns

  • type:

    void

reset
Copy URL
reset(): 

void

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

Returns

  • type:

    void

signalAssistantTurnEnded
Copy URL
signalAssistantTurnEnded(): 

void

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).

Returns

  • type:

    void

signalAssistantTurnStarted
Copy URL
signalAssistantTurnStarted(): 

void

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).

Returns

  • type:

    void

stop
Copy URL
stop(): 

void

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

Returns

  • type:

    void

webSocketId
Copy URL
webSocketId(): 

string

Returns the VoiceDSP WebSocket id.

Returns

  • type:

    string

Rate this page: