Skip to main content

Overview

The @tixae-labs/web-sdk package enables voice call functionality via WebRTC. It allows you to initialize a voice call session with an agent (identified by agentId and region from your Convocore Dashboard and provides event listeners to track call status.

Installation

Install the package via pnpm or npm:
Or

Getting Started

Usage

Below is an example that demonstrates how to initialize the voice call and set up event listeners. (This example is suitable for NextJS 13+ with TypeScript.)

Voice Call Functions

.startCall() You can start a call by invoking the .startCall() function. .endCall() You can end a call by invoking the .endCall() function. .toggleMute() You can toggle the local microphone on or off during an active call.

Events

These events allow you to react to changes in the state of the call or user speech. call-start Occurs when the call has connected and begins.
call-ended Occurs when the call has disconnected & ended.
final_transcript Occurs when user finishes speaking.
conversation-update Occurs whenever the conversation’s state or message changes.
error Handle errors that occur during the call.

Resources

NPM

View the package on NPM.

GitHub

View the packageon GitHub