Class AvatarSession

A LemonSlice avatar session.

This class manages the connection between a LiveKit agent and a LemonSlice avatar, routing agent audio output to the avatar for visual representation.

Example

// Using an agent ID
const avatar = new AvatarSession({
  agentId: 'your-agent-id',
  apiKey: 'your-lemonslice-api-key',
});
await avatar.start(agentSession, room);

// Using a custom avatar image
const avatar = new AvatarSession({
  agentImageUrl: 'your-image-url',
  apiKey: 'your-lemonslice-api-key',
});
await avatar.start(agentSession, room);

Hierarchy (view full)

Constructors

constructor

Accessors

avatarIdentity provider sessionId

Methods

aclose joinMeeting leaveMeeting roomOptions start waitForJoin

Constructors

constructor

Accessors

avatarIdentity

provider

sessionId

Methods

aclose

joinMeeting

  • joinMeeting(meetingUrl, __namedParameters?): Promise<JoinMeetingResult>

  • Send this avatar into an external video meeting.

    Supports Zoom, Google Meet, Microsoft Teams, and Webex. Call after start() and before AgentSession.start().

    Parameters

    • meetingUrl: string
    • __namedParameters: {
          botName?: null | string;
          listenToMeetingChat?: boolean;
      } = {}
      • Optional botName?: null | string
      • Optional listenToMeetingChat?: boolean

    Returns Promise<JoinMeetingResult>

leaveMeeting

roomOptions

start

  • start(agentSession, room, options?): Promise<string>

  • Starts the avatar session and connects it to the agent.

    This method:

    1. Creates a LiveKit token for the avatar participant
    2. Calls the LemonSlice 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 to the avatar

    • room: Room

      The LiveKit room where the avatar will join

    • options: StartOptions = {}

      Optional LiveKit credentials (falls back to environment variables)

    Returns Promise<string>

    The session ID of the LemonSlice session

    Throws

    LemonSliceException if LiveKit credentials are not available or if the avatar session fails to start

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

constructoravatarIdentityprovidersessionIdaclosejoinMeetingleaveMeetingroomOptionsstartwaitForJoin