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)

Constructors

constructor

Accessors

avatarIdentity provider

Methods

aclose start waitForJoin

Constructors

constructor

Accessors

avatarIdentity

provider

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>

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

    Returns Promise<void>

waitForJoin

  • waitForJoin(timeout?): Promise<void>

  • Wait until the avatar participant has joined the room and published its video track.

    Parameters

    • Optional timeout: {
          timeout?: null | number;
      }

      Timeout in milliseconds. Pass null to wait indefinitely.

      • Optional timeout?: null | number

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructoravatarIdentityprovideraclosestartwaitForJoin