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.

Hierarchy (view full)

voice.AvatarSession
- AvatarSession

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
Overrides AvatarSession.constructor
- Defined in plugins/trugen/src/avatar.ts:83

Methods

aclose

aclose(): Promise<void>
Release any resources owned by this avatar session. Default implementation is a no-op; subclasses can override to perform cleanup.

Returns Promise<void>
Inherited from AvatarSession.aclose
- Defined in agents/dist/voice/avatar/avatar_session.d.ts:27

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>
Overrides AvatarSession.start
- Defined in plugins/trugen/src/avatar.ts:111