Class AvatarSession

Trugen avatar session

This class manages the connection between Livekit agent and Trugen avatar, Routing agent audio output to the avatar for visual representation.

Index

Constructors

Methods

Constructors

constructor

new AvatarSession(options?): AvatarSession
Creates a new AvatarSession.
Parameters
- options: AvatarSessionOptions = {}
  Configuration options for the avatar session
Returns AvatarSession
Throws
TrugenException if TRUGEN_API_KEY is not set
- Defined in avatar.ts:83

Methods

start

start(agentSession, room, options?): Promise<void>
Starts the avatar session and connects it to the agent.

This method:
1. Creates a Livekit token for the avatar participant
2. Calls the Trugen API to start the avatar session
3. Configures the agent's audio output to stream to the avatar
Parameters
- agentSession: AgentSession<unknown>
  The agent session to connect the avatar to
- room: Room
- options: StartOptions = {}
Returns Promise<void>
- Defined in avatar.ts:110